HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
utils.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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 #ifndef PXR_USD_USD_SHADE_UTILS_H
25 #define PXR_USD_USD_SHADE_UTILS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/usdShade/api.h"
29 
30 #include "pxr/base/tf/token.h"
31 
32 #include <string>
33 #include <utility>
34 
36 
37 
38 /// \enum UsdShadeAttributeType
39 ///
40 /// Specifies the type of a shading attribute.
41 ///
43  Invalid,
44  Input,
45  Output,
46 };
47 
48 /// \class UsdShadeUtils
49 ///
50 /// This class contains a set of utility functions used when authoring and
51 /// querying shading networks.
52 ///
54 public:
55  /// Returns the namespace prefix of the USD attribute associated with the given
56  /// shading attribute type.
59  UsdShadeAttributeType sourceType);
60 
61  /// Given the full name of a shading attribute, returns it's base name and type.
63  static std::pair<TfToken, UsdShadeAttributeType>
64  GetBaseNameAndType(const TfToken &fullName);
65 
66  /// Returns the full shading attribute name given the basename and the type.
67  /// \p baseName is the name of the input or output on the shading node.
68  /// \p type is the \ref UsdShadeAttributeType of the shading attribute.
70  static TfToken GetFullName(const TfToken &baseName,
72 };
73 
75 
76 #endif
#define USDSHADE_API
Definition: api.h:40
static USDSHADE_API std::pair< TfToken, UsdShadeAttributeType > GetBaseNameAndType(const TfToken &fullName)
Given the full name of a shading attribute, returns it's base name and type.
static USDSHADE_API std::string GetPrefixForAttributeType(UsdShadeAttributeType sourceType)
Definition: token.h:87
GLuint GLuint GLsizei GLenum type
Definition: glew.h:1253
static USDSHADE_API TfToken GetFullName(const TfToken &baseName, const UsdShadeAttributeType type)
UsdShadeAttributeType
Definition: utils.h:42
GLsizei const GLchar *const * string
Definition: glew.h:1844
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91