All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rmanOslParser.h
Go to the documentation of this file.
1 //
2 // Copyright 2019 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 RMAN_OSL_PARSERPLUGIN_H
26 #define RMAN_OSL_PARSERPLUGIN_H
27 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/base/vt/value.h"
32 #include "pxr/usd/ndr/parserPlugin.h"
33 #include "pxr/usd/sdr/declare.h"
34 #include "RixShaderInfo.h"
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 // Forward declarations
39 class NdrNode;
41 
109 {
110 public:
113 
114  NdrNodeUniquePtr Parse(const NdrNodeDiscoveryResult& discoveryResult)
115  override;
116 
117  const NdrTokenVec& GetDiscoveryTypes() const override;
118 
119  const TfToken& GetSourceType() const override;
120 
121 private:
122  // Gets a vector of properties that are present on the specified OSL
123  // query object
124  NdrPropertyUniquePtrVec _getNodeProperties(
125  const NdrNodeDiscoveryResult& discoveryResult) const;
126 
127  // Gets all metadata for the node that's present on the specified OSL
128  // query object
129  NdrTokenMap _getNodeMetadata(
130  const NdrTokenMap &baseMetadata) const;
131 
132  // Gets all metadata for the specified OSL parameter
133  NdrTokenMap _getPropertyMetadata(const RixShaderParameter* param,
134  const NdrNodeDiscoveryResult& discoveryResult) const;
135 
136  // Injects any metadata that is generated by the parser. This type of
137  // metadata provides additional hints to the property.
138  void _injectParserMetadata(NdrTokenMap& metadata,
139  const TfToken& typeName) const;
140 
141  // Gets a common type + array size (if array) from the OSL parameter
142  std::tuple<TfToken, size_t> _getTypeName(
143  const RixShaderParameter* param,
144  const NdrTokenMap& metadata) const;
145 
146  // Gets the default value of the specified param.
147  VtValue _getDefaultValue(
148  const RixShaderParameter* param,
149  const std::string& oslType,
150  size_t arraySize,
151  const NdrTokenMap& metadata
152  ) const;
153 
154 private:
155  RixShaderQuery* m_sq;
156 
157 };
158 
159 PXR_NAMESPACE_CLOSE_SCOPE
160 
161 #endif // RMAN_OSL_PARSERPLUGIN_H
Interface for parser plugins.
Definition: parserPlugin.h:125
const TfToken & GetSourceType() const override
Returns the source type that this parser operates on.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
Parses OSL nodes.
Represents an abstract node.
Definition: node.h:48
Represents the raw data of a node, and some other bits of metadata, that were determined via a NdrDis...
const NdrTokenVec & GetDiscoveryTypes() const override
Returns the types of nodes that this plugin can parse.
NdrNodeUniquePtr Parse(const NdrNodeDiscoveryResult &discoveryResult) override
Takes the specified NdrNodeDiscoveryResult instance, which was a result of the discovery process...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182