All Classes Files Functions Variables Pages
physxVehicleSteeringAPI.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_PHYSXVEHICLESTEERINGAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXVEHICLESTEERINGAPI_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 // PHYSXVEHICLESTEERINGAPI //
51 // -------------------------------------------------------------------------- //
52 
61 class PhysxSchemaPhysxVehicleSteeringAPI : public UsdAPISchemaBase
62 {
63 public:
67  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
68 
73  explicit PhysxSchemaPhysxVehicleSteeringAPI(const UsdPrim& prim=UsdPrim())
74  : UsdAPISchemaBase(prim)
75  {
76  }
77 
81  explicit PhysxSchemaPhysxVehicleSteeringAPI(const UsdSchemaBase& schemaObj)
82  : UsdAPISchemaBase(schemaObj)
83  {
84  }
85 
87  PHYSXSCHEMA_API
89 
93  PHYSXSCHEMA_API
94  static const TfTokenVector &
95  GetSchemaAttributeNames(bool includeInherited=true);
96 
106  PHYSXSCHEMA_API
108  Get(const UsdStagePtr &stage, const SdfPath &path);
109 
110 
125  PHYSXSCHEMA_API
127  Apply(const UsdPrim &prim);
128 
129 protected:
133  PHYSXSCHEMA_API
134  UsdSchemaType _GetSchemaType() const override;
135 
136 private:
137  // needs to invoke _GetStaticTfType.
138  friend class UsdSchemaRegistry;
139  PHYSXSCHEMA_API
140  static const TfType &_GetStaticTfType();
141 
142  static bool _IsTypedSchema();
143 
144  // override SchemaBase virtuals.
145  PHYSXSCHEMA_API
146  const TfType &_GetTfType() const override;
147 
148 public:
149  // --------------------------------------------------------------------- //
150  // WHEELS
151  // --------------------------------------------------------------------- //
162  PHYSXSCHEMA_API
163  UsdAttribute GetWheelsAttr() const;
164 
170  PHYSXSCHEMA_API
171  UsdAttribute CreateWheelsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
172 
173 public:
174  // --------------------------------------------------------------------- //
175  // MAXSTEERANGLE
176  // --------------------------------------------------------------------- //
187  PHYSXSCHEMA_API
188  UsdAttribute GetMaxSteerAngleAttr() const;
189 
195  PHYSXSCHEMA_API
196  UsdAttribute CreateMaxSteerAngleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
197 
198 public:
199  // --------------------------------------------------------------------- //
200  // ANGLEMULTIPLIERS
201  // --------------------------------------------------------------------- //
213  PHYSXSCHEMA_API
214  UsdAttribute GetAngleMultipliersAttr() const;
215 
221  PHYSXSCHEMA_API
222  UsdAttribute CreateAngleMultipliersAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
223 
224 public:
225  // ===================================================================== //
226  // Feel free to add custom code below this line, it will be preserved by
227  // the code generator.
228  //
229  // Just remember to:
230  // - Close the class declaration with };
231  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
232  // - Close the include guard with #endif
233  // ===================================================================== //
234  // --(BEGIN CUSTOM CODE)--
235 };
236 
237 PXR_NAMESPACE_CLOSE_SCOPE
238 
239 #endif
PhysxSchemaPhysxVehicleSteeringAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxVehicleSteeringAPI on the prim held by schemaObj .
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleSteeringAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute GetMaxSteerAngleAttr() const
The maximum steer angle (in radians) that can be achieved by the wheels.
PHYSXSCHEMA_API UsdAttribute CreateAngleMultipliersAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAngleMultipliersAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetWheelsAttr() const
List of indices, referencing the wheels that are going to be steered.
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleSteeringAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxVehicleSteeringAPI holding the prim adhering to this schema at path on stage...
PHYSXSCHEMA_API UsdAttribute CreateWheelsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetWheelsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PhysxSchemaPhysxVehicleSteeringAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxVehicleSteeringAPI on UsdPrim prim .
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleSteeringAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
Describes a steering system for a vehicle by specifying which wheels are connected to the steer contr...
PHYSXSCHEMA_API UsdAttribute CreateMaxSteerAngleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxSteerAngleAttr(), 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.
PHYSXSCHEMA_API UsdAttribute GetAngleMultipliersAttr() const
Allows to adjust the max steer angle for each wheel that is steered.