All Classes Files Functions Variables Pages
physxVehicleAPI.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_PHYSXVEHICLEAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXVEHICLEAPI_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 // PHYSXVEHICLEAPI //
51 // -------------------------------------------------------------------------- //
52 
64 class PhysxSchemaPhysxVehicleAPI : public UsdAPISchemaBase
65 {
66 public:
70  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
71 
76  explicit PhysxSchemaPhysxVehicleAPI(const UsdPrim& prim=UsdPrim())
77  : UsdAPISchemaBase(prim)
78  {
79  }
80 
84  explicit PhysxSchemaPhysxVehicleAPI(const UsdSchemaBase& schemaObj)
85  : UsdAPISchemaBase(schemaObj)
86  {
87  }
88 
90  PHYSXSCHEMA_API
92 
96  PHYSXSCHEMA_API
97  static const TfTokenVector &
98  GetSchemaAttributeNames(bool includeInherited=true);
99 
109  PHYSXSCHEMA_API
111  Get(const UsdStagePtr &stage, const SdfPath &path);
112 
113 
128  PHYSXSCHEMA_API
130  Apply(const UsdPrim &prim);
131 
132 protected:
136  PHYSXSCHEMA_API
137  UsdSchemaType _GetSchemaType() const override;
138 
139 private:
140  // needs to invoke _GetStaticTfType.
141  friend class UsdSchemaRegistry;
142  PHYSXSCHEMA_API
143  static const TfType &_GetStaticTfType();
144 
145  static bool _IsTypedSchema();
146 
147  // override SchemaBase virtuals.
148  PHYSXSCHEMA_API
149  const TfType &_GetTfType() const override;
150 
151 public:
152  // --------------------------------------------------------------------- //
153  // VEHICLEENABLED
154  // --------------------------------------------------------------------- //
167  PHYSXSCHEMA_API
168  UsdAttribute GetVehicleEnabledAttr() const;
169 
175  PHYSXSCHEMA_API
176  UsdAttribute CreateVehicleEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
177 
178 public:
179  // --------------------------------------------------------------------- //
180  // SUSPENSIONLINEQUERYTYPE
181  // --------------------------------------------------------------------- //
193  PHYSXSCHEMA_API
194  UsdAttribute GetSuspensionLineQueryTypeAttr() const;
195 
201  PHYSXSCHEMA_API
202  UsdAttribute CreateSuspensionLineQueryTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
203 
204 public:
205  // --------------------------------------------------------------------- //
206  // SUBSTEPTHRESHOLDLONGITUDINALSPEED
207  // --------------------------------------------------------------------- //
219  PHYSXSCHEMA_API
220  UsdAttribute GetSubStepThresholdLongitudinalSpeedAttr() const;
221 
227  PHYSXSCHEMA_API
228  UsdAttribute CreateSubStepThresholdLongitudinalSpeedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
229 
230 public:
231  // --------------------------------------------------------------------- //
232  // LOWFORWARDSPEEDSUBSTEPCOUNT
233  // --------------------------------------------------------------------- //
244  PHYSXSCHEMA_API
245  UsdAttribute GetLowForwardSpeedSubStepCountAttr() const;
246 
252  PHYSXSCHEMA_API
253  UsdAttribute CreateLowForwardSpeedSubStepCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
254 
255 public:
256  // --------------------------------------------------------------------- //
257  // HIGHFORWARDSPEEDSUBSTEPCOUNT
258  // --------------------------------------------------------------------- //
269  PHYSXSCHEMA_API
270  UsdAttribute GetHighForwardSpeedSubStepCountAttr() const;
271 
277  PHYSXSCHEMA_API
278  UsdAttribute CreateHighForwardSpeedSubStepCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
279 
280 public:
281  // --------------------------------------------------------------------- //
282  // MINLONGITUDINALSLIPDENOMINATOR
283  // --------------------------------------------------------------------- //
300  PHYSXSCHEMA_API
301  UsdAttribute GetMinLongitudinalSlipDenominatorAttr() const;
302 
308  PHYSXSCHEMA_API
309  UsdAttribute CreateMinLongitudinalSlipDenominatorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
310 
311 public:
312  // --------------------------------------------------------------------- //
313  // MINPASSIVELONGITUDINALSLIPDENOMINATOR
314  // --------------------------------------------------------------------- //
330  PHYSXSCHEMA_API
332 
338  PHYSXSCHEMA_API
339  UsdAttribute CreateMinPassiveLongitudinalSlipDenominatorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
340 
341 public:
342  // --------------------------------------------------------------------- //
343  // MINACTIVELONGITUDINALSLIPDENOMINATOR
344  // --------------------------------------------------------------------- //
360  PHYSXSCHEMA_API
361  UsdAttribute GetMinActiveLongitudinalSlipDenominatorAttr() const;
362 
368  PHYSXSCHEMA_API
369  UsdAttribute CreateMinActiveLongitudinalSlipDenominatorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
370 
371 public:
372  // --------------------------------------------------------------------- //
373  // MINLATERALSLIPDENOMINATOR
374  // --------------------------------------------------------------------- //
390  PHYSXSCHEMA_API
391  UsdAttribute GetMinLateralSlipDenominatorAttr() const;
392 
398  PHYSXSCHEMA_API
399  UsdAttribute CreateMinLateralSlipDenominatorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
400 
401 public:
402  // --------------------------------------------------------------------- //
403  // LONGITUDINALSTICKYTIRETHRESHOLDSPEED
404  // --------------------------------------------------------------------- //
422  PHYSXSCHEMA_API
423  UsdAttribute GetLongitudinalStickyTireThresholdSpeedAttr() const;
424 
430  PHYSXSCHEMA_API
431  UsdAttribute CreateLongitudinalStickyTireThresholdSpeedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
432 
433 public:
434  // --------------------------------------------------------------------- //
435  // LONGITUDINALSTICKYTIRETHRESHOLDTIME
436  // --------------------------------------------------------------------- //
448  PHYSXSCHEMA_API
449  UsdAttribute GetLongitudinalStickyTireThresholdTimeAttr() const;
450 
456  PHYSXSCHEMA_API
457  UsdAttribute CreateLongitudinalStickyTireThresholdTimeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
458 
459 public:
460  // --------------------------------------------------------------------- //
461  // LONGITUDINALSTICKYTIREDAMPING
462  // --------------------------------------------------------------------- //
476  PHYSXSCHEMA_API
477  UsdAttribute GetLongitudinalStickyTireDampingAttr() const;
478 
484  PHYSXSCHEMA_API
485  UsdAttribute CreateLongitudinalStickyTireDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
486 
487 public:
488  // --------------------------------------------------------------------- //
489  // LATERALSTICKYTIRETHRESHOLDSPEED
490  // --------------------------------------------------------------------- //
503  PHYSXSCHEMA_API
504  UsdAttribute GetLateralStickyTireThresholdSpeedAttr() const;
505 
511  PHYSXSCHEMA_API
512  UsdAttribute CreateLateralStickyTireThresholdSpeedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
513 
514 public:
515  // --------------------------------------------------------------------- //
516  // LATERALSTICKYTIRETHRESHOLDTIME
517  // --------------------------------------------------------------------- //
526  PHYSXSCHEMA_API
527  UsdAttribute GetLateralStickyTireThresholdTimeAttr() const;
528 
534  PHYSXSCHEMA_API
535  UsdAttribute CreateLateralStickyTireThresholdTimeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
536 
537 public:
538  // --------------------------------------------------------------------- //
539  // LATERALSTICKYTIREDAMPING
540  // --------------------------------------------------------------------- //
552  PHYSXSCHEMA_API
553  UsdAttribute GetLateralStickyTireDampingAttr() const;
554 
560  PHYSXSCHEMA_API
561  UsdAttribute CreateLateralStickyTireDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
562 
563 public:
564  // --------------------------------------------------------------------- //
565  // DRIVE
566  // --------------------------------------------------------------------- //
572  PHYSXSCHEMA_API
573  UsdRelationship GetDriveRel() const;
574 
577  PHYSXSCHEMA_API
578  UsdRelationship CreateDriveRel() const;
579 
580 public:
581  // ===================================================================== //
582  // Feel free to add custom code below this line, it will be preserved by
583  // the code generator.
584  //
585  // Just remember to:
586  // - Close the class declaration with };
587  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
588  // - Close the include guard with #endif
589  // ===================================================================== //
590  // --(BEGIN CUSTOM CODE)--
591 };
592 
593 PXR_NAMESPACE_CLOSE_SCOPE
594 
595 #endif
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute CreateLateralStickyTireThresholdSpeedAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLateralStickyTireThresholdSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute CreateMinPassiveLongitudinalSlipDenominatorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMinPassiveLongitudinalSlipDenominatorAttr(), and also Usd_Create_Or_Get_Property for when to u...
PHYSXSCHEMA_API UsdAttribute GetHighForwardSpeedSubStepCountAttr() const
Number of sub-steps performed in the vehicle dynamics update for vehicles that have longitudinal spee...
PHYSXSCHEMA_API UsdRelationship CreateDriveRel() const
See GetDriveRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PHYSXSCHEMA_API UsdAttribute GetLowForwardSpeedSubStepCountAttr() const
Number of sub-steps performed in the vehicle dynamics update for vehicles that have longitudinal spee...
PHYSXSCHEMA_API UsdAttribute CreateMinActiveLongitudinalSlipDenominatorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMinActiveLongitudinalSlipDenominatorAttr(), and also Usd_Create_Or_Get_Property for when to us...
PHYSXSCHEMA_API UsdAttribute GetLateralStickyTireThresholdTimeAttr() const
The lateral sticky tire threshold time (in seconds).
PHYSXSCHEMA_API UsdAttribute CreateLongitudinalStickyTireDampingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLongitudinalStickyTireDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get v...
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateLateralStickyTireThresholdTimeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLateralStickyTireThresholdTimeAttr(), and also Usd_Create_Or_Get_Property for when to use Get ...
PHYSXSCHEMA_API UsdAttribute CreateLateralStickyTireDampingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLateralStickyTireDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Cre...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxVehicleAPI holding the prim adhering to this schema at path on stage...
PHYSXSCHEMA_API UsdAttribute CreateLowForwardSpeedSubStepCountAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLowForwardSpeedSubStepCountAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs ...
PHYSXSCHEMA_API UsdAttribute CreateSuspensionLineQueryTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSuspensionLineQueryTypeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Crea...
PHYSXSCHEMA_API UsdAttribute CreateLongitudinalStickyTireThresholdTimeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLongitudinalStickyTireThresholdTimeAttr(), and also Usd_Create_Or_Get_Property for when to use...
PHYSXSCHEMA_API UsdAttribute CreateSubStepThresholdLongitudinalSpeedAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSubStepThresholdLongitudinalSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use G...
PHYSXSCHEMA_API UsdAttribute CreateVehicleEnabledAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVehicleEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetSubStepThresholdLongitudinalSpeedAttr() const
Threshold speed that is used to categorize vehicle speed as low speed or high speed for choosing the ...
PHYSXSCHEMA_API UsdAttribute GetSuspensionLineQueryTypeAttr() const
Collision of the wheels with the ground surface is detected through scene queries along the suspensio...
PHYSXSCHEMA_API UsdAttribute CreateMinLongitudinalSlipDenominatorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMinLongitudinalSlipDenominatorAttr(), and also Usd_Create_Or_Get_Property for when to use Get ...
PHYSXSCHEMA_API UsdAttribute GetMinLateralSlipDenominatorAttr() const
The minimum denominator used in the lateral slip calculation (units: distance / seconds).
PHYSXSCHEMA_API UsdRelationship GetDriveRel() const
A relationship to a PhysxVehicleDriveBasicAPI or PhysxVehicleDriveStandardAPI prim that describes the...
PHYSXSCHEMA_API UsdAttribute CreateMinLateralSlipDenominatorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMinLateralSlipDenominatorAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Cr...
PHYSXSCHEMA_API UsdAttribute GetLongitudinalStickyTireThresholdSpeedAttr() const
The longitudinal sticky tire threshold speed (units: distance / seconds).
PHYSXSCHEMA_API UsdAttribute GetLateralStickyTireThresholdSpeedAttr() const
The lateral sticky tire threshold speed (units: distance / seconds).
PHYSXSCHEMA_API UsdAttribute GetMinActiveLongitudinalSlipDenominatorAttr() const
The minimum denominator used in the longitudinal slip calculation when a wheel experiences drive or b...
PhysxSchemaPhysxVehicleAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxVehicleAPI on the prim held by schemaObj .
PHYSXSCHEMA_API UsdAttribute GetLongitudinalStickyTireThresholdTimeAttr() const
The longitudinal sticky tire threshold time (in seconds).
PHYSXSCHEMA_API UsdAttribute CreateHighForwardSpeedSubStepCountAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHighForwardSpeedSubStepCountAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs...
PhysxSchemaPhysxVehicleAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxVehicleAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreateLongitudinalStickyTireThresholdSpeedAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLongitudinalStickyTireThresholdSpeedAttr(), and also Usd_Create_Or_Get_Property for when to us...
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 GetLongitudinalStickyTireDampingAttr() const
The longitudinal sticky tire damping (per seconds).
PHYSXSCHEMA_API UsdAttribute GetMinPassiveLongitudinalSlipDenominatorAttr() const
The minimum denominator used in the longitudinal slip calculation when a wheel experiences no drive a...
PHYSXSCHEMA_API UsdAttribute GetLateralStickyTireDampingAttr() const
The lateral sticky tire damping (per seconds).
PHYSXSCHEMA_API UsdAttribute GetMinLongitudinalSlipDenominatorAttr() const
Deprecated.
PHYSXSCHEMA_API UsdAttribute GetVehicleEnabledAttr() const
Defines whether the vehicle simulation update loop will run for the vehicle or not.