All Classes Files Functions Variables Pages
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 PHYSXSCHEMA_GENERATED_PLANE_H
25 #define PHYSXSCHEMA_GENERATED_PLANE_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.h"
31 #include "pxr/usd/usdGeom/mesh.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include ".//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 
62 class PhysxSchemaPlane : public UsdGeomMesh
63 {
64 public:
68  static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped;
69 
74  explicit PhysxSchemaPlane(const UsdPrim& prim=UsdPrim())
75  : UsdGeomMesh(prim)
76  {
77  }
78 
82  explicit PhysxSchemaPlane(const UsdSchemaBase& schemaObj)
83  : UsdGeomMesh(schemaObj)
84  {
85  }
86 
88  PHYSXSCHEMA_API
89  virtual ~PhysxSchemaPlane();
90 
94  PHYSXSCHEMA_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  PHYSXSCHEMA_API
108  static PhysxSchemaPlane
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
133  PHYSXSCHEMA_API
134  static PhysxSchemaPlane
135  Define(const UsdStagePtr &stage, const SdfPath &path);
136 
137 protected:
141  PHYSXSCHEMA_API
142  UsdSchemaType _GetSchemaType() const override;
143 
144 private:
145  // needs to invoke _GetStaticTfType.
146  friend class UsdSchemaRegistry;
147  PHYSXSCHEMA_API
148  static const TfType &_GetStaticTfType();
149 
150  static bool _IsTypedSchema();
151 
152  // override SchemaBase virtuals.
153  PHYSXSCHEMA_API
154  const TfType &_GetTfType() const override;
155 
156 public:
157  // --------------------------------------------------------------------- //
158  // AXIS
159  // --------------------------------------------------------------------- //
169  PHYSXSCHEMA_API
170  UsdAttribute GetAxisAttr() const;
171 
177  PHYSXSCHEMA_API
178  UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
179 
180 public:
181  // ===================================================================== //
182  // Feel free to add custom code below this line, it will be preserved by
183  // the code generator.
184  //
185  // Just remember to:
186  // - Close the class declaration with };
187  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
188  // - Close the include guard with #endif
189  // ===================================================================== //
190  // --(BEGIN CUSTOM CODE)--
191 };
192 
193 PXR_NAMESPACE_CLOSE_SCOPE
194 
195 #endif
PHYSXSCHEMA_API UsdAttribute CreateAxisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAxisAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PhysxSchemaPlane(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPlane on UsdPrim prim .
Definition: plane.h:74
static PHYSXSCHEMA_API PhysxSchemaPlane Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
PHYSXSCHEMA_API UsdAttribute GetAxisAttr() const
The axis along which the plane normal is aligned.
static PHYSXSCHEMA_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...
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
Plane geometry primitive.
Definition: plane.h:62
PhysxSchemaPlane(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPlane on the prim held by schemaObj .
Definition: plane.h:82
static PHYSXSCHEMA_API PhysxSchemaPlane Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPlane holding the prim adhering to this schema at path on stage.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: plane.h:68
virtual PHYSXSCHEMA_API ~PhysxSchemaPlane()
Destructor.