All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
utils.h
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 USD_SHD_UTILS_H
25 #define USD_SHD_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 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 
44 enum class UsdShadeAttributeType {
45  Invalid,
46  Input,
47  Output,
48  Parameter,
49  InterfaceAttribute
50 };
51 
58 public:
61  USDSHADE_API
62  static std::string GetPrefixForAttributeType(
63  UsdShadeAttributeType sourceType);
64 
66  USDSHADE_API
67  static std::pair<TfToken, UsdShadeAttributeType>
68  GetBaseNameAndType(const TfToken &fullName);
69 
73  USDSHADE_API
74  static TfToken GetFullName(const TfToken &baseName,
75  const UsdShadeAttributeType type);
76 
79  USDSHADE_API
80  static bool ReadOldEncoding();
81 
84  USDSHADE_API
85  static bool WriteNewEncoding();
86 };
87 
88 PXR_NAMESPACE_CLOSE_SCOPE
89 
90 #endif
static USDSHADE_API bool WriteNewEncoding()
Whether the env-setting that enables the writing of new-style encoding of shading networks is set to ...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
This class contains a set of utility functions used when authoring and querying shading networks...
Definition: utils.h:57
static USDSHADE_API std::string GetPrefixForAttributeType(UsdShadeAttributeType sourceType)
Returns the namespace prefix of the USD attribute associated with the given shading attribute type...
static USDSHADE_API bool ReadOldEncoding()
Whether the env-setting that enables the reading of old-style encoding of shading networks is set to ...
static USDSHADE_API TfToken GetFullName(const TfToken &baseName, const UsdShadeAttributeType type)
Returns the full shading attribute name given the basename and the type.
static USDSHADE_API std::pair< TfToken, UsdShadeAttributeType > GetBaseNameAndType(const TfToken &fullName)
Given the full name of a shading property, returns it&#39;s base name and type.