All Classes Files Functions Variables Pages
collisionAPI.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 USDPHYSICS_GENERATED_COLLISIONAPI_H
25 #define USDPHYSICS_GENERATED_COLLISIONAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "usdPhysics/api.h"
31 #include "pxr/usd/usd/apiSchemaBase.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "usdPhysics/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 // PHYSICSCOLLISIONAPI //
51 // -------------------------------------------------------------------------- //
52 
62 class UsdPhysicsCollisionAPI : public UsdAPISchemaBase
63 {
64 public:
68  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
69 
74  explicit UsdPhysicsCollisionAPI(const UsdPrim& prim=UsdPrim())
75  : UsdAPISchemaBase(prim)
76  {
77  }
78 
82  explicit UsdPhysicsCollisionAPI(const UsdSchemaBase& schemaObj)
83  : UsdAPISchemaBase(schemaObj)
84  {
85  }
86 
88  USDPHYSICS_API
89  virtual ~UsdPhysicsCollisionAPI();
90 
94  USDPHYSICS_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  USDPHYSICS_API
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
111 
126  USDPHYSICS_API
127  static UsdPhysicsCollisionAPI
128  Apply(const UsdPrim &prim);
129 
130 protected:
134  USDPHYSICS_API
135  UsdSchemaType _GetSchemaType() const override;
136 
137 private:
138  // needs to invoke _GetStaticTfType.
139  friend class UsdSchemaRegistry;
140  USDPHYSICS_API
141  static const TfType &_GetStaticTfType();
142 
143  static bool _IsTypedSchema();
144 
145  // override SchemaBase virtuals.
146  USDPHYSICS_API
147  const TfType &_GetTfType() const override;
148 
149 public:
150  // --------------------------------------------------------------------- //
151  // COLLISIONENABLED
152  // --------------------------------------------------------------------- //
160  USDPHYSICS_API
161  UsdAttribute GetCollisionEnabledAttr() const;
162 
168  USDPHYSICS_API
169  UsdAttribute CreateCollisionEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
170 
171 public:
172  // --------------------------------------------------------------------- //
173  // SIMULATIONOWNER
174  // --------------------------------------------------------------------- //
180  USDPHYSICS_API
181  UsdRelationship GetSimulationOwnerRel() const;
182 
185  USDPHYSICS_API
186  UsdRelationship CreateSimulationOwnerRel() const;
187 
188 public:
189  // ===================================================================== //
190  // Feel free to add custom code below this line, it will be preserved by
191  // the code generator.
192  //
193  // Just remember to:
194  // - Close the class declaration with };
195  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
196  // - Close the include guard with #endif
197  // ===================================================================== //
198  // --(BEGIN CUSTOM CODE)--
199 };
200 
201 PXR_NAMESPACE_CLOSE_SCOPE
202 
203 #endif
UsdPhysicsCollisionAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsCollisionAPI on UsdPrim prim .
Definition: collisionAPI.h:74
USDPHYSICS_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
USDPHYSICS_API UsdAttribute CreateCollisionEnabledAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCollisionEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static USDPHYSICS_API UsdPhysicsCollisionAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
USDPHYSICS_API UsdAttribute GetCollisionEnabledAttr() const
Determines if the PhysicsCollisionAPI is enabled.
USDPHYSICS_API UsdRelationship GetSimulationOwnerRel() const
Single PhysicsScene that will simulate this collider.
static USDPHYSICS_API UsdPhysicsCollisionAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsCollisionAPI holding the prim adhering to this schema at path on stage...
Applies collision attributes to a UsdGeomXformable prim.
Definition: collisionAPI.h:62
static USDPHYSICS_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...
virtual USDPHYSICS_API ~UsdPhysicsCollisionAPI()
Destructor.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: collisionAPI.h:68
USDPHYSICS_API UsdRelationship CreateSimulationOwnerRel() const
See GetSimulationOwnerRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
UsdPhysicsCollisionAPI(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsCollisionAPI on the prim held by schemaObj .
Definition: collisionAPI.h:82