All Classes Files Functions Variables Pages
physxPhysicsAttachment.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_PHYSXPHYSICSATTACHMENT_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXPHYSICSATTACHMENT_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//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 ".//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 // PHYSXPHYSICSATTACHMENT //
51 // -------------------------------------------------------------------------- //
52 
62 class PhysxSchemaPhysxPhysicsAttachment : public UsdTyped
63 {
64 public:
68  static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped;
69 
74  explicit PhysxSchemaPhysxPhysicsAttachment(const UsdPrim& prim=UsdPrim())
75  : UsdTyped(prim)
76  {
77  }
78 
82  explicit PhysxSchemaPhysxPhysicsAttachment(const UsdSchemaBase& schemaObj)
83  : UsdTyped(schemaObj)
84  {
85  }
86 
88  PHYSXSCHEMA_API
90 
94  PHYSXSCHEMA_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  PHYSXSCHEMA_API
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
133  PHYSXSCHEMA_API
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  // ATTACHMENTENABLED
159  // --------------------------------------------------------------------- //
167  PHYSXSCHEMA_API
168  UsdAttribute GetAttachmentEnabledAttr() const;
169 
175  PHYSXSCHEMA_API
176  UsdAttribute CreateAttachmentEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
177 
178 public:
179  // --------------------------------------------------------------------- //
180  // POINTS0
181  // --------------------------------------------------------------------- //
189  PHYSXSCHEMA_API
190  UsdAttribute GetPoints0Attr() const;
191 
197  PHYSXSCHEMA_API
198  UsdAttribute CreatePoints0Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
199 
200 public:
201  // --------------------------------------------------------------------- //
202  // POINTS1
203  // --------------------------------------------------------------------- //
211  PHYSXSCHEMA_API
212  UsdAttribute GetPoints1Attr() const;
213 
219  PHYSXSCHEMA_API
220  UsdAttribute CreatePoints1Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
221 
222 public:
223  // --------------------------------------------------------------------- //
224  // COLLISIONFILTERINDICES0
225  // --------------------------------------------------------------------- //
233  PHYSXSCHEMA_API
234  UsdAttribute GetCollisionFilterIndices0Attr() const;
235 
241  PHYSXSCHEMA_API
242  UsdAttribute CreateCollisionFilterIndices0Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
243 
244 public:
245  // --------------------------------------------------------------------- //
246  // FILTERTYPE0
247  // --------------------------------------------------------------------- //
257  PHYSXSCHEMA_API
258  UsdAttribute GetFilterType0Attr() const;
259 
265  PHYSXSCHEMA_API
266  UsdAttribute CreateFilterType0Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
267 
268 public:
269  // --------------------------------------------------------------------- //
270  // COLLISIONFILTERINDICES1
271  // --------------------------------------------------------------------- //
279  PHYSXSCHEMA_API
280  UsdAttribute GetCollisionFilterIndices1Attr() const;
281 
287  PHYSXSCHEMA_API
288  UsdAttribute CreateCollisionFilterIndices1Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
289 
290 public:
291  // --------------------------------------------------------------------- //
292  // FILTERTYPE1
293  // --------------------------------------------------------------------- //
303  PHYSXSCHEMA_API
304  UsdAttribute GetFilterType1Attr() const;
305 
311  PHYSXSCHEMA_API
312  UsdAttribute CreateFilterType1Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
313 
314 public:
315  // --------------------------------------------------------------------- //
316  // ACTOR0
317  // --------------------------------------------------------------------- //
320  PHYSXSCHEMA_API
321  UsdRelationship GetActor0Rel() const;
322 
325  PHYSXSCHEMA_API
326  UsdRelationship CreateActor0Rel() const;
327 
328 public:
329  // --------------------------------------------------------------------- //
330  // ACTOR1
331  // --------------------------------------------------------------------- //
334  PHYSXSCHEMA_API
335  UsdRelationship GetActor1Rel() const;
336 
339  PHYSXSCHEMA_API
340  UsdRelationship CreateActor1Rel() const;
341 
342 public:
343  // ===================================================================== //
344  // Feel free to add custom code below this line, it will be preserved by
345  // the code generator.
346  //
347  // Just remember to:
348  // - Close the class declaration with };
349  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
350  // - Close the include guard with #endif
351  // ===================================================================== //
352  // --(BEGIN CUSTOM CODE)--
353 
354 public:
355 
358  PHYSXSCHEMA_API
359  UsdAttribute GetPointsAttr(int index) const;
360 
363  PHYSXSCHEMA_API
364  UsdAttribute GetCollisionFilterIndicesAttr(int index) const;
365 
368  PHYSXSCHEMA_API
369  UsdAttribute GetFilterTypeAttr(int index) const;
370 
373  PHYSXSCHEMA_API
374  UsdRelationship GetActorRel(int index) const;
375 
376 };
377 
378 PXR_NAMESPACE_CLOSE_SCOPE
379 
380 #endif
PHYSXSCHEMA_API UsdAttribute GetFilterType1Attr() const
Specify if indices in collisionFilterIndices1 correspond to vertices; or mesh cell-geometry, i.e.
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 UsdAttribute GetFilterType0Attr() const
Specify if indices in collisionFilterIndices0 correspond to vertices; or mesh cell-geometry, i.e.
PHYSXSCHEMA_API UsdAttribute GetCollisionFilterIndices1Attr() const
Indices to mesh triangle/tet/hex/etc.
PHYSXSCHEMA_API UsdAttribute CreateCollisionFilterIndices0Attr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCollisionFilterIndices0Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Crea...
static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsAttachment 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 CreateFilterType1Attr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFilterType1Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxPhysicsAttachment()
Destructor.
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PHYSXSCHEMA_API UsdRelationship GetActor0Rel() const
Reference to the first actor.
PHYSXSCHEMA_API UsdAttribute GetFilterTypeAttr(int index) const
Helper attribute access via index in [0,1].
PHYSXSCHEMA_API UsdAttribute GetAttachmentEnabledAttr() const
Enable or disable the attachment.
PHYSXSCHEMA_API UsdRelationship CreateActor1Rel() const
See GetActor1Rel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PHYSXSCHEMA_API UsdRelationship CreateActor0Rel() const
See GetActor0Rel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PHYSXSCHEMA_API UsdAttribute CreatePoints1Attr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPoints1Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PHYSXSCHEMA_API UsdAttribute CreateFilterType0Attr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFilterType0Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetPoints1Attr() const
Attachment points in Actor 1 local space, defined in the actor's rest state, if it is deformable...
PHYSXSCHEMA_API UsdAttribute GetCollisionFilterIndicesAttr(int index) const
Helper attribute access via index in [0,1].
PHYSXSCHEMA_API UsdAttribute GetCollisionFilterIndices0Attr() const
Indices to geometry of Actor 0 that should not generate collisions with Actor 1 as specified by filte...
PHYSXSCHEMA_API UsdAttribute GetPoints0Attr() const
Attachment points in Actor 0 local space, defined in the actor's rest state, if it is deformable...
static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsAttachment Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxPhysicsAttachment holding the prim adhering to this schema at path on stage...
Represents attachments between physics actors, for example, between a rigid body and a deformable bod...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute CreateAttachmentEnabledAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAttachmentEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdRelationship GetActor1Rel() const
Reference to the second actor.
PhysxSchemaPhysxPhysicsAttachment(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxPhysicsAttachment on the prim held by schemaObj .
PHYSXSCHEMA_API UsdRelationship GetActorRel(int index) const
Helper attribute access via index in [0,1].
PHYSXSCHEMA_API UsdAttribute GetPointsAttr(int index) const
Helper attribute access via index in [0,1].
PhysxSchemaPhysxPhysicsAttachment(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxPhysicsAttachment on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreateCollisionFilterIndices1Attr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCollisionFilterIndices1Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Crea...
PHYSXSCHEMA_API UsdAttribute CreatePoints0Attr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPoints0Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.