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 "pxr/usd/usdPhysics/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.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 {
63 public:
68 
73  explicit UsdPhysicsCollisionAPI(const UsdPrim& prim=UsdPrim())
74  : UsdAPISchemaBase(prim)
75  {
76  }
77 
81  explicit UsdPhysicsCollisionAPI(const UsdSchemaBase& schemaObj)
82  : UsdAPISchemaBase(schemaObj)
83  {
84  }
85 
87  USDPHYSICS_API
88  virtual ~UsdPhysicsCollisionAPI();
89 
93  USDPHYSICS_API
94  static const TfTokenVector &
95  GetSchemaAttributeNames(bool includeInherited=true);
96 
106  USDPHYSICS_API
108  Get(const UsdStagePtr &stage, const SdfPath &path);
109 
110 
127  USDPHYSICS_API
128  static bool
129  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
130 
146  USDPHYSICS_API
147  static UsdPhysicsCollisionAPI
148  Apply(const UsdPrim &prim);
149 
150 protected:
154  USDPHYSICS_API
155  UsdSchemaKind _GetSchemaKind() const override;
156 
157 private:
158  // needs to invoke _GetStaticTfType.
159  friend class UsdSchemaRegistry;
160  USDPHYSICS_API
161  static const TfType &_GetStaticTfType();
162 
163  static bool _IsTypedSchema();
164 
165  // override SchemaBase virtuals.
166  USDPHYSICS_API
167  const TfType &_GetTfType() const override;
168 
169 public:
170  // --------------------------------------------------------------------- //
171  // COLLISIONENABLED
172  // --------------------------------------------------------------------- //
180  USDPHYSICS_API
182 
188  USDPHYSICS_API
189  UsdAttribute CreateCollisionEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
190 
191 public:
192  // --------------------------------------------------------------------- //
193  // SIMULATIONOWNER
194  // --------------------------------------------------------------------- //
200  USDPHYSICS_API
202 
205  USDPHYSICS_API
207 
208 public:
209  // ===================================================================== //
210  // Feel free to add custom code below this line, it will be preserved by
211  // the code generator.
212  //
213  // Just remember to:
214  // - Close the class declaration with };
215  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
216  // - Close the include guard with #endif
217  // ===================================================================== //
218  // --(BEGIN CUSTOM CODE)--
219 };
220 
221 PXR_NAMESPACE_CLOSE_SCOPE
222 
223 #endif
UsdPhysicsCollisionAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsCollisionAPI on UsdPrim prim .
Definition: collisionAPI.h:73
static USDPHYSICS_API UsdPhysicsCollisionAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
USDPHYSICS_API UsdRelationship CreateSimulationOwnerRel() const
See GetSimulationOwnerRel(), and also Create vs Get Property Methods for when to use Get vs Create.
The base class for all API schemas.
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
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.
Single Apply API schema.
USDPHYSICS_API UsdAttribute GetCollisionEnabledAttr() const
Determines if the PhysicsCollisionAPI is enabled.
Applies collision attributes to a UsdGeomXformable prim.
Definition: collisionAPI.h:61
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
USDPHYSICS_API UsdAttribute CreateCollisionEnabledAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCollisionEnabledAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDPHYSICS_API UsdRelationship GetSimulationOwnerRel() const
Single PhysicsScene that will simulate this collider.
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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
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...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: collisionAPI.h:67
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
static USDPHYSICS_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
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...
virtual USDPHYSICS_API ~UsdPhysicsCollisionAPI()
Destructor.
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...
UsdPhysicsCollisionAPI(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsCollisionAPI on the prim held by schemaObj .
Definition: collisionAPI.h:81