All Classes Files Functions Variables Pages
physxSceneQuasistaticAPI.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_PHYSXSCENEQUASISTATICAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXSCENEQUASISTATICAPI_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  #include "pxr/usd/usd/collectionAPI.h"
36 
37 #include "pxr/base/vt/value.h"
38 
39 #include "pxr/base/gf/vec3d.h"
40 #include "pxr/base/gf/vec3f.h"
41 #include "pxr/base/gf/matrix4d.h"
42 
43 #include "pxr/base/tf/token.h"
44 #include "pxr/base/tf/type.h"
45 
46 PXR_NAMESPACE_OPEN_SCOPE
47 
48 class SdfAssetPath;
49 
50 // -------------------------------------------------------------------------- //
51 // PHYSXSCENEQUASISTATICAPI //
52 // -------------------------------------------------------------------------- //
53 
70 class PhysxSchemaPhysxSceneQuasistaticAPI : public UsdAPISchemaBase
71 {
72 public:
76  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
77 
82  explicit PhysxSchemaPhysxSceneQuasistaticAPI(const UsdPrim& prim=UsdPrim())
83  : UsdAPISchemaBase(prim)
84  {
85  }
86 
90  explicit PhysxSchemaPhysxSceneQuasistaticAPI(const UsdSchemaBase& schemaObj)
91  : UsdAPISchemaBase(schemaObj)
92  {
93  }
94 
96  PHYSXSCHEMA_API
98 
102  PHYSXSCHEMA_API
103  static const TfTokenVector &
104  GetSchemaAttributeNames(bool includeInherited=true);
105 
115  PHYSXSCHEMA_API
117  Get(const UsdStagePtr &stage, const SdfPath &path);
118 
119 
136  PHYSXSCHEMA_API
137  static bool
138  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
139 
155  PHYSXSCHEMA_API
157  Apply(const UsdPrim &prim);
158 
159 protected:
163  PHYSXSCHEMA_API
164  UsdSchemaKind _GetSchemaKind() const override;
165 
166 private:
167  // needs to invoke _GetStaticTfType.
168  friend class UsdSchemaRegistry;
169  PHYSXSCHEMA_API
170  static const TfType &_GetStaticTfType();
171 
172  static bool _IsTypedSchema();
173 
174  // override SchemaBase virtuals.
175  PHYSXSCHEMA_API
176  const TfType &_GetTfType() const override;
177 
178 public:
179  // --------------------------------------------------------------------- //
180  // ENABLEQUASISTATIC
181  // --------------------------------------------------------------------- //
189  PHYSXSCHEMA_API
190  UsdAttribute GetEnableQuasistaticAttr() const;
191 
197  PHYSXSCHEMA_API
198  UsdAttribute CreateEnableQuasistaticAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
199 
200 public:
201  // ===================================================================== //
202  // Feel free to add custom code below this line, it will be preserved by
203  // the code generator.
204  //
205  // Just remember to:
206  // - Close the class declaration with };
207  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
208  // - Close the include guard with #endif
209  // ===================================================================== //
210  // --(BEGIN CUSTOM CODE)--
211 
214  PHYSXSCHEMA_API
215  UsdCollectionAPI GetQuasistaticActorsCollectionAPI() const;
216 };
217 
218 PXR_NAMESPACE_CLOSE_SCOPE
219 
220 #endif
static PHYSXSCHEMA_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.
PhysxSceneQuasistaticAPI defines quasistatic mode for simulation.
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...
static PHYSXSCHEMA_API PhysxSchemaPhysxSceneQuasistaticAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxSceneQuasistaticAPI holding the prim adhering to this schema at path on stag...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxSceneQuasistaticAPI()
Destructor.
PHYSXSCHEMA_API UsdCollectionAPI GetQuasistaticActorsCollectionAPI() const
Return the UsdCollectionAPI interface used for defining what prims belong to the quasistatic API...
PhysxSchemaPhysxSceneQuasistaticAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxSceneQuasistaticAPI on UsdPrim prim .
PhysxSchemaPhysxSceneQuasistaticAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxSceneQuasistaticAPI on the prim held by schemaObj .
PHYSXSCHEMA_API UsdAttribute GetEnableQuasistaticAttr() const
Whether the actors should behave quasistatic or not.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute CreateEnableQuasistaticAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEnableQuasistaticAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static PHYSXSCHEMA_API PhysxSchemaPhysxSceneQuasistaticAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.