Cortex  10.0.0-a4
Primitive.h
1 //
3 // Copyright (c) 2007-2013, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IE_CORE_PRIMITIVE_H
36 #define IE_CORE_PRIMITIVE_H
37 
38 #include "IECore/Export.h"
39 #include "IECore/VisibleRenderable.h"
40 #include "IECore/PrimitiveVariable.h"
41 
42 namespace IECore
43 {
44 
54 class IECORE_API Primitive : public VisibleRenderable
55 {
56  public:
57 
58  Primitive();
59  ~Primitive() override;
60 
61  IE_CORE_DECLAREABSTRACTOBJECT( Primitive, VisibleRenderable );
62 
65 
73  template<typename T>
74  T *variableData( const std::string &name, PrimitiveVariable::Interpolation requiredInterpolation=PrimitiveVariable::Invalid );
75  template<typename T>
76  const T *variableData( const std::string &name, PrimitiveVariable::Interpolation requiredInterpolation=PrimitiveVariable::Invalid ) const;
84  template<typename T>
85  typename T::Ptr expandedVariableData( const std::string &name, PrimitiveVariable::Interpolation requiredInterpolation=PrimitiveVariable::Invalid ) const;
86 
88  bool isPrimitiveVariableValid( const PrimitiveVariable &pv ) const;
89 
91  bool arePrimitiveVariablesValid() const;
92 
105  PrimitiveVariable::Interpolation inferInterpolation( size_t numElements ) const;
108  PrimitiveVariable::Interpolation inferInterpolation( const Data *data ) const;
109 
112  Imath::Box3f bound() const override;
113 
116  virtual size_t variableSize( PrimitiveVariable::Interpolation interpolation ) const = 0;
117 
119  virtual void topologyHash( MurmurHash &h ) const = 0;
120 
126  static PrimitiveVariableMap loadPrimitiveVariables( const IndexedIO *ioInterface, const IndexedIO::EntryID &name, const IndexedIO::EntryIDList &primVarNames );
127 
128  private:
129 
130  static const unsigned int m_ioVersion;
131 
132 };
133 
134 IE_CORE_DECLAREPTR( Primitive );
135 
136 } // namespace IECore
137 
138 #include "IECore/Primitive.inl"
139 
140 #endif // IE_CORE_PRIMITIVE_H
Definition: Data.h:46
Definition: PrimitiveVariable.h:47
Definition: VisibleRenderable.h:51
Definition: IndexedIO.h:57
Definition: MurmurHash.h:64
Interpolation
Definition: PrimitiveVariable.h:53
Definition: Primitive.h:54
Definition: InternedString.h:55
PrimitiveVariableMap variables
Variables a stored as a public map for easy manipulation.
Definition: Primitive.h:64
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43
std::map< std::string, PrimitiveVariable > PrimitiveVariableMap
A simple type to hold named PrimitiveVariables.
Definition: PrimitiveVariable.h:107