gprim.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 USDGEOM_GENERATED_GPRIM_H
25 #define USDGEOM_GENERATED_GPRIM_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdGeom/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdGeom/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 // GPRIM //
51 // -------------------------------------------------------------------------- //
52 
67 {
68 public:
73 
78  explicit UsdGeomGprim(const UsdPrim& prim=UsdPrim())
79  : UsdGeomBoundable(prim)
80  {
81  }
82 
86  explicit UsdGeomGprim(const UsdSchemaBase& schemaObj)
87  : UsdGeomBoundable(schemaObj)
88  {
89  }
90 
92  USDGEOM_API
93  virtual ~UsdGeomGprim();
94 
98  USDGEOM_API
99  static const TfTokenVector &
100  GetSchemaAttributeNames(bool includeInherited=true);
101 
111  USDGEOM_API
112  static UsdGeomGprim
113  Get(const UsdStagePtr &stage, const SdfPath &path);
114 
115 
116 protected:
120  USDGEOM_API
121  UsdSchemaKind _GetSchemaKind() const override;
122 
123 private:
124  // needs to invoke _GetStaticTfType.
125  friend class UsdSchemaRegistry;
126  USDGEOM_API
127  static const TfType &_GetStaticTfType();
128 
129  static bool _IsTypedSchema();
130 
131  // override SchemaBase virtuals.
132  USDGEOM_API
133  const TfType &_GetTfType() const override;
134 
135 public:
136  // --------------------------------------------------------------------- //
137  // DISPLAYCOLOR
138  // --------------------------------------------------------------------- //
150  USDGEOM_API
152 
158  USDGEOM_API
159  UsdAttribute CreateDisplayColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
160 
161 public:
162  // --------------------------------------------------------------------- //
163  // DISPLAYOPACITY
164  // --------------------------------------------------------------------- //
175  USDGEOM_API
177 
183  USDGEOM_API
184  UsdAttribute CreateDisplayOpacityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
185 
186 public:
187  // --------------------------------------------------------------------- //
188  // DOUBLESIDED
189  // --------------------------------------------------------------------- //
214  USDGEOM_API
216 
222  USDGEOM_API
223  UsdAttribute CreateDoubleSidedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
224 
225 public:
226  // --------------------------------------------------------------------- //
227  // ORIENTATION
228  // --------------------------------------------------------------------- //
242  USDGEOM_API
244 
250  USDGEOM_API
251  UsdAttribute CreateOrientationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
252 
253 public:
254  // ===================================================================== //
255  // Feel free to add custom code below this line, it will be preserved by
256  // the code generator.
257  //
258  // Just remember to:
259  // - Close the class declaration with };
260  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
261  // - Close the include guard with #endif
262  // ===================================================================== //
263  // --(BEGIN CUSTOM CODE)--
264 
268  USDGEOM_API
270 
275  USDGEOM_API
277  const TfToken& interpolation = TfToken(),
278  int elementSize = -1) const;
279 
283  USDGEOM_API
285 
290  USDGEOM_API
292  const TfToken& interpolation = TfToken(),
293  int elementSize = -1) const;
294 
295 };
296 
297 PXR_NAMESPACE_CLOSE_SCOPE
298 
299 #endif
USDGEOM_API UsdGeomPrimvar GetDisplayColorPrimvar() const
Convenience function to get the displayColor Attribute as a Primvar.
USDGEOM_API UsdAttribute GetDisplayColorAttr() const
It is useful to have an "official" colorSet that can be used as a display or modeling color,...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: gprim.h:72
USDGEOM_API UsdAttribute CreateDisplayColorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDisplayColorAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
USDGEOM_API UsdAttribute GetOrientationAttr() const
Orientation specifies whether the gprim's surface normal should be computed using the right hand rule...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
virtual USDGEOM_API ~UsdGeomGprim()
Destructor.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
USDGEOM_API UsdAttribute GetDisplayOpacityAttr() const
Companion to displayColor that specifies opacity, broken out as an independent attribute rather than ...
USDGEOM_API UsdAttribute CreateDisplayOpacityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDisplayOpacityAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdGeomGprim(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomGprim on UsdPrim prim .
Definition: gprim.h:78
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space,...
Definition: boundable.h:82
USDGEOM_API UsdAttribute CreateDoubleSidedAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDoubleSidedAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
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 USDGEOM_API UsdGeomGprim Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomGprim holding the prim adhering to this schema at path on stage.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
USDGEOM_API UsdGeomPrimvar CreateDisplayOpacityPrimvar(const TfToken &interpolation=TfToken(), int elementSize=-1) const
Convenience function to create the displayOpacity primvar, optionally specifying interpolation and el...
static USDGEOM_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...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
USDGEOM_API UsdGeomPrimvar CreateDisplayColorPrimvar(const TfToken &interpolation=TfToken(), int elementSize=-1) const
Convenience function to create the displayColor primvar, optionally specifying interpolation and elem...
Base class for all geometric primitives.
Definition: gprim.h:66
UsdGeomGprim(const UsdSchemaBase &schemaObj)
Construct a UsdGeomGprim on the prim held by schemaObj .
Definition: gprim.h:86
USDGEOM_API UsdGeomPrimvar GetDisplayOpacityPrimvar() const
Convenience function to get the displayOpacity Attribute as a Primvar.
Represents a non-concrete typed schema.
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...
USDGEOM_API UsdAttribute GetDoubleSidedAttr() const
Although some renderers treat all parametric or polygonal surfaces as if they were effectively lamina...
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
Schema wrapper for UsdAttribute for authoring and introspecting attributes that are primvars.
Definition: primvar.h:260
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDGEOM_API UsdAttribute CreateOrientationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetOrientationAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
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...