All Classes Files Functions Variables Pages
physxVehicleTireAPI.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_PHYSXVEHICLETIREAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXVEHICLETIREAPI_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 // PHYSXVEHICLETIREAPI //
51 // -------------------------------------------------------------------------- //
52 
60 class PhysxSchemaPhysxVehicleTireAPI : public UsdAPISchemaBase
61 {
62 public:
66  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
67 
72  explicit PhysxSchemaPhysxVehicleTireAPI(const UsdPrim& prim=UsdPrim())
73  : UsdAPISchemaBase(prim)
74  {
75  }
76 
80  explicit PhysxSchemaPhysxVehicleTireAPI(const UsdSchemaBase& schemaObj)
81  : UsdAPISchemaBase(schemaObj)
82  {
83  }
84 
86  PHYSXSCHEMA_API
88 
92  PHYSXSCHEMA_API
93  static const TfTokenVector &
94  GetSchemaAttributeNames(bool includeInherited=true);
95 
105  PHYSXSCHEMA_API
107  Get(const UsdStagePtr &stage, const SdfPath &path);
108 
109 
124  PHYSXSCHEMA_API
126  Apply(const UsdPrim &prim);
127 
128 protected:
132  PHYSXSCHEMA_API
133  UsdSchemaType _GetSchemaType() const override;
134 
135 private:
136  // needs to invoke _GetStaticTfType.
137  friend class UsdSchemaRegistry;
138  PHYSXSCHEMA_API
139  static const TfType &_GetStaticTfType();
140 
141  static bool _IsTypedSchema();
142 
143  // override SchemaBase virtuals.
144  PHYSXSCHEMA_API
145  const TfType &_GetTfType() const override;
146 
147 public:
148  // --------------------------------------------------------------------- //
149  // LATSTIFFX
150  // --------------------------------------------------------------------- //
164  PHYSXSCHEMA_API
165  UsdAttribute GetLatStiffXAttr() const;
166 
172  PHYSXSCHEMA_API
173  UsdAttribute CreateLatStiffXAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
174 
175 public:
176  // --------------------------------------------------------------------- //
177  // LATSTIFFY
178  // --------------------------------------------------------------------- //
195  PHYSXSCHEMA_API
196  UsdAttribute GetLatStiffYAttr() const;
197 
203  PHYSXSCHEMA_API
204  UsdAttribute CreateLatStiffYAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
205 
206 public:
207  // --------------------------------------------------------------------- //
208  // LATERALSTIFFNESSGRAPH
209  // --------------------------------------------------------------------- //
225  PHYSXSCHEMA_API
226  UsdAttribute GetLateralStiffnessGraphAttr() const;
227 
233  PHYSXSCHEMA_API
234  UsdAttribute CreateLateralStiffnessGraphAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
235 
236 public:
237  // --------------------------------------------------------------------- //
238  // LONGITUDINALSTIFFNESSPERUNITGRAVITY
239  // --------------------------------------------------------------------- //
254  PHYSXSCHEMA_API
255  UsdAttribute GetLongitudinalStiffnessPerUnitGravityAttr() const;
256 
262  PHYSXSCHEMA_API
263  UsdAttribute CreateLongitudinalStiffnessPerUnitGravityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
264 
265 public:
266  // --------------------------------------------------------------------- //
267  // LONGITUDINALSTIFFNESS
268  // --------------------------------------------------------------------- //
281  PHYSXSCHEMA_API
282  UsdAttribute GetLongitudinalStiffnessAttr() const;
283 
289  PHYSXSCHEMA_API
290  UsdAttribute CreateLongitudinalStiffnessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
291 
292 public:
293  // --------------------------------------------------------------------- //
294  // CAMBERSTIFFNESSPERUNITGRAVITY
295  // --------------------------------------------------------------------- //
308  PHYSXSCHEMA_API
309  UsdAttribute GetCamberStiffnessPerUnitGravityAttr() const;
310 
316  PHYSXSCHEMA_API
317  UsdAttribute CreateCamberStiffnessPerUnitGravityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
318 
319 public:
320  // --------------------------------------------------------------------- //
321  // CAMBERSTIFFNESS
322  // --------------------------------------------------------------------- //
335  PHYSXSCHEMA_API
336  UsdAttribute GetCamberStiffnessAttr() const;
337 
343  PHYSXSCHEMA_API
344  UsdAttribute CreateCamberStiffnessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
345 
346 public:
347  // --------------------------------------------------------------------- //
348  // FRICTIONVSSLIPGRAPH
349  // --------------------------------------------------------------------- //
368  PHYSXSCHEMA_API
369  UsdAttribute GetFrictionVsSlipGraphAttr() const;
370 
376  PHYSXSCHEMA_API
377  UsdAttribute CreateFrictionVsSlipGraphAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
378 
379 public:
380  // --------------------------------------------------------------------- //
381  // RESTLOAD
382  // --------------------------------------------------------------------- //
397  PHYSXSCHEMA_API
398  UsdAttribute GetRestLoadAttr() const;
399 
405  PHYSXSCHEMA_API
406  UsdAttribute CreateRestLoadAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
407 
408 public:
409  // --------------------------------------------------------------------- //
410  // FRICTIONTABLE
411  // --------------------------------------------------------------------- //
416  PHYSXSCHEMA_API
417  UsdRelationship GetFrictionTableRel() const;
418 
421  PHYSXSCHEMA_API
422  UsdRelationship CreateFrictionTableRel() const;
423 
424 public:
425  // ===================================================================== //
426  // Feel free to add custom code below this line, it will be preserved by
427  // the code generator.
428  //
429  // Just remember to:
430  // - Close the class declaration with };
431  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
432  // - Close the include guard with #endif
433  // ===================================================================== //
434  // --(BEGIN CUSTOM CODE)--
435 };
436 
437 PXR_NAMESPACE_CLOSE_SCOPE
438 
439 #endif
PHYSXSCHEMA_API UsdAttribute CreateFrictionVsSlipGraphAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFrictionVsSlipGraphAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetRestLoadAttr() const
The load that develops on the tire when the vehicle is at rest on a flat plane (units: force = mass *...
Properties of a PhysX vehicle tire.
PHYSXSCHEMA_API UsdAttribute CreateLatStiffYAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLatStiffYAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetCamberStiffnessPerUnitGravityAttr() const
Deprecated.
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleTireAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxVehicleTireAPI holding the prim adhering to this schema at path on stage...
PHYSXSCHEMA_API UsdAttribute GetLongitudinalStiffnessAttr() const
Tire longitudinal stiffness (units: mass * distance / seconds / seconds).
PhysxSchemaPhysxVehicleTireAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxVehicleTireAPI on UsdPrim prim .
PhysxSchemaPhysxVehicleTireAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxVehicleTireAPI on the prim held by schemaObj .
PHYSXSCHEMA_API UsdAttribute GetLatStiffYAttr() const
Deprecated.
PHYSXSCHEMA_API UsdAttribute GetLongitudinalStiffnessPerUnitGravityAttr() const
Deprecated.
PHYSXSCHEMA_API UsdAttribute GetLateralStiffnessGraphAttr() const
Tire lateral stiffness is represented as a graph of tire load that has linear behavior near zero load...
PHYSXSCHEMA_API UsdAttribute GetCamberStiffnessAttr() const
Tire camber stiffness (units: mass * distance / seconds / seconds / radians).
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 CreateCamberStiffnessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCamberStiffnessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateCamberStiffnessPerUnitGravityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCamberStiffnessPerUnitGravityAttr(), and also Usd_Create_Or_Get_Property for when to use Get v...
PHYSXSCHEMA_API UsdAttribute CreateLongitudinalStiffnessPerUnitGravityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLongitudinalStiffnessPerUnitGravityAttr(), and also Usd_Create_Or_Get_Property for when to use...
PHYSXSCHEMA_API UsdAttribute GetFrictionVsSlipGraphAttr() const
Graph of friction vs longitudinal slip with 3 points.
PHYSXSCHEMA_API UsdRelationship GetFrictionTableRel() const
A relationship to a PhysxVehicleTireFrictionTable instance.
PHYSXSCHEMA_API UsdAttribute CreateRestLoadAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestLoadAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdRelationship CreateFrictionTableRel() const
See GetFrictionTableRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute CreateLatStiffXAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLatStiffXAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute GetLatStiffXAttr() const
Deprecated.
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleTireAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateLongitudinalStiffnessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLongitudinalStiffnessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleTireAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute CreateLateralStiffnessGraphAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLateralStiffnessGraphAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...