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 UsdSchemaKind schemaKind = UsdSchemaKind::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 
130  PHYSXSCHEMA_API
131  static bool
132  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
133 
149  PHYSXSCHEMA_API
151  Apply(const UsdPrim &prim);
152 
153 protected:
157  PHYSXSCHEMA_API
158  UsdSchemaKind _GetSchemaKind() const override;
159 
160 private:
161  // needs to invoke _GetStaticTfType.
162  friend class UsdSchemaRegistry;
163  PHYSXSCHEMA_API
164  static const TfType &_GetStaticTfType();
165 
166  static bool _IsTypedSchema();
167 
168  // override SchemaBase virtuals.
169  PHYSXSCHEMA_API
170  const TfType &_GetTfType() const override;
171 
172 public:
173  // --------------------------------------------------------------------- //
174  // VEHICLEENABLED
175  // --------------------------------------------------------------------- //
188  PHYSXSCHEMA_API
189  UsdAttribute GetVehicleEnabledAttr() const;
190 
196  PHYSXSCHEMA_API
197  UsdAttribute CreateVehicleEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
198 
199 public:
200  // --------------------------------------------------------------------- //
201  // SUSPENSIONLINEQUERYTYPE
202  // --------------------------------------------------------------------- //
214  PHYSXSCHEMA_API
215  UsdAttribute GetSuspensionLineQueryTypeAttr() const;
216 
222  PHYSXSCHEMA_API
223  UsdAttribute CreateSuspensionLineQueryTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
224 
225 public:
226  // --------------------------------------------------------------------- //
227  // LIMITSUSPENSIONEXPANSIONVELOCITY
228  // --------------------------------------------------------------------- //
246  PHYSXSCHEMA_API
247  UsdAttribute GetLimitSuspensionExpansionVelocityAttr() const;
248 
254  PHYSXSCHEMA_API
255  UsdAttribute CreateLimitSuspensionExpansionVelocityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
256 
257 public:
258  // --------------------------------------------------------------------- //
259  // SUBSTEPTHRESHOLDLONGITUDINALSPEED
260  // --------------------------------------------------------------------- //
272  PHYSXSCHEMA_API
273  UsdAttribute GetSubStepThresholdLongitudinalSpeedAttr() const;
274 
280  PHYSXSCHEMA_API
281  UsdAttribute CreateSubStepThresholdLongitudinalSpeedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
282 
283 public:
284  // --------------------------------------------------------------------- //
285  // LOWFORWARDSPEEDSUBSTEPCOUNT
286  // --------------------------------------------------------------------- //
297  PHYSXSCHEMA_API
298  UsdAttribute GetLowForwardSpeedSubStepCountAttr() const;
299 
305  PHYSXSCHEMA_API
306  UsdAttribute CreateLowForwardSpeedSubStepCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
307 
308 public:
309  // --------------------------------------------------------------------- //
310  // HIGHFORWARDSPEEDSUBSTEPCOUNT
311  // --------------------------------------------------------------------- //
322  PHYSXSCHEMA_API
323  UsdAttribute GetHighForwardSpeedSubStepCountAttr() const;
324 
330  PHYSXSCHEMA_API
331  UsdAttribute CreateHighForwardSpeedSubStepCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
332 
333 public:
334  // --------------------------------------------------------------------- //
335  // MINLONGITUDINALSLIPDENOMINATOR
336  // --------------------------------------------------------------------- //
353  PHYSXSCHEMA_API
354  UsdAttribute GetMinLongitudinalSlipDenominatorAttr() const;
355 
361  PHYSXSCHEMA_API
362  UsdAttribute CreateMinLongitudinalSlipDenominatorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
363 
364 public:
365  // --------------------------------------------------------------------- //
366  // MINPASSIVELONGITUDINALSLIPDENOMINATOR
367  // --------------------------------------------------------------------- //
383  PHYSXSCHEMA_API
385 
391  PHYSXSCHEMA_API
392  UsdAttribute CreateMinPassiveLongitudinalSlipDenominatorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
393 
394 public:
395  // --------------------------------------------------------------------- //
396  // MINACTIVELONGITUDINALSLIPDENOMINATOR
397  // --------------------------------------------------------------------- //
413  PHYSXSCHEMA_API
414  UsdAttribute GetMinActiveLongitudinalSlipDenominatorAttr() const;
415 
421  PHYSXSCHEMA_API
422  UsdAttribute CreateMinActiveLongitudinalSlipDenominatorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
423 
424 public:
425  // --------------------------------------------------------------------- //
426  // MINLATERALSLIPDENOMINATOR
427  // --------------------------------------------------------------------- //
443  PHYSXSCHEMA_API
444  UsdAttribute GetMinLateralSlipDenominatorAttr() const;
445 
451  PHYSXSCHEMA_API
452  UsdAttribute CreateMinLateralSlipDenominatorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
453 
454 public:
455  // --------------------------------------------------------------------- //
456  // LONGITUDINALSTICKYTIRETHRESHOLDSPEED
457  // --------------------------------------------------------------------- //
475  PHYSXSCHEMA_API
476  UsdAttribute GetLongitudinalStickyTireThresholdSpeedAttr() const;
477 
483  PHYSXSCHEMA_API
484  UsdAttribute CreateLongitudinalStickyTireThresholdSpeedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
485 
486 public:
487  // --------------------------------------------------------------------- //
488  // LONGITUDINALSTICKYTIRETHRESHOLDTIME
489  // --------------------------------------------------------------------- //
501  PHYSXSCHEMA_API
502  UsdAttribute GetLongitudinalStickyTireThresholdTimeAttr() const;
503 
509  PHYSXSCHEMA_API
510  UsdAttribute CreateLongitudinalStickyTireThresholdTimeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
511 
512 public:
513  // --------------------------------------------------------------------- //
514  // LONGITUDINALSTICKYTIREDAMPING
515  // --------------------------------------------------------------------- //
529  PHYSXSCHEMA_API
530  UsdAttribute GetLongitudinalStickyTireDampingAttr() const;
531 
537  PHYSXSCHEMA_API
538  UsdAttribute CreateLongitudinalStickyTireDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
539 
540 public:
541  // --------------------------------------------------------------------- //
542  // LATERALSTICKYTIRETHRESHOLDSPEED
543  // --------------------------------------------------------------------- //
556  PHYSXSCHEMA_API
557  UsdAttribute GetLateralStickyTireThresholdSpeedAttr() const;
558 
564  PHYSXSCHEMA_API
565  UsdAttribute CreateLateralStickyTireThresholdSpeedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
566 
567 public:
568  // --------------------------------------------------------------------- //
569  // LATERALSTICKYTIRETHRESHOLDTIME
570  // --------------------------------------------------------------------- //
579  PHYSXSCHEMA_API
580  UsdAttribute GetLateralStickyTireThresholdTimeAttr() const;
581 
587  PHYSXSCHEMA_API
588  UsdAttribute CreateLateralStickyTireThresholdTimeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
589 
590 public:
591  // --------------------------------------------------------------------- //
592  // LATERALSTICKYTIREDAMPING
593  // --------------------------------------------------------------------- //
605  PHYSXSCHEMA_API
606  UsdAttribute GetLateralStickyTireDampingAttr() const;
607 
613  PHYSXSCHEMA_API
614  UsdAttribute CreateLateralStickyTireDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
615 
616 public:
617  // --------------------------------------------------------------------- //
618  // DRIVE
619  // --------------------------------------------------------------------- //
625  PHYSXSCHEMA_API
626  UsdRelationship GetDriveRel() const;
627 
630  PHYSXSCHEMA_API
631  UsdRelationship CreateDriveRel() const;
632 
633 public:
634  // ===================================================================== //
635  // Feel free to add custom code below this line, it will be preserved by
636  // the code generator.
637  //
638  // Just remember to:
639  // - Close the class declaration with };
640  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
641  // - Close the include guard with #endif
642  // ===================================================================== //
643  // --(BEGIN CUSTOM CODE)--
644 };
645 
646 PXR_NAMESPACE_CLOSE_SCOPE
647 
648 #endif
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...
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 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 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 GetLimitSuspensionExpansionVelocityAttr() const
Limit the suspension expansion dynamics.
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...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
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 CreateLimitSuspensionExpansionVelocityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLimitSuspensionExpansionVelocityAttr(), and also Usd_Create_Or_Get_Property for when to use Ge...
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...
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 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.