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 
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 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // RISOBJECT //
51 // -------------------------------------------------------------------------- //
52 
63 {
64 public:
69 
74  explicit UsdRiRisObject(const UsdPrim& prim=UsdPrim())
75  : UsdShadeShader(prim)
76  {
77  }
78 
82  explicit UsdRiRisObject(const UsdSchemaBase& schemaObj)
83  : UsdShadeShader(schemaObj)
84  {
85  }
86 
88  USDRI_API
89  virtual ~UsdRiRisObject();
90 
94  USDRI_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  USDRI_API
108  static UsdRiRisObject
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
133  USDRI_API
134  static UsdRiRisObject
135  Define(const UsdStagePtr &stage, const SdfPath &path);
136 
137 protected:
141  USDRI_API
142  UsdSchemaKind _GetSchemaKind() 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  // --------------------------------------------------------------------- //
167  USDRI_API
169 
175  USDRI_API
176  UsdAttribute CreateFilePathAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
177 
178 public:
179  // --------------------------------------------------------------------- //
180  // ARGSPATH
181  // --------------------------------------------------------------------- //
189  USDRI_API
191 
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 
216 PXR_NAMESPACE_CLOSE_SCOPE
217 
218 #endif
static USDRI_API UsdRiRisObject Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiRisObject holding the prim adhering to this schema at path on stage.
USDRI_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
UsdRiRisObject(const UsdSchemaBase &schemaObj)
Construct a UsdRiRisObject on the prim held by schemaObj .
Definition: risObject.h:82
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: risObject.h:68
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
virtual USDRI_API ~UsdRiRisObject()
Destructor.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
USDRI_API UsdAttribute CreateFilePathAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFilePathAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Represents a concrete typed schema.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
static USDRI_API UsdRiRisObject Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
UsdRiRisObject(const UsdPrim &prim=UsdPrim())
Construct a UsdRiRisObject on UsdPrim prim .
Definition: risObject.h:74
USDRI_API UsdAttribute CreateArgsPathAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetArgsPathAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
USDRI_API UsdAttribute GetArgsPathAttr() const
Declaration asset info:argsPath C++ Type SdfAssetPath Usd Type SdfValueTypeNames-&gt;Asset ...
Base class for all USD shaders.
Definition: shader.h:85
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDRI_API UsdAttribute GetFilePathAttr() const
Declaration asset info:filePath C++ Type SdfAssetPath Usd Type SdfValueTypeNames-&gt;Asset ...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:168
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...