HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
risObject.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_RISOBJECT_H
25 #define USDRI_GENERATED_RISOBJECT_H
26 
27 /// \file usdRi/risObject.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 #include "pxr/usd/usdRi/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // RISOBJECT //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdRiRisObject
54 ///
55 ///
56 /// \deprecated Specialized RIS shader schemas have been deprecated in
57 /// favor of all shader prims being simple UsdShadeShader.
58 /// This schema will be removed in a future release.
59 ///
60 /// Represents a ris object with connectable parameters.
61 ///
63 {
64 public:
65  /// Compile time constant representing what kind of schema this class is.
66  ///
67  /// \sa UsdSchemaType
69 
70  /// Construct a UsdRiRisObject on UsdPrim \p prim .
71  /// Equivalent to UsdRiRisObject::Get(prim.GetStage(), prim.GetPath())
72  /// for a \em valid \p prim, but will not immediately throw an error for
73  /// an invalid \p prim
74  explicit UsdRiRisObject(const UsdPrim& prim=UsdPrim())
75  : UsdShadeShader(prim)
76  {
77  }
78 
79  /// Construct a UsdRiRisObject on the prim held by \p schemaObj .
80  /// Should be preferred over UsdRiRisObject(schemaObj.GetPrim()),
81  /// as it preserves SchemaBase state.
82  explicit UsdRiRisObject(const UsdSchemaBase& schemaObj)
83  : UsdShadeShader(schemaObj)
84  {
85  }
86 
87  /// Destructor.
88  USDRI_API
89  virtual ~UsdRiRisObject();
90 
91  /// Return a vector of names of all pre-declared attributes for this schema
92  /// class and all its ancestor classes. Does not include attributes that
93  /// may be authored by custom/extended methods of the schemas involved.
94  USDRI_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
98  /// Return a UsdRiRisObject holding the prim adhering to this
99  /// schema at \p path on \p stage. If no prim exists at \p path on
100  /// \p stage, or if the prim at that path does not adhere to this schema,
101  /// return an invalid schema object. This is shorthand for the following:
102  ///
103  /// \code
104  /// UsdRiRisObject(stage->GetPrimAtPath(path));
105  /// \endcode
106  ///
107  USDRI_API
108  static UsdRiRisObject
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
111  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
112  /// is defined (according to UsdPrim::IsDefined()) on this stage.
113  ///
114  /// If a prim adhering to this schema at \p path is already defined on this
115  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
116  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
117  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
118  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
119  /// current EditTarget for any nonexistent, or existing but not \a Defined
120  /// ancestors.
121  ///
122  /// The given \a path must be an absolute prim path that does not contain
123  /// any variant selections.
124  ///
125  /// If it is impossible to author any of the necessary PrimSpecs, (for
126  /// example, in case \a path cannot map to the current UsdEditTarget's
127  /// namespace) issue an error and return an invalid \a UsdPrim.
128  ///
129  /// Note that this method may return a defined prim whose typeName does not
130  /// specify this schema class, in case a stronger typeName opinion overrides
131  /// the opinion at the current EditTarget.
132  ///
133  USDRI_API
134  static UsdRiRisObject
135  Define(const UsdStagePtr &stage, const SdfPath &path);
136 
137 protected:
138  /// Returns the type of schema this class belongs to.
139  ///
140  /// \sa UsdSchemaType
141  USDRI_API
142  UsdSchemaType _GetSchemaType() const override;
143 
144 private:
145  // needs to invoke _GetStaticTfType.
146  friend class UsdSchemaRegistry;
147  USDRI_API
148  static const TfType &_GetStaticTfType();
149 
150  static bool _IsTypedSchema();
151 
152  // override SchemaBase virtuals.
153  USDRI_API
154  const TfType &_GetTfType() const override;
155 
156 public:
157  // --------------------------------------------------------------------- //
158  // FILEPATH
159  // --------------------------------------------------------------------- //
160  ///
161  ///
162  /// | ||
163  /// | -- | -- |
164  /// | Declaration | `asset info:filePath` |
165  /// | C++ Type | SdfAssetPath |
166  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Asset |
167  USDRI_API
169 
170  /// See GetFilePathAttr(), and also
171  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
172  /// If specified, author \p defaultValue as the attribute's default,
173  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
174  /// the default for \p writeSparsely is \c false.
175  USDRI_API
176  UsdAttribute CreateFilePathAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
177 
178 public:
179  // --------------------------------------------------------------------- //
180  // ARGSPATH
181  // --------------------------------------------------------------------- //
182  ///
183  ///
184  /// | ||
185  /// | -- | -- |
186  /// | Declaration | `asset info:argsPath` |
187  /// | C++ Type | SdfAssetPath |
188  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Asset |
189  USDRI_API
191 
192  /// See GetArgsPathAttr(), and also
193  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
194  /// If specified, author \p defaultValue as the attribute's default,
195  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
196  /// the default for \p writeSparsely is \c false.
197  USDRI_API
198  UsdAttribute CreateArgsPathAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
199 
200 public:
201  // ===================================================================== //
202  // Feel free to add custom code below this line, it will be preserved by
203  // the code generator.
204  //
205  // Just remember to:
206  // - Close the class declaration with };
207  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
208  // - Close the include guard with #endif
209  // ===================================================================== //
210  // --(BEGIN CUSTOM CODE)--
211 
212 private:
213 
214 };
215 
217 
218 #endif
USDRI_API UsdAttribute CreateFilePathAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateArgsPathAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
UsdRiRisObject(const UsdPrim &prim=UsdPrim())
Definition: risObject.h:74
static USDRI_API UsdRiRisObject Define(const UsdStagePtr &stage, const SdfPath &path)
virtual USDRI_API ~UsdRiRisObject()
Destructor.
Represents a concrete typed schema.
UsdRiRisObject(const UsdSchemaBase &schemaObj)
Definition: risObject.h:82
static USDRI_API UsdRiRisObject 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
USDRI_API UsdSchemaType _GetSchemaType() const override
#define USDRI_API
Definition: api.h:40
Definition: path.h:288
GLsizei const GLchar *const * path
Definition: glew.h:6461
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
USDRI_API UsdAttribute GetFilePathAttr() const
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
USDRI_API UsdAttribute GetArgsPathAttr() const
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
static const UsdSchemaType schemaType
Definition: risObject.h:68
Definition: value.h:174