All Classes Files Functions Variables Pages
physxVehicleTankDifferentialAPI.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_PHYSXVEHICLETANKDIFFERENTIALAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXVEHICLETANKDIFFERENTIALAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.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 // PHYSXVEHICLETANKDIFFERENTIALAPI //
51 // -------------------------------------------------------------------------- //
52 
63 {
64 public:
68  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
69 
74  explicit PhysxSchemaPhysxVehicleTankDifferentialAPI(const UsdPrim& prim=UsdPrim())
76  {
77  }
78 
82  explicit PhysxSchemaPhysxVehicleTankDifferentialAPI(const UsdSchemaBase& schemaObj)
84  {
85  }
86 
88  PHYSXSCHEMA_API
90 
94  PHYSXSCHEMA_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  PHYSXSCHEMA_API
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
111 
126  PHYSXSCHEMA_API
128  Apply(const UsdPrim &prim);
129 
130 protected:
134  PHYSXSCHEMA_API
135  UsdSchemaType _GetSchemaType() const override;
136 
137 private:
138  // needs to invoke _GetStaticTfType.
139  friend class UsdSchemaRegistry;
140  PHYSXSCHEMA_API
141  static const TfType &_GetStaticTfType();
142 
143  static bool _IsTypedSchema();
144 
145  // override SchemaBase virtuals.
146  PHYSXSCHEMA_API
147  const TfType &_GetTfType() const override;
148 
149 public:
150  // --------------------------------------------------------------------- //
151  // NUMBEROFWHEELSPERTRACK
152  // --------------------------------------------------------------------- //
161  PHYSXSCHEMA_API
162  UsdAttribute GetNumberOfWheelsPerTrackAttr() const;
163 
169  PHYSXSCHEMA_API
170  UsdAttribute CreateNumberOfWheelsPerTrackAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
171 
172 public:
173  // --------------------------------------------------------------------- //
174  // THRUSTINDEXPERTRACK
175  // --------------------------------------------------------------------- //
185  PHYSXSCHEMA_API
186  UsdAttribute GetThrustIndexPerTrackAttr() const;
187 
193  PHYSXSCHEMA_API
194  UsdAttribute CreateThrustIndexPerTrackAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
195 
196 public:
197  // --------------------------------------------------------------------- //
198  // TRACKTOWHEELINDICES
199  // --------------------------------------------------------------------- //
210  PHYSXSCHEMA_API
211  UsdAttribute GetTrackToWheelIndicesAttr() const;
212 
218  PHYSXSCHEMA_API
219  UsdAttribute CreateTrackToWheelIndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
220 
221 public:
222  // --------------------------------------------------------------------- //
223  // WHEELINDICESINTRACKORDER
224  // --------------------------------------------------------------------- //
235  PHYSXSCHEMA_API
236  UsdAttribute GetWheelIndicesInTrackOrderAttr() const;
237 
243  PHYSXSCHEMA_API
244  UsdAttribute CreateWheelIndicesInTrackOrderAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
245 
246 public:
247  // ===================================================================== //
248  // Feel free to add custom code below this line, it will be preserved by
249  // the code generator.
250  //
251  // Just remember to:
252  // - Close the class declaration with };
253  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
254  // - Close the include guard with #endif
255  // ===================================================================== //
256  // --(BEGIN CUSTOM CODE)--
257 };
258 
259 PXR_NAMESPACE_CLOSE_SCOPE
260 
261 #endif
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleTankDifferentialAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxVehicleTankDifferentialAPI holding the prim adhering to this schema at path ...
PHYSXSCHEMA_API UsdAttribute GetTrackToWheelIndicesAttr() const
For each track, this array holds the start index of the list describing the wheels that are assigned ...
PHYSXSCHEMA_API UsdAttribute CreateWheelIndicesInTrackOrderAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetWheelIndicesInTrackOrderAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Cre...
PHYSXSCHEMA_API UsdAttribute CreateThrustIndexPerTrackAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetThrustIndexPerTrackAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
Describes which wheels of a vehicle are driven as well as the distribution of the drive torque among ...
Differential to set up a wheeled tank vehicle.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleTankDifferentialAPI()
Destructor.
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...
PhysxSchemaPhysxVehicleTankDifferentialAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxVehicleTankDifferentialAPI on UsdPrim prim .
PhysxSchemaPhysxVehicleTankDifferentialAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxVehicleTankDifferentialAPI on the prim held by schemaObj ...
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute GetWheelIndicesInTrackOrderAttr() const
The wheels (identified by wheel attachment indices, see attribtue "index" of PhysxVehicleWheelAttachm...
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleTankDifferentialAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute GetThrustIndexPerTrackAttr() const
For each track, this array holds the index of the thrust control (0 or 1, see PhysxVehicleTankControl...
PHYSXSCHEMA_API UsdAttribute CreateTrackToWheelIndicesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTrackToWheelIndicesAttr(), 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 GetNumberOfWheelsPerTrackAttr() const
For each track, this array holds the number of wheels assigned to that track.
PHYSXSCHEMA_API UsdAttribute CreateNumberOfWheelsPerTrackAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetNumberOfWheelsPerTrackAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Creat...