HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
risPattern.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 USDRI_GENERATED_RISPATTERN_H
25 #define USDRI_GENERATED_RISPATTERN_H
26 
27 /// \file usdRi/risPattern.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 
35 #include "pxr/base/vt/value.h"
36 
37 #include "pxr/base/gf/vec3d.h"
38 #include "pxr/base/gf/vec3f.h"
39 #include "pxr/base/gf/matrix4d.h"
40 
41 #include "pxr/base/tf/token.h"
42 #include "pxr/base/tf/type.h"
43 
45 
46 class SdfAssetPath;
47 
48 // -------------------------------------------------------------------------- //
49 // RISPATTERN //
50 // -------------------------------------------------------------------------- //
51 
52 /// \class UsdRiRisPattern
53 ///
54 ///
55 /// \deprecated Specialized RIS shader schemas have been deprecated in
56 /// favor of all shader prims being simple UsdShadeShader.
57 /// This schema will be removed in a future release.
58 ///
59 /// Represents a ris pattern object. Multiple of these can be assigned.
60 ///
62 {
63 public:
64  /// Compile time constant representing what kind of schema this class is.
65  ///
66  /// \sa UsdSchemaType
68 
69  /// Construct a UsdRiRisPattern on UsdPrim \p prim .
70  /// Equivalent to UsdRiRisPattern::Get(prim.GetStage(), prim.GetPath())
71  /// for a \em valid \p prim, but will not immediately throw an error for
72  /// an invalid \p prim
73  explicit UsdRiRisPattern(const UsdPrim& prim=UsdPrim())
74  : UsdRiRisObject(prim)
75  {
76  }
77 
78  /// Construct a UsdRiRisPattern on the prim held by \p schemaObj .
79  /// Should be preferred over UsdRiRisPattern(schemaObj.GetPrim()),
80  /// as it preserves SchemaBase state.
81  explicit UsdRiRisPattern(const UsdSchemaBase& schemaObj)
82  : UsdRiRisObject(schemaObj)
83  {
84  }
85 
86  /// Destructor.
87  USDRI_API
88  virtual ~UsdRiRisPattern();
89 
90  /// Return a vector of names of all pre-declared attributes for this schema
91  /// class and all its ancestor classes. Does not include attributes that
92  /// may be authored by custom/extended methods of the schemas involved.
93  USDRI_API
94  static const TfTokenVector &
95  GetSchemaAttributeNames(bool includeInherited=true);
96 
97  /// Return a UsdRiRisPattern holding the prim adhering to this
98  /// schema at \p path on \p stage. If no prim exists at \p path on
99  /// \p stage, or if the prim at that path does not adhere to this schema,
100  /// return an invalid schema object. This is shorthand for the following:
101  ///
102  /// \code
103  /// UsdRiRisPattern(stage->GetPrimAtPath(path));
104  /// \endcode
105  ///
106  USDRI_API
107  static UsdRiRisPattern
108  Get(const UsdStagePtr &stage, const SdfPath &path);
109 
110  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
111  /// is defined (according to UsdPrim::IsDefined()) on this stage.
112  ///
113  /// If a prim adhering to this schema at \p path is already defined on this
114  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
115  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
116  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
117  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
118  /// current EditTarget for any nonexistent, or existing but not \a Defined
119  /// ancestors.
120  ///
121  /// The given \a path must be an absolute prim path that does not contain
122  /// any variant selections.
123  ///
124  /// If it is impossible to author any of the necessary PrimSpecs, (for
125  /// example, in case \a path cannot map to the current UsdEditTarget's
126  /// namespace) issue an error and return an invalid \a UsdPrim.
127  ///
128  /// Note that this method may return a defined prim whose typeName does not
129  /// specify this schema class, in case a stronger typeName opinion overrides
130  /// the opinion at the current EditTarget.
131  ///
132  USDRI_API
133  static UsdRiRisPattern
134  Define(const UsdStagePtr &stage, const SdfPath &path);
135 
136 protected:
137  /// Returns the type of schema this class belongs to.
138  ///
139  /// \sa UsdSchemaType
140  USDRI_API
141  UsdSchemaType _GetSchemaType() const override;
142 
143 private:
144  // needs to invoke _GetStaticTfType.
145  friend class UsdSchemaRegistry;
146  USDRI_API
147  static const TfType &_GetStaticTfType();
148 
149  static bool _IsTypedSchema();
150 
151  // override SchemaBase virtuals.
152  USDRI_API
153  const TfType &_GetTfType() const override;
154 
155 public:
156  // ===================================================================== //
157  // Feel free to add custom code below this line, it will be preserved by
158  // the code generator.
159  //
160  // Just remember to:
161  // - Close the class declaration with };
162  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
163  // - Close the include guard with #endif
164  // ===================================================================== //
165  // --(BEGIN CUSTOM CODE)--
166 };
167 
169 
170 #endif
static const UsdSchemaType schemaType
Definition: risPattern.h:67
static USDRI_API UsdRiRisPattern Define(const UsdStagePtr &stage, const SdfPath &path)
UsdRiRisPattern(const UsdPrim &prim=UsdPrim())
Definition: risPattern.h:73
Represents a concrete typed schema.
static USDRI_API UsdRiRisPattern Get(const UsdStagePtr &stage, const SdfPath &path)
UsdSchemaType
Definition: common.h:127
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:446
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
#define USDRI_API
Definition: api.h:40
Definition: path.h:288
USDRI_API UsdSchemaType _GetSchemaType() const override
GLsizei const GLchar *const * path
Definition: glew.h:6461
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
virtual USDRI_API ~UsdRiRisPattern()
Destructor.
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
UsdRiRisPattern(const UsdSchemaBase &schemaObj)
Definition: risPattern.h:81
Definition: type.h:64