All Classes Files Functions Variables Pages
physxTriggerStateAPI.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_PHYSXTRIGGERSTATEAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXTRIGGERSTATEAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//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 ".//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 // PHYSXTRIGGERSTATEAPI //
51 // -------------------------------------------------------------------------- //
52 
57 class PhysxSchemaPhysxTriggerStateAPI : public UsdAPISchemaBase
58 {
59 public:
63  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
64 
69  explicit PhysxSchemaPhysxTriggerStateAPI(const UsdPrim& prim=UsdPrim())
70  : UsdAPISchemaBase(prim)
71  {
72  }
73 
77  explicit PhysxSchemaPhysxTriggerStateAPI(const UsdSchemaBase& schemaObj)
78  : UsdAPISchemaBase(schemaObj)
79  {
80  }
81 
83  PHYSXSCHEMA_API
85 
89  PHYSXSCHEMA_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  PHYSXSCHEMA_API
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
106 
121  PHYSXSCHEMA_API
123  Apply(const UsdPrim &prim);
124 
125 protected:
129  PHYSXSCHEMA_API
130  UsdSchemaType _GetSchemaType() const override;
131 
132 private:
133  // needs to invoke _GetStaticTfType.
134  friend class UsdSchemaRegistry;
135  PHYSXSCHEMA_API
136  static const TfType &_GetStaticTfType();
137 
138  static bool _IsTypedSchema();
139 
140  // override SchemaBase virtuals.
141  PHYSXSCHEMA_API
142  const TfType &_GetTfType() const override;
143 
144 public:
145  // --------------------------------------------------------------------- //
146  // TRIGGEREDCOLLISIONS
147  // --------------------------------------------------------------------- //
150  PHYSXSCHEMA_API
151  UsdRelationship GetTriggeredCollisionsRel() const;
152 
155  PHYSXSCHEMA_API
156  UsdRelationship CreateTriggeredCollisionsRel() const;
157 
158 public:
159  // ===================================================================== //
160  // Feel free to add custom code below this line, it will be preserved by
161  // the code generator.
162  //
163  // Just remember to:
164  // - Close the class declaration with };
165  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
166  // - Close the include guard with #endif
167  // ===================================================================== //
168  // --(BEGIN CUSTOM CODE)--
169 };
170 
171 PXR_NAMESPACE_CLOSE_SCOPE
172 
173 #endif
PhysxSchemaPhysxTriggerStateAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxTriggerStateAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdRelationship GetTriggeredCollisionsRel() const
List of collisions that are currently triggered.
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PhysxSchemaPhysxTriggerStateAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxTriggerStateAPI on the prim held by schemaObj .
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxTriggerStateAPI()
Destructor.
static PHYSXSCHEMA_API PhysxSchemaPhysxTriggerStateAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxTriggerStateAPI holding the prim adhering to this schema at path on stage...
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 UsdRelationship CreateTriggeredCollisionsRel() const
See GetTriggeredCollisionsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static PHYSXSCHEMA_API PhysxSchemaPhysxTriggerStateAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.