All Classes Files Functions Variables Pages
physxVehicleControllerAPI.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_PHYSXVEHICLECONTROLLERAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXVEHICLECONTROLLERAPI_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 // PHYSXVEHICLECONTROLLERAPI //
51 // -------------------------------------------------------------------------- //
52 
57 class PhysxSchemaPhysxVehicleControllerAPI : public UsdAPISchemaBase
58 {
59 public:
63  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
64 
69  explicit PhysxSchemaPhysxVehicleControllerAPI(const UsdPrim& prim=UsdPrim())
70  : UsdAPISchemaBase(prim)
71  {
72  }
73 
77  explicit PhysxSchemaPhysxVehicleControllerAPI(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  // ACCELERATOR
147  // --------------------------------------------------------------------- //
155  PHYSXSCHEMA_API
156  UsdAttribute GetAcceleratorAttr() const;
157 
163  PHYSXSCHEMA_API
164  UsdAttribute CreateAcceleratorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
165 
166 public:
167  // --------------------------------------------------------------------- //
168  // BRAKE0
169  // --------------------------------------------------------------------- //
179  PHYSXSCHEMA_API
180  UsdAttribute GetBrake0Attr() const;
181 
187  PHYSXSCHEMA_API
188  UsdAttribute CreateBrake0Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189 
190 public:
191  // --------------------------------------------------------------------- //
192  // BRAKE1
193  // --------------------------------------------------------------------- //
203  PHYSXSCHEMA_API
204  UsdAttribute GetBrake1Attr() const;
205 
211  PHYSXSCHEMA_API
212  UsdAttribute CreateBrake1Attr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
213 
214 public:
215  // --------------------------------------------------------------------- //
216  // BRAKE
217  // --------------------------------------------------------------------- //
227  PHYSXSCHEMA_API
228  UsdAttribute GetBrakeAttr() const;
229 
235  PHYSXSCHEMA_API
236  UsdAttribute CreateBrakeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
237 
238 public:
239  // --------------------------------------------------------------------- //
240  // HANDBRAKE
241  // --------------------------------------------------------------------- //
251  PHYSXSCHEMA_API
252  UsdAttribute GetHandbrakeAttr() const;
253 
259  PHYSXSCHEMA_API
260  UsdAttribute CreateHandbrakeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
261 
262 public:
263  // --------------------------------------------------------------------- //
264  // STEER
265  // --------------------------------------------------------------------- //
275  PHYSXSCHEMA_API
276  UsdAttribute GetSteerAttr() const;
277 
283  PHYSXSCHEMA_API
284  UsdAttribute CreateSteerAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
285 
286 public:
287  // --------------------------------------------------------------------- //
288  // STEERLEFT
289  // --------------------------------------------------------------------- //
299  PHYSXSCHEMA_API
300  UsdAttribute GetSteerLeftAttr() const;
301 
307  PHYSXSCHEMA_API
308  UsdAttribute CreateSteerLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
309 
310 public:
311  // --------------------------------------------------------------------- //
312  // STEERRIGHT
313  // --------------------------------------------------------------------- //
323  PHYSXSCHEMA_API
324  UsdAttribute GetSteerRightAttr() const;
325 
331  PHYSXSCHEMA_API
332  UsdAttribute CreateSteerRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
333 
334 public:
335  // --------------------------------------------------------------------- //
336  // TARGETGEAR
337  // --------------------------------------------------------------------- //
352  PHYSXSCHEMA_API
353  UsdAttribute GetTargetGearAttr() const;
354 
360  PHYSXSCHEMA_API
361  UsdAttribute CreateTargetGearAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
362 
363 public:
364  // ===================================================================== //
365  // Feel free to add custom code below this line, it will be preserved by
366  // the code generator.
367  //
368  // Just remember to:
369  // - Close the class declaration with };
370  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
371  // - Close the include guard with #endif
372  // ===================================================================== //
373  // --(BEGIN CUSTOM CODE)--
374 };
375 
376 PXR_NAMESPACE_CLOSE_SCOPE
377 
378 #endif
PHYSXSCHEMA_API UsdAttribute GetAcceleratorAttr() const
Driven vehicle.
PhysX vehicle controller that samples user input to drive the vehicle.
PHYSXSCHEMA_API UsdAttribute GetSteerAttr() const
Steer control for the steering system (see PhysxVehicleSteeringAPI).
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 GetSteerRightAttr() const
Deprecated.
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleControllerAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateHandbrakeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHandbrakeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateBrake1Attr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBrake1Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PHYSXSCHEMA_API UsdAttribute GetTargetGearAttr() const
Driven vehicle.
PHYSXSCHEMA_API UsdAttribute CreateBrakeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBrakeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PHYSXSCHEMA_API UsdAttribute GetBrake0Attr() const
Brake control for braking system "brakes0" (see PhysxVehicleBrakesAPI) that triggers the connected br...
PHYSXSCHEMA_API UsdAttribute GetHandbrakeAttr() const
Deprecated.
PhysxSchemaPhysxVehicleControllerAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxVehicleControllerAPI on the prim held by schemaObj .
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleControllerAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxVehicleControllerAPI holding the prim adhering to this schema at path on sta...
PHYSXSCHEMA_API UsdAttribute CreateSteerRightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSteerRightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetBrake1Attr() const
Brake control for braking system "brakes1" (see PhysxVehicleBrakesAPI) that triggers the connected br...
PHYSXSCHEMA_API UsdAttribute CreateBrake0Attr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBrake0Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PHYSXSCHEMA_API UsdAttribute CreateSteerAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSteerAttr(), 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.
PHYSXSCHEMA_API UsdAttribute GetSteerLeftAttr() const
Deprecated.
PhysxSchemaPhysxVehicleControllerAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxVehicleControllerAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute GetBrakeAttr() const
Deprecated.
PHYSXSCHEMA_API UsdAttribute CreateAcceleratorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAcceleratorAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateTargetGearAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTargetGearAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute CreateSteerLeftAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSteerLeftAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleControllerAPI()
Destructor.