All Classes Files Functions Variables Pages
physxVehicleContextAPI.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_PHYSXVEHICLECONTEXTAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXVEHICLECONTEXTAPI_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 // PHYSXVEHICLECONTEXTAPI //
51 // -------------------------------------------------------------------------- //
52 
62 class PhysxSchemaPhysxVehicleContextAPI : public UsdAPISchemaBase
63 {
64 public:
68  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
69 
74  explicit PhysxSchemaPhysxVehicleContextAPI(const UsdPrim& prim=UsdPrim())
75  : UsdAPISchemaBase(prim)
76  {
77  }
78 
82  explicit PhysxSchemaPhysxVehicleContextAPI(const UsdSchemaBase& schemaObj)
83  : UsdAPISchemaBase(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 
111 
128  PHYSXSCHEMA_API
129  static bool
130  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
131 
147  PHYSXSCHEMA_API
149  Apply(const UsdPrim &prim);
150 
151 protected:
155  PHYSXSCHEMA_API
156  UsdSchemaKind _GetSchemaKind() const override;
157 
158 private:
159  // needs to invoke _GetStaticTfType.
160  friend class UsdSchemaRegistry;
161  PHYSXSCHEMA_API
162  static const TfType &_GetStaticTfType();
163 
164  static bool _IsTypedSchema();
165 
166  // override SchemaBase virtuals.
167  PHYSXSCHEMA_API
168  const TfType &_GetTfType() const override;
169 
170 public:
171  // --------------------------------------------------------------------- //
172  // UPDATEMODE
173  // --------------------------------------------------------------------- //
184  PHYSXSCHEMA_API
185  UsdAttribute GetUpdateModeAttr() const;
186 
192  PHYSXSCHEMA_API
193  UsdAttribute CreateUpdateModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
194 
195 public:
196  // --------------------------------------------------------------------- //
197  // UPAXIS
198  // --------------------------------------------------------------------- //
212  PHYSXSCHEMA_API
213  UsdAttribute GetUpAxisAttr() const;
214 
220  PHYSXSCHEMA_API
221  UsdAttribute CreateUpAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
222 
223 public:
224  // --------------------------------------------------------------------- //
225  // FORWARDAXIS
226  // --------------------------------------------------------------------- //
240  PHYSXSCHEMA_API
241  UsdAttribute GetForwardAxisAttr() const;
242 
248  PHYSXSCHEMA_API
249  UsdAttribute CreateForwardAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
250 
251 public:
252  // --------------------------------------------------------------------- //
253  // VERTICALAXIS
254  // --------------------------------------------------------------------- //
268  PHYSXSCHEMA_API
269  UsdAttribute GetVerticalAxisAttr() const;
270 
276  PHYSXSCHEMA_API
277  UsdAttribute CreateVerticalAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
278 
279 public:
280  // --------------------------------------------------------------------- //
281  // LONGITUDINALAXIS
282  // --------------------------------------------------------------------- //
296  PHYSXSCHEMA_API
297  UsdAttribute GetLongitudinalAxisAttr() const;
298 
304  PHYSXSCHEMA_API
305  UsdAttribute CreateLongitudinalAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
306 
307 public:
308  // ===================================================================== //
309  // Feel free to add custom code below this line, it will be preserved by
310  // the code generator.
311  //
312  // Just remember to:
313  // - Close the class declaration with };
314  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
315  // - Close the include guard with #endif
316  // ===================================================================== //
317  // --(BEGIN CUSTOM CODE)--
318 };
319 
320 PXR_NAMESPACE_CLOSE_SCOPE
321 
322 #endif
PHYSXSCHEMA_API UsdAttribute GetVerticalAxisAttr() const
The axis defining the general up direction to use for vehicles.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute CreateLongitudinalAxisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLongitudinalAxisAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateForwardAxisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetForwardAxisAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateUpdateModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetUpdateModeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetLongitudinalAxisAttr() const
The axis defining the general forward direction to use for vehicles.
PHYSXSCHEMA_API UsdAttribute GetUpdateModeAttr() const
The dynamics of the vehicle simulation can get applied to the PhysX rigid body by either applying an ...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleContextAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute CreateVerticalAxisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVerticalAxisAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysxSchemaPhysxVehicleContextAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxVehicleContextAPI on the prim held by schemaObj .
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleContextAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
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.
PHYSXSCHEMA_API UsdAttribute GetUpAxisAttr() const
Deprecated.
PHYSXSCHEMA_API UsdAttribute CreateUpAxisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetUpAxisAttr(), 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 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 GetForwardAxisAttr() const
Deprecated.
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleContextAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxVehicleContextAPI holding the prim adhering to this schema at path on stage...
PhysX vehicles general settings.
PhysxSchemaPhysxVehicleContextAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxVehicleContextAPI on UsdPrim prim .