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 
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 
44 PXR_NAMESPACE_OPEN_SCOPE
45 
46 class SdfAssetPath;
47 
48 // -------------------------------------------------------------------------- //
49 // RISPATTERN //
50 // -------------------------------------------------------------------------- //
51 
62 {
63 public:
68 
73  explicit UsdRiRisPattern(const UsdPrim& prim=UsdPrim())
74  : UsdRiRisObject(prim)
75  {
76  }
77 
81  explicit UsdRiRisPattern(const UsdSchemaBase& schemaObj)
82  : UsdRiRisObject(schemaObj)
83  {
84  }
85 
87  USDRI_API
88  virtual ~UsdRiRisPattern();
89 
93  USDRI_API
94  static const TfTokenVector &
95  GetSchemaAttributeNames(bool includeInherited=true);
96 
106  USDRI_API
107  static UsdRiRisPattern
108  Get(const UsdStagePtr &stage, const SdfPath &path);
109 
132  USDRI_API
133  static UsdRiRisPattern
134  Define(const UsdStagePtr &stage, const SdfPath &path);
135 
136 protected:
140  USDRI_API
141  UsdSchemaKind _GetSchemaKind() 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 
168 PXR_NAMESPACE_CLOSE_SCOPE
169 
170 #endif
USDRI_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdRiRisPattern(const UsdSchemaBase &schemaObj)
Construct a UsdRiRisPattern on the prim held by schemaObj .
Definition: risPattern.h:81
static USDRI_API UsdRiRisPattern Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiRisPattern holding the prim adhering to this schema at path on stage.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
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...
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
virtual USDRI_API ~UsdRiRisPattern()
Destructor.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
static USDRI_API UsdRiRisPattern Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
UsdRiRisPattern(const UsdPrim &prim=UsdPrim())
Construct a UsdRiRisPattern on UsdPrim prim .
Definition: risPattern.h:73
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
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...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: risPattern.h:67
The base class for all schema types in Usd.
Definition: schemaBase.h:56
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...