HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MaterialAssignment.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2009-2015,
4 // Sony Pictures Imageworks Inc. and
5 // Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
6 //
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are
11 // met:
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above
15 // copyright notice, this list of conditions and the following disclaimer
16 // in the documentation and/or other materials provided with the
17 // distribution.
18 // * Neither the name of Sony Pictures Imageworks, nor
19 // Industrial Light & Magic, nor the names of their contributors may be used
20 // to endorse or promote products derived from this software without specific
21 // prior written permission.
22 //
23 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 //
35 //-*****************************************************************************
36 
37 
38 #ifndef Alembic_AbcMaterial_MaterialAssignment_h
39 #define Alembic_AbcMaterial_MaterialAssignment_h
40 
41 #include <Alembic/Util/Export.h>
44 
45 namespace Alembic {
46 namespace AbcMaterial {
47 namespace ALEMBIC_VERSION_NS {
48 
49 #define MATERIALASSIGN_PROPNAME ".material.assign"
50 #define MATERIAL_PROPNAME ".material"
51 
52 //! Adds a material assignment to an object. The value should be
53 //! the absolute path to an Material object.
54 //! (The default interpretation is that this path is to an object within
55 //! the same archive.)
56 //!
57 //! The default value for "propName" is officially supported convention
58 //! of the library. You may provide an alternative value for custom
59 //! solutions that want to make use of this convenience.
61  Abc::OObject iObject,
62  const std::string & iValue,
63  const std::string & iPropName = MATERIALASSIGN_PROPNAME );
64 
65 //! Adds a material assignment within a compound property. The conventions
66 //! and concerns are identical as with applying to an object. This exists
67 //! primarily for custom solutions which want to make use of the convenience
68 //! within nested compounds.
71  const std::string & iValue,
72  const std::string & iPropName = MATERIALASSIGN_PROPNAME );
73 
74 //! Adds a local material schema to any object. This is intended for
75 //! "has-a" cases such as "this polymesh has a material locally defined."
76 //!
77 //! The default value for "propName" is officially supported convention
78 //! of the library. You may provide an alternative value for custom
79 //! solutions that want to make use of this convenience.
80 ALEMBIC_EXPORT OMaterialSchema addMaterial(
81  Abc::OObject iObject,
82  const std::string & iPropName = MATERIAL_PROPNAME );
83 
84 //! Adds a local material schema within any compound. This is intended
85 //! for the "has-a" cases for nested compound properties.
86 ALEMBIC_EXPORT OMaterialSchema addMaterial(
88  const std::string & iPropName = MATERIAL_PROPNAME );
89 
90 
91 //! Returns true and fills result with the value of previously defined
92 //! material assignment path. The default interpretation of the value
93 //! is as a full path to an IMaterial object within the same archive.
94 //!
95 //! The default value for "propName" is officially supported convention
96 //! of the library. You may provide an alternative value for custom
97 //! solutions that want to make use of this convenience.
99  Abc::IObject iObject,
100  std::string & oResult,
101  const std::string & iPropName = MATERIALASSIGN_PROPNAME );
102 
103 //! Returns true and fills result with the value of previously defined
104 //! material assignment path within a given compound property.
105 //!
106 //! The common case is at the object level but this is here as a convenince
107 //! for custom solutions
110  std::string & oResult,
111  const std::string & iPropName = MATERIALASSIGN_PROPNAME );
112 
113 //! Returns true and fills result a previously defined local material
114 //! on this object following the "has a" pattern.
115 //!
116 //! The default value for "propName" is officially supported convention
117 //! of the library. You may provide an alternative value for custom
118 //! solutions that want to make use of this convenience.
120  Abc::IObject iObject,
121  IMaterialSchema & oResult,
122  const std::string & iPropName = MATERIAL_PROPNAME );
123 
124 //! Returns true and fills result a previously defined local material
125 //! within the given compound property. This is useful for solutions
126 //! in which another schema wants to contain a material definition
127 //! but not advertise it as such at the object level
129  Abc::ICompoundProperty iCompound,
130  IMaterialSchema & oResult,
131  const std::string & iPropName = MATERIAL_PROPNAME );
132 
133 
134 } // End namespace ALEMBIC_VERSION_NS
135 
136 using namespace ALEMBIC_VERSION_NS;
137 
138 } // End namespace AbcMaterial
139 } // End namespace Alembic
140 
141 #endif
#define MATERIAL_PROPNAME
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
ALEMBIC_EXPORT void addMaterialAssignment(Abc::OObject iObject, const std::string &iValue, const std::string &iPropName=MATERIALASSIGN_PROPNAME)
ALEMBIC_EXPORT OMaterialSchema addMaterial(Abc::OObject iObject, const std::string &iPropName=MATERIAL_PROPNAME)
ALEMBIC_EXPORT bool hasMaterial(Abc::IObject iObject, IMaterialSchema &oResult, const std::string &iPropName=MATERIAL_PROPNAME)
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define MATERIALASSIGN_PROPNAME
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
ALEMBIC_EXPORT bool getMaterialAssignmentPath(Abc::IObject iObject, std::string &oResult, const std::string &iPropName=MATERIALASSIGN_PROPNAME)