HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
registeredVariantSet.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_UTILS_REGISTERED_VARIANT_SET_H
25 #define PXR_USD_USD_UTILS_REGISTERED_VARIANT_SET_H
26 
27 /// \file usdUtils/registeredVariantSet.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdUtils/api.h"
31 #include <string>
32 
34 
35 
36 /// \class UsdUtilsRegisteredVariantSet
37 ///
38 /// Class that holds information about variantSets that are registered with
39 /// the pipeline.
40 ///
41 /// Registered variantSets are known variantSets in a pipeline that may need to
42 /// be reasoned about by apps during import/export.
43 ///
44 /// \sa UsdUtilsGetRegisteredVariantSets
46 {
47 public:
48  /// The name of the variantSet.
50 
51  /// This specifies how the variantSet should be treated during export.
52  ///
53  /// Note, in the plugInfo.json, the values for these enum's are
54  /// lowerCamelCase.
55  enum class SelectionExportPolicy {
56  /// Never
57  ///
58  /// This variantSet selection is meant to remain entirely within an
59  /// application. This typically represents a "session" variantSelection
60  /// that should not be transmitted down the pipeline.
61  Never,
62 
63  /// IfAuthored
64  ///
65  /// This variantSet selection should be exported if there is an authored
66  /// opinion in the application. This is only relevant if the
67  /// application is able to distinguish between "default" and "set"
68  /// opinions.
69  IfAuthored,
70 
71  /// Authored
72  ///
73  /// This variantSet selection should always be exported.
74  Always,
75  };
76 
77  /// Specifies how to export a variant selection.
79 
81  const std::string& name,
83  name(name),
84  selectionExportPolicy(selectionExportPolicy)
85  {
86  }
87 
88  // provided so this can be stored in a std::set.
90  other) const {
91  return this->name < other.name;
92  }
93 };
94 
95 
97 
98 #endif /* PXR_USD_USD_UTILS_REGISTERED_VARIANT_SET_H */
UsdUtilsRegisteredVariantSet(const std::string &name, const SelectionExportPolicy &selectionExportPolicy)
GLuint const GLchar * name
Definition: glcorearb.h:785
bool operator<(const UsdUtilsRegisteredVariantSet &other) const
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
const SelectionExportPolicy selectionExportPolicy
Specifies how to export a variant selection.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
const std::string name
The name of the variantSet.