shaderNode.h
Go to the documentation of this file.
1 //
2 // Copyright 2018 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 
25 #ifndef PXR_USD_SDR_SHADER_NODE_H
26 #define PXR_USD_SDR_SHADER_NODE_H
27 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usd/sdr/api.h"
33 #include "pxr/usd/ndr/node.h"
34 #include "pxr/usd/sdr/declare.h"
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 // Note: Metadata keys that are generated by parsers should start with
39 // "__SDR__" to reduce the risk of collision with metadata actually in the
40 // shader.
41 #define SDR_NODE_METADATA_TOKENS \
42  ((Category, "category")) \
43  ((Role, "role")) \
44  ((Departments, "departments")) \
45  ((Help, "help")) \
46  ((Label, "label")) \
47  ((Pages, "pages")) \
48  ((Primvars, "primvars")) \
49  ((ImplementationName, "__SDR__implementationName"))\
50  ((Target, "__SDR__target")) \
51  ((SdrUsdEncodingVersion, "sdrUsdEncodingVersion")) \
52  ((SdrDefinitionNameFallbackPrefix, "sdrDefinitionNameFallbackPrefix"))
53 
54 // Note: The concept of context is defined on NdrNode and can be queried with
55 // the GetContext() method. Sdr categorizes shaders by the context in which they
56 // are used inside of a renderer. For instance during 'pattern' evaluation to
57 // feed into a surface or volume shader. For BXDFs used in 'surface' and
58 // 'volume' rendering situations.
59 #define SDR_NODE_CONTEXT_TOKENS \
60  ((Pattern, "pattern")) \
61  ((Surface, "surface")) \
62  ((Volume, "volume")) \
63  ((Displacement, "displacement")) \
64  ((Light, "light")) \
65  ((LightFilter, "lightFilter")) \
66  ((SampleFilter, "sampleFilter")) \
67  ((PixelFilter, "pixelFilter"))
68 
69 #define SDR_NODE_ROLE_TOKENS \
70  ((Primvar, "primvar")) \
71  ((Texture, "texture")) \
72  ((Field, "field")) \
73  ((Math, "math")) \
74 
75 TF_DECLARE_PUBLIC_TOKENS(SdrNodeMetadata, SDR_API, SDR_NODE_METADATA_TOKENS);
76 TF_DECLARE_PUBLIC_TOKENS(SdrNodeContext, SDR_API, SDR_NODE_CONTEXT_TOKENS);
77 TF_DECLARE_PUBLIC_TOKENS(SdrNodeRole, SDR_API, SDR_NODE_ROLE_TOKENS);
78 
83 class SdrShaderNode : public NdrNode
84 {
85 public:
87  SDR_API
88  SdrShaderNode(const NdrIdentifier& identifier,
89  const NdrVersion& version,
90  const std::string& name,
91  const TfToken& family,
92  const TfToken& context,
93  const TfToken& sourceType,
94  const std::string& definitionURI,
95  const std::string& implementationURI,
96  NdrPropertyUniquePtrVec&& properties,
97  const NdrTokenMap& metadata = NdrTokenMap(),
98  const std::string &sourceCode = std::string());
99 
103 
106  SDR_API
107  SdrShaderPropertyConstPtr GetShaderInput(const TfToken& inputName) const;
108 
111  SDR_API
112  SdrShaderPropertyConstPtr GetShaderOutput(const TfToken& outputName) const;
113 
116  SDR_API
117  NdrTokenVec GetAssetIdentifierInputNames() const;
118 
123  SDR_API
124  SdrShaderPropertyConstPtr GetDefaultInput() const;
125 
127 
128 
135 
139  SDR_API
140  const TfToken& GetLabel() const { return _label; }
141 
144  SDR_API
145  const TfToken& GetCategory() const { return _category; }
146 
153  SDR_API
154  std::string GetRole() const;
155 
157  SDR_API
158  std::string GetHelp() const;
159 
161  SDR_API
162  const NdrTokenVec& GetDepartments() const { return _departments; }
163 
169  SDR_API
170  const NdrTokenVec& GetPages() const { return _pages; };
171 
178  SDR_API
179  const NdrTokenVec& GetPrimvars() const { return _primvars; }
180 
187  SDR_API
188  const NdrTokenVec& GetAdditionalPrimvarProperties() const {
189  return _primvarNamingProperties;
190  }
191 
199  SDR_API
200  std::string GetImplementationName() const;
201 
203 
204 
207 
211  SDR_API
212  NdrTokenVec GetPropertyNamesForPage(const std::string& pageName) const;
213 
215  SDR_API
216  NdrTokenVec GetAllVstructNames() const;
217 
219 
220 
223 
224  // Performs a post-process on properties to determine information that can
225  // only be determined after parsing or in aggregate. Clients SHOULD NOT
226  // need to call this.
227  void _PostProcessProperties();
228 
230 
231 protected:
232  // Processed primvar metadata. `_primvars` contains the names of primvars
233  // consumed by this node, whereas `_primvarNamingProperties` contains the
234  // names of string input properties whose values provide the names of
235  // additional primvars consumed by this node.
236  NdrTokenVec _primvars;
237  NdrTokenVec _primvarNamingProperties;
238 
239  // Tokenized metadata
240  TfToken _label;
241  TfToken _category;
242  NdrTokenVec _departments;
243  NdrTokenVec _pages;
244 
245  SdrPropertyMap _shaderInputs;
246  SdrPropertyMap _shaderOutputs;
247 
248 private:
249  // Initializes `_primvars` and `_primvarNamingProperties`
250  void _InitializePrimvars();
251 
252  // Determines which pages are present on the node's properties
253  NdrTokenVec _ComputePages() const;
254 };
255 
256 PXR_NAMESPACE_CLOSE_SCOPE
257 
258 #endif // PXR_USD_SDR_SHADER_NODE_H
SDR_API SdrShaderNode(const NdrIdentifier &identifier, const NdrVersion &version, const std::string &name, const TfToken &family, const TfToken &context, const TfToken &sourceType, const std::string &definitionURI, const std::string &implementationURI, NdrPropertyUniquePtrVec &&properties, const NdrTokenMap &metadata=NdrTokenMap(), const std::string &sourceCode=std::string())
Constructor.
SDR_API NdrTokenVec GetAllVstructNames() const
Gets all vstructs that are present in the shader.
SDR_API std::string GetHelp() const
The help message assigned to this node, if any.
SDR_API const TfToken & GetLabel() const
The label assigned to this node, if any.
Definition: shaderNode.h:140
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Represents an abstract node.
Definition: node.h:48
SDR_API std::string GetRole() const
Returns the role of this node.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
SDR_API NdrTokenVec GetAssetIdentifierInputNames() const
Returns the list of all inputs that are tagged as asset identifier inputs.
SDR_API SdrShaderPropertyConstPtr GetShaderOutput(const TfToken &outputName) const
Get a shader output property by name.
SDR_API SdrShaderPropertyConstPtr GetDefaultInput() const
Returns the first shader input that is tagged as the default input.
SDR_API const NdrTokenVec & GetPages() const
Gets the pages on which the node's properties reside (an aggregate of the unique SdrShaderProperty::G...
Definition: shaderNode.h:170
A specialized version of NdrNode which holds shading information.
Definition: shaderNode.h:83
SDR_API const TfToken & GetCategory() const
The category assigned to this node, if any.
Definition: shaderNode.h:145
This file defines some macros that are useful for declaring and using static TfTokens.
SDR_API std::string GetImplementationName() const
Returns the implementation name of this node.
SDR_API const NdrTokenVec & GetPrimvars() const
The list of primvars this node knows it requires / uses.
Definition: shaderNode.h:179
SDR_API const NdrTokenVec & GetAdditionalPrimvarProperties() const
The list of string input properties whose values provide the names of additional primvars consumed by...
Definition: shaderNode.h:188
SDR_API SdrShaderPropertyConstPtr GetShaderInput(const TfToken &inputName) const
Get a shader input property by name.
SDR_API const NdrTokenVec & GetDepartments() const
The departments this node is associated with, if any.
Definition: shaderNode.h:162
SDR_API NdrTokenVec GetPropertyNamesForPage(const std::string &pageName) const
Gets the names of the properties on a certain page (one that was returned by GetPages()).