plane.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_PLANE_H
25 #define USDGEOM_GENERATED_PLANE_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdGeom/api.h"
31 #include "pxr/usd/usdGeom/gprim.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 // PLANE //
51 // -------------------------------------------------------------------------- //
52 
73 class UsdGeomPlane : public UsdGeomGprim
74 {
75 public:
80 
85  explicit UsdGeomPlane(const UsdPrim& prim=UsdPrim())
86  : UsdGeomGprim(prim)
87  {
88  }
89 
93  explicit UsdGeomPlane(const UsdSchemaBase& schemaObj)
94  : UsdGeomGprim(schemaObj)
95  {
96  }
97 
99  USDGEOM_API
100  virtual ~UsdGeomPlane();
101 
105  USDGEOM_API
106  static const TfTokenVector &
107  GetSchemaAttributeNames(bool includeInherited=true);
108 
118  USDGEOM_API
119  static UsdGeomPlane
120  Get(const UsdStagePtr &stage, const SdfPath &path);
121 
144  USDGEOM_API
145  static UsdGeomPlane
146  Define(const UsdStagePtr &stage, const SdfPath &path);
147 
148 protected:
152  USDGEOM_API
153  UsdSchemaKind _GetSchemaKind() const override;
154 
155 private:
156  // needs to invoke _GetStaticTfType.
157  friend class UsdSchemaRegistry;
158  USDGEOM_API
159  static const TfType &_GetStaticTfType();
160 
161  static bool _IsTypedSchema();
162 
163  // override SchemaBase virtuals.
164  USDGEOM_API
165  const TfType &_GetTfType() const override;
166 
167 public:
168  // --------------------------------------------------------------------- //
169  // DOUBLESIDED
170  // --------------------------------------------------------------------- //
182  USDGEOM_API
184 
190  USDGEOM_API
191  UsdAttribute CreateDoubleSidedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
192 
193 public:
194  // --------------------------------------------------------------------- //
195  // WIDTH
196  // --------------------------------------------------------------------- //
208  USDGEOM_API
209  UsdAttribute GetWidthAttr() const;
210 
216  USDGEOM_API
217  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
218 
219 public:
220  // --------------------------------------------------------------------- //
221  // LENGTH
222  // --------------------------------------------------------------------- //
234  USDGEOM_API
235  UsdAttribute GetLengthAttr() const;
236 
242  USDGEOM_API
243  UsdAttribute CreateLengthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
244 
245 public:
246  // --------------------------------------------------------------------- //
247  // AXIS
248  // --------------------------------------------------------------------- //
262  USDGEOM_API
263  UsdAttribute GetAxisAttr() const;
264 
270  USDGEOM_API
271  UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
272 
273 public:
274  // --------------------------------------------------------------------- //
275  // EXTENT
276  // --------------------------------------------------------------------- //
285  USDGEOM_API
286  UsdAttribute GetExtentAttr() const;
287 
293  USDGEOM_API
294  UsdAttribute CreateExtentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
295 
296 public:
297  // ===================================================================== //
298  // Feel free to add custom code below this line, it will be preserved by
299  // the code generator.
300  //
301  // Just remember to:
302  // - Close the class declaration with };
303  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
304  // - Close the include guard with #endif
305  // ===================================================================== //
306  // --(BEGIN CUSTOM CODE)--
307 
318  USDGEOM_API
319  static bool ComputeExtent(double width, double length, const TfToken& axis,
320  VtVec3fArray* extent);
321 
324  USDGEOM_API
325  static bool ComputeExtent(double width, double length, const TfToken& axis,
326  const GfMatrix4d& transform, VtVec3fArray* extent);
327 };
328 
329 PXR_NAMESPACE_CLOSE_SCOPE
330 
331 #endif
static USDGEOM_API UsdGeomPlane Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomPlane holding the prim adhering to this schema at path on stage.
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.
USDGEOM_API UsdAttribute GetWidthAttr() const
The width of the plane, which aligns to the x-axis when axis is 'Z' or 'Y', or to the z-axis when axi...
USDGEOM_API UsdAttribute CreateLengthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLengthAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdAttribute GetDoubleSidedAttr() const
Planes are double-sided by default.
static USDGEOM_API bool ComputeExtent(double width, double length, const TfToken &axis, VtVec3fArray *extent)
Compute the extent for the plane defined by the size of each dimension.
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...
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
USDGEOM_API UsdAttribute GetExtentAttr() const
Extent is re-defined on Plane only to provide a fallback value.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
static USDGEOM_API UsdGeomPlane Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
UsdGeomPlane(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomPlane on UsdPrim prim .
Definition: plane.h:85
USDGEOM_API UsdAttribute CreateExtentAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetExtentAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdAttribute CreateWidthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetWidthAttr(), 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:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
USDGEOM_API UsdAttribute GetAxisAttr() const
The axis along which the surface of the plane is aligned.
USDGEOM_API UsdAttribute CreateAxisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAxisAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: plane.h:79
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
Base class for all geometric primitives.
Definition: gprim.h:66
Defines a primitive plane, centered at the origin, and is defined by a cardinal axis,...
Definition: plane.h:73
virtual USDGEOM_API ~UsdGeomPlane()
Destructor.
USDGEOM_API UsdAttribute GetLengthAttr() const
The length of the plane, which aligns to the y-axis when axis is 'Z' or 'X', or to the z-axis when ax...
TfType represents a dynamic runtime type.
Definition: type.h:64
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
Singleton registry that provides access to schema type information and the prim definitions for regis...
UsdGeomPlane(const UsdSchemaBase &schemaObj)
Construct a UsdGeomPlane on the prim held by schemaObj .
Definition: plane.h:93
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:166
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...