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"
31 #include "pxr/usd/usdShade/shader.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 
60 {
61 public:
66 
71  explicit UsdRiRisObject(const UsdPrim& prim=UsdPrim())
72  : UsdShadeShader(prim)
73  {
74  }
75 
79  explicit UsdRiRisObject(const UsdSchemaBase& schemaObj)
80  : UsdShadeShader(schemaObj)
81  {
82  }
83 
85  USDRI_API
86  virtual ~UsdRiRisObject();
87 
91  USDRI_API
92  static const TfTokenVector &
93  GetSchemaAttributeNames(bool includeInherited=true);
94 
104  USDRI_API
105  static UsdRiRisObject
106  Get(const UsdStagePtr &stage, const SdfPath &path);
107 
130  USDRI_API
131  static UsdRiRisObject
132  Define(const UsdStagePtr &stage, const SdfPath &path);
133 
134 protected:
138  USDRI_API
139  UsdSchemaType _GetSchemaType() const override;
140 
141 private:
142  // needs to invoke _GetStaticTfType.
143  friend class UsdSchemaRegistry;
144  USDRI_API
145  static const TfType &_GetStaticTfType();
146 
147  static bool _IsTypedSchema();
148 
149  // override SchemaBase virtuals.
150  USDRI_API
151  const TfType &_GetTfType() const override;
152 
153 public:
154  // --------------------------------------------------------------------- //
155  // FILEPATH
156  // --------------------------------------------------------------------- //
163  USDRI_API
165 
171  USDRI_API
172  UsdAttribute CreateFilePathAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
173 
174 public:
175  // --------------------------------------------------------------------- //
176  // ARGSPATH
177  // --------------------------------------------------------------------- //
184  USDRI_API
186 
192  USDRI_API
193  UsdAttribute CreateArgsPathAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
194 
195 public:
196  // ===================================================================== //
197  // Feel free to add custom code below this line, it will be preserved by
198  // the code generator.
199  //
200  // Just remember to:
201  // - Close the class declaration with };
202  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
203  // - Close the include guard with #endif
204  // ===================================================================== //
205  // --(BEGIN CUSTOM CODE)--
206 
207 private:
208 
209 };
210 
211 PXR_NAMESPACE_CLOSE_SCOPE
212 
213 #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.
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:79
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
virtual USDRI_API ~UsdRiRisObject()
Destructor.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: risObject.h:65
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...
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
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:287
UsdRiRisObject(const UsdPrim &prim=UsdPrim())
Construct a UsdRiRisObject on UsdPrim prim .
Definition: risObject.h:71
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:43
USDRI_API UsdAttribute GetArgsPathAttr() const
C++ Type: SdfAssetPath Usd Type: SdfValueTypeNames-&gt;Asset Variability: SdfVariabilityVarying ...
Base class for all USD shaders.
Definition: shader.h:89
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDRI_API UsdAttribute GetFilePathAttr() const
C++ Type: SdfAssetPath Usd Type: SdfValueTypeNames-&gt;Asset Variability: SdfVariabilityVarying ...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
USDRI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.