Alembic Version 1.1

Loading...
Searching...
No Matches
IMaterial.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#ifndef Alembic_AbcMaterial_IMaterial_h
38#define Alembic_AbcMaterial_IMaterial_h
39
40#include <Alembic/Abc/All.h>
41#include <Alembic/Util/Export.h>
42#include <Alembic/AbcMaterial/SchemaInfoDeclarations.h>
43
44 namespace Alembic {
45 namespace AbcMaterial {
46 namespace ALEMBIC_VERSION_NS {
47
52 class ALEMBIC_EXPORT IMaterialSchema
53 : public Abc::ISchema<MaterialSchemaInfo>
54{
55 public:
56
57 //-------------------------------------------------------------------------
58 //BOILERPLATE
59
60 typedef IMaterialSchema this_type;
61
62 IMaterialSchema() {}
63
70 IMaterialSchema( const ICompoundProperty &iParent,
71 const std::string &iName,
72 const Abc::Argument &iArg0 = Abc::Argument(),
73 const Abc::Argument &iArg1 = Abc::Argument() )
74
75 : Abc::ISchema<MaterialSchemaInfo>( iParent, iName, iArg0, iArg1 )
76 {
77 init();
78 }
79
84 IMaterialSchema( const ICompoundProperty &iProp,
85 const Abc::Argument &iArg0 = Abc::Argument(),
86 const Abc::Argument &iArg1 = Abc::Argument() )
87 : Abc::ISchema<MaterialSchemaInfo>( iProp, iArg0, iArg1 )
88 {
89 init();
90 }
91
93 IMaterialSchema( const IMaterialSchema& iCopy )
94 : Abc::ISchema<MaterialSchemaInfo>()
95 {
96 *this = iCopy;
97 }
98
99 //-------------------------------------------------------------------------
100 //ACTUAL STUFF
101
107 void getTargetNames( std::vector<std::string> & iTargetNames );
108
113 void getShaderTypesForTarget( const std::string & iTargetName,
114 std::vector<std::string> & oShaderTypeNames );
115
118 bool getShader( const std::string & iTarget,
119 const std::string & iShaderType,
120 std::string & oResult );
121
125 Abc::ICompoundProperty getShaderParameters(
126 const std::string & iTarget, const std::string & iShaderType );
127
128 //-------------------------------------------------------------------------
129
130 class ALEMBIC_EXPORT NetworkNode
131 {
132 public:
133
134 NetworkNode();
135 NetworkNode( Abc::ICompoundProperty iCompound );
136 NetworkNode( Abc::ICompoundProperty iParent,
137 const std::string & iNodeName );
138
139 bool valid();
140
141 std::string getName();
142
143 bool getTarget( std::string & oResult );
144 bool getNodeType( std::string & oResult );
145
146 Abc::ICompoundProperty getParameters();
147
148 size_t getNumConnections();
149 bool getConnection( size_t iIndex,
150 std::string & oInputName,
151 std::string & oConnectedNodeName,
152 std::string & oConnectedOutputName );
153
154 bool getConnection( const std::string & iInputName,
155 std::string & oConnectedNodeName,
156 std::string & oConnectedOutputName );
157
158 private:
159 Abc::ICompoundProperty m_compound;
160
161 bool m_connectionsChecked;
162 std::vector< std::string > m_connections;
163 std::map< std::string, std::string > m_connectionsMap;
164
165 void splitConnectionValue( const std::string & v,
166 std::string & a,
167 std::string & b );
168 };
169
170 size_t getNumNetworkNodes();
171 void getNetworkNodeNames( std::vector<std::string> & oNames );
172
173 NetworkNode getNetworkNode( size_t iIndex );
174 NetworkNode getNetworkNode( const std::string & iNodeName );
175
176 void getNetworkTerminalTargetNames(
177 std::vector<std::string> & oTargetNames );
178
179 void getNetworkTerminalShaderTypesForTarget(
180 const std::string & iTargetName,
181 std::vector<std::string> & oShaderTypeNames );
182
183 bool getNetworkTerminal( const std::string & iTarget,
184 const std::string & iShaderType,
185 std::string & oNodeName,
186 std::string & oOutputName );
187
188 size_t getNumNetworkInterfaceParameterMappings();
189 bool getNetworkInterfaceParameterMapping( size_t iIndex,
190 std::string & oInterfaceParamName,
191 std::string & oMapToNodeName,
192 std::string & oMapToParamName );
193
194 void getNetworkInterfaceParameterMappingNames(
195 std::vector<std::string> & oNames );
196
197 bool getNetworkInterfaceParameterMapping(
198 const std::string & iInterfaceParamName,
199 std::string & oMapToNodeName,
200 std::string & oMapToParamName );
201
202 Abc::ICompoundProperty getNetworkInterfaceParameters();
203
204 protected:
205
206 private:
207
208 void init();
209
210 std::map<std::string, std::string> m_shaderNames;
211 std::map<std::string, std::string> m_terminals;
212 std::map<std::string, std::string> m_interfaceMap;
213 std::vector<std::string> m_interface;
214
215 Abc::ICompoundProperty m_interfaceParams;
216 Abc::ICompoundProperty m_node;
217};
218
220 typedef Abc::ISchemaObject<IMaterialSchema> IMaterial;
221
222 typedef Util::shared_ptr< IMaterial > IMaterialPtr;
223
224} // End namespace ALEMBIC_VERSION_NS
225
226 using namespace ALEMBIC_VERSION_NS;
227
228} // End namespace AbcMaterial
229} // End namespace Alembic
230
231#endif
SchemaInfoDeclarations.h
All.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition Export.h:51
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode
Definition IMaterial.h:131
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::valid
bool valid()
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::getConnection
bool getConnection(const std::string &iInputName, std::string &oConnectedNodeName, std::string &oConnectedOutputName)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::getConnection
bool getConnection(size_t iIndex, std::string &oInputName, std::string &oConnectedNodeName, std::string &oConnectedOutputName)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::NetworkNode
NetworkNode(Abc::ICompoundProperty iCompound)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::getTarget
bool getTarget(std::string &oResult)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::getNumConnections
size_t getNumConnections()
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::getParameters
Abc::ICompoundProperty getParameters()
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::getNodeType
bool getNodeType(std::string &oResult)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::getName
std::string getName()
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::NetworkNode
NetworkNode(Abc::ICompoundProperty iParent, const std::string &iNodeName)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::NetworkNode::NetworkNode
NetworkNode()
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNetworkNodeNames
void getNetworkNodeNames(std::vector< std::string > &oNames)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getShaderTypesForTarget
void getShaderTypesForTarget(const std::string &iTargetName, std::vector< std::string > &oShaderTypeNames)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNetworkTerminalTargetNames
void getNetworkTerminalTargetNames(std::vector< std::string > &oTargetNames)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::IMaterialSchema
IMaterialSchema(const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition IMaterial.h:84
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNetworkInterfaceParameterMappingNames
void getNetworkInterfaceParameterMappingNames(std::vector< std::string > &oNames)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNetworkTerminalShaderTypesForTarget
void getNetworkTerminalShaderTypesForTarget(const std::string &iTargetName, std::vector< std::string > &oShaderTypeNames)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNetworkNode
NetworkNode getNetworkNode(size_t iIndex)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNetworkNode
NetworkNode getNetworkNode(const std::string &iNodeName)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNumNetworkInterfaceParameterMappings
size_t getNumNetworkInterfaceParameterMappings()
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::this_type
IMaterialSchema this_type
Definition IMaterial.h:60
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNetworkInterfaceParameterMapping
bool getNetworkInterfaceParameterMapping(const std::string &iInterfaceParamName, std::string &oMapToNodeName, std::string &oMapToParamName)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::IMaterialSchema
IMaterialSchema(const IMaterialSchema &iCopy)
Copy constructor.
Definition IMaterial.h:93
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNetworkInterfaceParameters
Abc::ICompoundProperty getNetworkInterfaceParameters()
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNetworkInterfaceParameterMapping
bool getNetworkInterfaceParameterMapping(size_t iIndex, std::string &oInterfaceParamName, std::string &oMapToNodeName, std::string &oMapToParamName)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNumNetworkNodes
size_t getNumNetworkNodes()
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::IMaterialSchema
IMaterialSchema(const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition IMaterial.h:70
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getShaderParameters
Abc::ICompoundProperty getShaderParameters(const std::string &iTarget, const std::string &iShaderType)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getTargetNames
void getTargetNames(std::vector< std::string > &iTargetNames)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getShader
bool getShader(const std::string &iTarget, const std::string &iShaderType, std::string &oResult)
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::IMaterialSchema
IMaterialSchema()
Definition IMaterial.h:62
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialSchema::getNetworkTerminal
bool getNetworkTerminal(const std::string &iTarget, const std::string &iShaderType, std::string &oNodeName, std::string &oOutputName)
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
Definition ICompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::ICompoundProperty
ICompoundProperty()
Definition ICompoundProperty.h:65
Alembic::Abc::ALEMBIC_VERSION_NS::ISchemaObject
Definition ISchemaObject.h:56
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema
Definition ISchema.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< MaterialSchemaInfo >::ISchema
ISchema()
Definition ISchema.h:112
Alembic::AbcMaterial::ALEMBIC_VERSION_NS
Definition IMaterial.h:46
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterialPtr
Util::shared_ptr< IMaterial > IMaterialPtr
Definition IMaterial.h:222
Alembic::AbcMaterial::ALEMBIC_VERSION_NS::IMaterial
Abc::ISchemaObject< IMaterialSchema > IMaterial
Object declaration.
Definition IMaterial.h:220
Alembic::AbcMaterial
Definition IMaterial.h:45
Alembic::Abc
Definition ArchiveInfo.h:47
Alembic
Alembic namespace ...
Definition ArchiveInfo.h:46