All Classes Files Functions Variables Pages
physxVehicleDriveBasicAPI.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_PHYSXVEHICLEDRIVEBASICAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXVEHICLEDRIVEBASICAPI_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 // PHYSXVEHICLEDRIVEBASICAPI //
51 // -------------------------------------------------------------------------- //
52 
63 class PhysxSchemaPhysxVehicleDriveBasicAPI : public UsdAPISchemaBase
64 {
65 public:
69  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
70 
75  explicit PhysxSchemaPhysxVehicleDriveBasicAPI(const UsdPrim& prim=UsdPrim())
76  : UsdAPISchemaBase(prim)
77  {
78  }
79 
83  explicit PhysxSchemaPhysxVehicleDriveBasicAPI(const UsdSchemaBase& schemaObj)
84  : UsdAPISchemaBase(schemaObj)
85  {
86  }
87 
89  PHYSXSCHEMA_API
91 
95  PHYSXSCHEMA_API
96  static const TfTokenVector &
97  GetSchemaAttributeNames(bool includeInherited=true);
98 
108  PHYSXSCHEMA_API
110  Get(const UsdStagePtr &stage, const SdfPath &path);
111 
112 
129  PHYSXSCHEMA_API
130  static bool
131  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
132 
148  PHYSXSCHEMA_API
150  Apply(const UsdPrim &prim);
151 
152 protected:
156  PHYSXSCHEMA_API
157  UsdSchemaKind _GetSchemaKind() const override;
158 
159 private:
160  // needs to invoke _GetStaticTfType.
161  friend class UsdSchemaRegistry;
162  PHYSXSCHEMA_API
163  static const TfType &_GetStaticTfType();
164 
165  static bool _IsTypedSchema();
166 
167  // override SchemaBase virtuals.
168  PHYSXSCHEMA_API
169  const TfType &_GetTfType() const override;
170 
171 public:
172  // --------------------------------------------------------------------- //
173  // PEAKTORQUE
174  // --------------------------------------------------------------------- //
195  PHYSXSCHEMA_API
196  UsdAttribute GetPeakTorqueAttr() const;
197 
203  PHYSXSCHEMA_API
204  UsdAttribute CreatePeakTorqueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
205 
206 public:
207  // ===================================================================== //
208  // Feel free to add custom code below this line, it will be preserved by
209  // the code generator.
210  //
211  // Just remember to:
212  // - Close the class declaration with };
213  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
214  // - Close the include guard with #endif
215  // ===================================================================== //
216  // --(BEGIN CUSTOM CODE)--
217 };
218 
219 PXR_NAMESPACE_CLOSE_SCOPE
220 
221 #endif
PhysxSchemaPhysxVehicleDriveBasicAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxVehicleDriveBasicAPI on UsdPrim prim .
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleDriveBasicAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute GetPeakTorqueAttr() const
Maximum torque to generate when the accelerator pedal is at maximum (units: mass * distance * distanc...
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleDriveBasicAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxVehicleDriveBasicAPI holding the prim adhering to this schema at path on sta...
static PHYSXSCHEMA_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Very simple drive model for a PhysX vehicle.
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleDriveBasicAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreatePeakTorqueAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPeakTorqueAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
PhysxSchemaPhysxVehicleDriveBasicAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxVehicleDriveBasicAPI on the prim held by schemaObj .
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...