All Classes Files Functions Variables Pages
collisionGroup.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_COLLISIONGROUP_H
25 #define USDPHYSICS_GENERATED_COLLISIONGROUP_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "usdPhysics/api.h"
31 #include "pxr/usd/usd/typed.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "usdPhysics/tokens.h"
35 
36 #include "pxr/usd/usd/collectionAPI.h"
37 
38 #include "pxr/base/vt/value.h"
39 
40 #include "pxr/base/gf/vec3d.h"
41 #include "pxr/base/gf/vec3f.h"
42 #include "pxr/base/gf/matrix4d.h"
43 
44 #include "pxr/base/tf/token.h"
45 #include "pxr/base/tf/type.h"
46 
47 PXR_NAMESPACE_OPEN_SCOPE
48 
49 class SdfAssetPath;
50 
51 // -------------------------------------------------------------------------- //
52 // PHYSICSCOLLISIONGROUP //
53 // -------------------------------------------------------------------------- //
54 
67 class UsdPhysicsCollisionGroup : public UsdTyped
68 {
69 public:
73  static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped;
74 
79  explicit UsdPhysicsCollisionGroup(const UsdPrim& prim=UsdPrim())
80  : UsdTyped(prim)
81  {
82  }
83 
87  explicit UsdPhysicsCollisionGroup(const UsdSchemaBase& schemaObj)
88  : UsdTyped(schemaObj)
89  {
90  }
91 
93  USDPHYSICS_API
94  virtual ~UsdPhysicsCollisionGroup();
95 
99  USDPHYSICS_API
100  static const TfTokenVector &
101  GetSchemaAttributeNames(bool includeInherited=true);
102 
112  USDPHYSICS_API
114  Get(const UsdStagePtr &stage, const SdfPath &path);
115 
138  USDPHYSICS_API
140  Define(const UsdStagePtr &stage, const SdfPath &path);
141 
142 protected:
146  USDPHYSICS_API
147  UsdSchemaType _GetSchemaType() const override;
148 
149 private:
150  // needs to invoke _GetStaticTfType.
151  friend class UsdSchemaRegistry;
152  USDPHYSICS_API
153  static const TfType &_GetStaticTfType();
154 
155  static bool _IsTypedSchema();
156 
157  // override SchemaBase virtuals.
158  USDPHYSICS_API
159  const TfType &_GetTfType() const override;
160 
161 public:
162  // --------------------------------------------------------------------- //
163  // FILTEREDGROUPS
164  // --------------------------------------------------------------------- //
168  USDPHYSICS_API
169  UsdRelationship GetFilteredGroupsRel() const;
170 
173  USDPHYSICS_API
174  UsdRelationship CreateFilteredGroupsRel() const;
175 
176 public:
177  // ===================================================================== //
178  // Feel free to add custom code below this line, it will be preserved by
179  // the code generator.
180  //
181  // Just remember to:
182  // - Close the class declaration with };
183  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
184  // - Close the include guard with #endif
185  // ===================================================================== //
186  // --(BEGIN CUSTOM CODE)--
187 
190  USDPHYSICS_API
191  UsdCollectionAPI GetCollidersCollectionAPI() const;
192 };
193 
194 PXR_NAMESPACE_CLOSE_SCOPE
195 
196 #endif
USDPHYSICS_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
Defines a collision group for coarse filtering.
UsdPhysicsCollisionGroup(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsCollisionGroup on the prim held by schemaObj .
USDPHYSICS_API UsdRelationship GetFilteredGroupsRel() const
References a list of PhysicsCollisionGroups with which collisions should be ignored.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
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...
USDPHYSICS_API UsdRelationship CreateFilteredGroupsRel() const
See GetFilteredGroupsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static USDPHYSICS_API UsdPhysicsCollisionGroup Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsCollisionGroup holding the prim adhering to this schema at path on stage...
UsdPhysicsCollisionGroup(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsCollisionGroup on UsdPrim prim .
USDPHYSICS_API UsdCollectionAPI GetCollidersCollectionAPI() const
Return the UsdCollectionAPI interface used for defining what colliders belong to the CollisionGroup...
static USDPHYSICS_API UsdPhysicsCollisionGroup Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
virtual USDPHYSICS_API ~UsdPhysicsCollisionGroup()
Destructor.