All Classes Files Functions Variables Pages
physxVehicleSuspensionComplianceAPI.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_PHYSXVEHICLESUSPENSIONCOMPLIANCEAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXVEHICLESUSPENSIONCOMPLIANCEAPI_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 // PHYSXVEHICLESUSPENSIONCOMPLIANCEAPI //
51 // -------------------------------------------------------------------------- //
52 
72 class PhysxSchemaPhysxVehicleSuspensionComplianceAPI : public UsdAPISchemaBase
73 {
74 public:
78  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
79 
84  explicit PhysxSchemaPhysxVehicleSuspensionComplianceAPI(const UsdPrim& prim=UsdPrim())
85  : UsdAPISchemaBase(prim)
86  {
87  }
88 
92  explicit PhysxSchemaPhysxVehicleSuspensionComplianceAPI(const UsdSchemaBase& schemaObj)
93  : UsdAPISchemaBase(schemaObj)
94  {
95  }
96 
98  PHYSXSCHEMA_API
100 
104  PHYSXSCHEMA_API
105  static const TfTokenVector &
106  GetSchemaAttributeNames(bool includeInherited=true);
107 
117  PHYSXSCHEMA_API
119  Get(const UsdStagePtr &stage, const SdfPath &path);
120 
121 
136  PHYSXSCHEMA_API
138  Apply(const UsdPrim &prim);
139 
140 protected:
144  PHYSXSCHEMA_API
145  UsdSchemaType _GetSchemaType() const override;
146 
147 private:
148  // needs to invoke _GetStaticTfType.
149  friend class UsdSchemaRegistry;
150  PHYSXSCHEMA_API
151  static const TfType &_GetStaticTfType();
152 
153  static bool _IsTypedSchema();
154 
155  // override SchemaBase virtuals.
156  PHYSXSCHEMA_API
157  const TfType &_GetTfType() const override;
158 
159 public:
160  // --------------------------------------------------------------------- //
161  // WHEELTOEANGLE
162  // --------------------------------------------------------------------- //
174  PHYSXSCHEMA_API
175  UsdAttribute GetWheelToeAngleAttr() const;
176 
182  PHYSXSCHEMA_API
183  UsdAttribute CreateWheelToeAngleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
184 
185 public:
186  // --------------------------------------------------------------------- //
187  // WHEELCAMBERANGLE
188  // --------------------------------------------------------------------- //
200  PHYSXSCHEMA_API
201  UsdAttribute GetWheelCamberAngleAttr() const;
202 
208  PHYSXSCHEMA_API
209  UsdAttribute CreateWheelCamberAngleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
210 
211 public:
212  // --------------------------------------------------------------------- //
213  // SUSPENSIONFORCEAPPPOINT
214  // --------------------------------------------------------------------- //
227  PHYSXSCHEMA_API
228  UsdAttribute GetSuspensionForceAppPointAttr() const;
229 
235  PHYSXSCHEMA_API
236  UsdAttribute CreateSuspensionForceAppPointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
237 
238 public:
239  // --------------------------------------------------------------------- //
240  // TIREFORCEAPPPOINT
241  // --------------------------------------------------------------------- //
254  PHYSXSCHEMA_API
255  UsdAttribute GetTireForceAppPointAttr() const;
256 
262  PHYSXSCHEMA_API
263  UsdAttribute CreateTireForceAppPointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
264 
265 public:
266  // ===================================================================== //
267  // Feel free to add custom code below this line, it will be preserved by
268  // the code generator.
269  //
270  // Just remember to:
271  // - Close the class declaration with };
272  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
273  // - Close the include guard with #endif
274  // ===================================================================== //
275  // --(BEGIN CUSTOM CODE)--
276 };
277 
278 PXR_NAMESPACE_CLOSE_SCOPE
279 
280 #endif
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleSuspensionComplianceAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxVehicleSuspensionComplianceAPI holding the prim adhering to this schema at p...
PhysxSchemaPhysxVehicleSuspensionComplianceAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxVehicleSuspensionComplianceAPI on the prim held by schemaObj ...
PHYSXSCHEMA_API UsdAttribute GetTireForceAppPointAttr() const
Tire forces are applied at an offset from the suspension frame (see PhysxVehicleWheelAttachmentAPI).
PHYSXSCHEMA_API UsdAttribute CreateWheelToeAngleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetWheelToeAngleAttr(), 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.
Compliance describes how toe and camber angle and force application points are affected by suspension...
PhysxSchemaPhysxVehicleSuspensionComplianceAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxVehicleSuspensionComplianceAPI on UsdPrim prim .
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 CreateSuspensionForceAppPointAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSuspensionForceAppPointAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Crea...
PHYSXSCHEMA_API UsdAttribute CreateTireForceAppPointAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTireForceAppPointAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleSuspensionComplianceAPI()
Destructor.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleSuspensionComplianceAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute GetWheelCamberAngleAttr() const
A graph of camber angle against normalized jounce with the camber angle expressed in radians in the r...
PHYSXSCHEMA_API UsdAttribute CreateWheelCamberAngleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetWheelCamberAngleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetSuspensionForceAppPointAttr() const
Suspension forces are applied at an offset from the suspension frame (see PhysxVehicleWheelAttachment...
PHYSXSCHEMA_API UsdAttribute GetWheelToeAngleAttr() const
A graph of toe angle against normalized jounce with the toe angle expressed in radians in the range [...