All Classes Files Functions Variables Pages
physxVehicleWheelControllerAPI.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_PHYSXVEHICLEWHEELCONTROLLERAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXVEHICLEWHEELCONTROLLERAPI_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 // PHYSXVEHICLEWHEELCONTROLLERAPI //
51 // -------------------------------------------------------------------------- //
52 
57 class PhysxSchemaPhysxVehicleWheelControllerAPI : public UsdAPISchemaBase
58 {
59 public:
63  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
64 
69  explicit PhysxSchemaPhysxVehicleWheelControllerAPI(const UsdPrim& prim=UsdPrim())
70  : UsdAPISchemaBase(prim)
71  {
72  }
73 
77  explicit PhysxSchemaPhysxVehicleWheelControllerAPI(const UsdSchemaBase& schemaObj)
78  : UsdAPISchemaBase(schemaObj)
79  {
80  }
81 
83  PHYSXSCHEMA_API
85 
89  PHYSXSCHEMA_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  PHYSXSCHEMA_API
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
106 
121  PHYSXSCHEMA_API
123  Apply(const UsdPrim &prim);
124 
125 protected:
129  PHYSXSCHEMA_API
130  UsdSchemaType _GetSchemaType() const override;
131 
132 private:
133  // needs to invoke _GetStaticTfType.
134  friend class UsdSchemaRegistry;
135  PHYSXSCHEMA_API
136  static const TfType &_GetStaticTfType();
137 
138  static bool _IsTypedSchema();
139 
140  // override SchemaBase virtuals.
141  PHYSXSCHEMA_API
142  const TfType &_GetTfType() const override;
143 
144 public:
145  // --------------------------------------------------------------------- //
146  // DRIVETORQUE
147  // --------------------------------------------------------------------- //
155  PHYSXSCHEMA_API
156  UsdAttribute GetDriveTorqueAttr() const;
157 
163  PHYSXSCHEMA_API
164  UsdAttribute CreateDriveTorqueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
165 
166 public:
167  // --------------------------------------------------------------------- //
168  // BRAKETORQUE
169  // --------------------------------------------------------------------- //
178  PHYSXSCHEMA_API
179  UsdAttribute GetBrakeTorqueAttr() const;
180 
186  PHYSXSCHEMA_API
187  UsdAttribute CreateBrakeTorqueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
188 
189 public:
190  // --------------------------------------------------------------------- //
191  // STEERANGLE
192  // --------------------------------------------------------------------- //
200  PHYSXSCHEMA_API
201  UsdAttribute GetSteerAngleAttr() const;
202 
208  PHYSXSCHEMA_API
209  UsdAttribute CreateSteerAngleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
210 
211 public:
212  // ===================================================================== //
213  // Feel free to add custom code below this line, it will be preserved by
214  // the code generator.
215  //
216  // Just remember to:
217  // - Close the class declaration with };
218  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
219  // - Close the include guard with #endif
220  // ===================================================================== //
221  // --(BEGIN CUSTOM CODE)--
222 };
223 
224 PXR_NAMESPACE_CLOSE_SCOPE
225 
226 #endif
PhysxSchemaPhysxVehicleWheelControllerAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxVehicleWheelControllerAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute GetDriveTorqueAttr() const
Torque to increase wheel angular rate and speed up (units: mass * distance * distance / seconds / sec...
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleWheelControllerAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PhysX wheel controller that samples user input and allows direct control of the wheel torques and ste...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute GetBrakeTorqueAttr() const
Torque to decrease wheel angular rate and slow down (units: mass * distance * distance / seconds / se...
PHYSXSCHEMA_API UsdAttribute CreateBrakeTorqueAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBrakeTorqueAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleWheelControllerAPI()
Destructor.
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleWheelControllerAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxVehicleWheelControllerAPI holding the prim adhering to this schema at path o...
PHYSXSCHEMA_API UsdAttribute CreateSteerAngleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSteerAngleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateDriveTorqueAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDriveTorqueAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
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 UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PhysxSchemaPhysxVehicleWheelControllerAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxVehicleWheelControllerAPI on the prim held by schemaObj ...
PHYSXSCHEMA_API UsdAttribute GetSteerAngleAttr() const
Steer angle of the wheel in radians.