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 
63 class PhysxSchemaPhysxPhysicsAttachment : public UsdTyped
64 {
65 public:
69  static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
70 
75  explicit PhysxSchemaPhysxPhysicsAttachment(const UsdPrim& prim=UsdPrim())
76  : UsdTyped(prim)
77  {
78  }
79 
83  explicit PhysxSchemaPhysxPhysicsAttachment(const UsdSchemaBase& schemaObj)
84  : UsdTyped(schemaObj)
85  {
86  }
87 
89  PHYSXSCHEMA_API
91 
95  PHYSXSCHEMA_API
96  static const TfTokenVector &
97  GetSchemaAttributeNames(bool includeInherited=true);
98 
108  PHYSXSCHEMA_API
110  Get(const UsdStagePtr &stage, const SdfPath &path);
111 
134  PHYSXSCHEMA_API
136  Define(const UsdStagePtr &stage, const SdfPath &path);
137 
138 protected:
142  PHYSXSCHEMA_API
143  UsdSchemaKind _GetSchemaKind() const override;
144 
145 private:
146  // needs to invoke _GetStaticTfType.
147  friend class UsdSchemaRegistry;
148  PHYSXSCHEMA_API
149  static const TfType &_GetStaticTfType();
150 
151  static bool _IsTypedSchema();
152 
153  // override SchemaBase virtuals.
154  PHYSXSCHEMA_API
155  const TfType &_GetTfType() const override;
156 
157 public:
158  // --------------------------------------------------------------------- //
159  // ATTACHMENTENABLED
160  // --------------------------------------------------------------------- //
169  PHYSXSCHEMA_API
170  UsdAttribute GetAttachmentEnabledAttr() const;
171 
177  PHYSXSCHEMA_API
178  UsdAttribute CreateAttachmentEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
179 
180 public:
181  // --------------------------------------------------------------------- //
182  // POINTS0
183  // --------------------------------------------------------------------- //
192  PHYSXSCHEMA_API
193  UsdAttribute GetPoints0Attr() const;
194 
200  PHYSXSCHEMA_API
201  UsdAttribute CreatePoints0Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
202 
203 public:
204  // --------------------------------------------------------------------- //
205  // POINTS1
206  // --------------------------------------------------------------------- //
215  PHYSXSCHEMA_API
216  UsdAttribute GetPoints1Attr() const;
217 
223  PHYSXSCHEMA_API
224  UsdAttribute CreatePoints1Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
225 
226 public:
227  // --------------------------------------------------------------------- //
228  // COLLISIONFILTERINDICES0
229  // --------------------------------------------------------------------- //
238  PHYSXSCHEMA_API
239  UsdAttribute GetCollisionFilterIndices0Attr() const;
240 
246  PHYSXSCHEMA_API
247  UsdAttribute CreateCollisionFilterIndices0Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
248 
249 public:
250  // --------------------------------------------------------------------- //
251  // FILTERTYPE0
252  // --------------------------------------------------------------------- //
263  PHYSXSCHEMA_API
264  UsdAttribute GetFilterType0Attr() const;
265 
271  PHYSXSCHEMA_API
272  UsdAttribute CreateFilterType0Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
273 
274 public:
275  // --------------------------------------------------------------------- //
276  // COLLISIONFILTERINDICES1
277  // --------------------------------------------------------------------- //
286  PHYSXSCHEMA_API
287  UsdAttribute GetCollisionFilterIndices1Attr() const;
288 
294  PHYSXSCHEMA_API
295  UsdAttribute CreateCollisionFilterIndices1Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
296 
297 public:
298  // --------------------------------------------------------------------- //
299  // FILTERTYPE1
300  // --------------------------------------------------------------------- //
311  PHYSXSCHEMA_API
312  UsdAttribute GetFilterType1Attr() const;
313 
319  PHYSXSCHEMA_API
320  UsdAttribute CreateFilterType1Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
321 
322 public:
323  // --------------------------------------------------------------------- //
324  // ACTOR0
325  // --------------------------------------------------------------------- //
329  PHYSXSCHEMA_API
330  UsdRelationship GetActor0Rel() const;
331 
334  PHYSXSCHEMA_API
335  UsdRelationship CreateActor0Rel() const;
336 
337 public:
338  // --------------------------------------------------------------------- //
339  // ACTOR1
340  // --------------------------------------------------------------------- //
344  PHYSXSCHEMA_API
345  UsdRelationship GetActor1Rel() const;
346 
349  PHYSXSCHEMA_API
350  UsdRelationship CreateActor1Rel() const;
351 
352 public:
353  // ===================================================================== //
354  // Feel free to add custom code below this line, it will be preserved by
355  // the code generator.
356  //
357  // Just remember to:
358  // - Close the class declaration with };
359  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
360  // - Close the include guard with #endif
361  // ===================================================================== //
362  // --(BEGIN CUSTOM CODE)--
363 
364 public:
365 
368  PHYSXSCHEMA_API
369  UsdAttribute GetPointsAttr(int index) const;
370 
373  PHYSXSCHEMA_API
374  UsdAttribute GetCollisionFilterIndicesAttr(int index) const;
375 
378  PHYSXSCHEMA_API
379  UsdAttribute GetFilterTypeAttr(int index) const;
380 
383  PHYSXSCHEMA_API
384  UsdRelationship GetActorRel(int index) const;
385 
386 };
387 
388 PXR_NAMESPACE_CLOSE_SCOPE
389 
390 #endif
PHYSXSCHEMA_API UsdAttribute GetFilterType1Attr() const
Deprecated: Will be replaced by a new deformable schema in a future release.
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
Deprecated: Will be replaced by a new deformable schema in a future release.
PHYSXSCHEMA_API UsdAttribute GetCollisionFilterIndices1Attr() const
Deprecated: Will be replaced by a new deformable schema in a future release.
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 UsdRelationship GetActor0Rel() const
Deprecated: Will be replaced by a new deformable schema in a future release.
PHYSXSCHEMA_API UsdAttribute GetFilterTypeAttr(int index) const
Helper attribute access via index in [0,1].
PHYSXSCHEMA_API UsdAttribute GetAttachmentEnabledAttr() const
Deprecated: Will be replaced by a new deformable schema in a future release.
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
Deprecated: Will be replaced by a new deformable schema in a future release.
PHYSXSCHEMA_API UsdAttribute GetCollisionFilterIndicesAttr(int index) const
Helper attribute access via index in [0,1].
PHYSXSCHEMA_API UsdAttribute GetCollisionFilterIndices0Attr() const
Deprecated: Will be replaced by a new deformable schema in a future release.
PHYSXSCHEMA_API UsdAttribute GetPoints0Attr() const
Deprecated: Will be replaced by a new deformable schema in a future release.
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...
Deprecated: Will be replaced by a new deformable schema in a future release.
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
Deprecated: Will be replaced by a new deformable schema in a future release.
PhysxSchemaPhysxPhysicsAttachment(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxPhysicsAttachment on the prim held by schemaObj .
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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.