All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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"
31 #include "pxr/usd/usdGeom/boundable.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  UsdSchemaType _GetSchemaType() 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  // --------------------------------------------------------------------- //
149  USDGEOM_API
151 
157  USDGEOM_API
158  UsdAttribute CreateDisplayColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
159 
160 public:
161  // --------------------------------------------------------------------- //
162  // DISPLAYOPACITY
163  // --------------------------------------------------------------------- //
173  USDGEOM_API
175 
181  USDGEOM_API
182  UsdAttribute CreateDisplayOpacityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
183 
184 public:
185  // --------------------------------------------------------------------- //
186  // DOUBLESIDED
187  // --------------------------------------------------------------------- //
210  USDGEOM_API
212 
218  USDGEOM_API
219  UsdAttribute CreateDoubleSidedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
220 
221 public:
222  // --------------------------------------------------------------------- //
223  // ORIENTATION
224  // --------------------------------------------------------------------- //
236  USDGEOM_API
238 
244  USDGEOM_API
245  UsdAttribute CreateOrientationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
246 
247 public:
248  // ===================================================================== //
249  // Feel free to add custom code below this line, it will be preserved by
250  // the code generator.
251  //
252  // Just remember to:
253  // - Close the class declaration with };
254  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
255  // - Close the include guard with #endif
256  // ===================================================================== //
257  // --(BEGIN CUSTOM CODE)--
258 
262  USDGEOM_API
264 
269  USDGEOM_API
271  const TfToken& interpolation = TfToken(),
272  int elementSize = -1) const;
273 
277  USDGEOM_API
279 
284  USDGEOM_API
286  const TfToken& interpolation = TfToken(),
287  int elementSize = -1) const;
288 
289 };
290 
291 PXR_NAMESPACE_CLOSE_SCOPE
292 
293 #endif
USDGEOM_API UsdGeomPrimvar CreateDisplayColorPrimvar(const TfToken &interpolation=TfToken(), int elementSize=-1) const
Convenience function to create the displayColor primvar, optionally specifying interpolation and elem...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
USDGEOM_API UsdGeomPrimvar GetDisplayColorPrimvar() const
Convenience function to get the displayColor Attribute as a Primvar.
USDGEOM_API UsdGeomPrimvar CreateDisplayOpacityPrimvar(const TfToken &interpolation=TfToken(), int elementSize=-1) const
Convenience function to create the displayOpacity primvar, optionally specifying interpolation and el...
USDGEOM_API UsdAttribute GetDisplayColorAttr() const
It is useful to have an "official" colorSet that can be used as a display or modeling color...
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...
virtual USDGEOM_API ~UsdGeomGprim()
Destructor.
USDGEOM_API UsdAttribute GetDisplayOpacityAttr() const
Companion to displayColor that specifies opacity, broken out as an independent attribute rather than ...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
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, extent.
Definition: boundable.h:82
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
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: gprim.h:72
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
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.
Represents a non-concrete typed schema.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDGEOM_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
USDGEOM_API UsdAttribute GetOrientationAttr() const
Orientation specifies whether the gprim&#39;s surface normal should be computed using the right hand rule...
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...
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...
USDGEOM_API UsdGeomPrimvar GetDisplayOpacityPrimvar() const
Convenience function to get the displayOpacity Attribute as a Primvar.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
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 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...
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
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
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
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...
USDGEOM_API UsdAttribute GetDoubleSidedAttr() const
Although some renderers treat all parametric or polygonal surfaces as if they were effectively lamina...