24 #ifndef USDPHYSICS_GENERATED_DRIVEAPI_H
25 #define USDPHYSICS_GENERATED_DRIVEAPI_H
30 #include "pxr/usd/usdPhysics/api.h"
36 #include "pxr/base/vt/value.h"
43 #include "pxr/base/tf/type.h"
45 PXR_NAMESPACE_OPEN_SCOPE
113 bool includeInherited=
true,
const TfToken instanceName=
TfToken());
136 Get(
const UsdStagePtr &stage,
const SdfPath &path);
176 std::string *whyNot=
nullptr);
212 static const TfType &_GetStaticTfType();
214 static bool _IsTypedSchema();
218 const TfType &_GetTfType()
const override;
380 PXR_NAMESPACE_CLOSE_SCOPE
UsdPhysicsDriveAPI(const UsdSchemaBase &schemaObj, const TfToken &name)
Construct a UsdPhysicsDriveAPI on the prim held by schemaObj with name name.
USDPHYSICS_API UsdAttribute GetTargetVelocityAttr() const
Target value for velocity.
USDPHYSICS_API UsdAttribute GetTypeAttr() const
Drive spring is for the acceleration at the joint (rather than the force).
The base class for all API schemas.
USDPHYSICS_API UsdAttribute GetDampingAttr() const
Damping of the drive.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
static USDPHYSICS_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true, const TfToken instanceName=TfToken())
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
static USDPHYSICS_API bool IsPhysicsDriveAPIPath(const SdfPath &path, TfToken *name)
Checks if the given path path is of an API schema of type PhysicsDriveAPI.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Token for efficient comparison, assignment, and hashing of known strings.
USDPHYSICS_API UsdAttribute CreateTargetVelocityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTargetVelocityAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
static USDPHYSICS_API UsdPhysicsDriveAPI Apply(const UsdPrim &prim, const TfToken &name)
Applies this multiple-apply API schema to the given prim along with the given instance name...
USDPHYSICS_API UsdAttribute GetStiffnessAttr() const
Stiffness of the drive.
static USDPHYSICS_API bool CanApply(const UsdPrim &prim, const TfToken &name, std::string *whyNot=nullptr)
Returns true if this multiple-apply API schema can be applied, with the given instance name...
The PhysicsDriveAPI when applied to any joint primitive will drive the joint towards a given target...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
std::vector< TfToken > TfTokenVector
Convenience types.
USDPHYSICS_API UsdAttribute CreateDampingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDampingAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
A path value used to locate objects in layers or scenegraphs.
TfToken GetName() const
Returns the name of this multiple-apply schema instance.
virtual USDPHYSICS_API ~UsdPhysicsDriveAPI()
Destructor.
Contains an asset path and an optional resolved path.
Multiple Apply API Schema.
USDPHYSICS_API UsdAttribute GetTargetPositionAttr() const
Target value for position.
USDPHYSICS_API UsdAttribute CreateMaxForceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxForceAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDPHYSICS_API UsdAttribute CreateTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTypeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
static USDPHYSICS_API UsdPhysicsDriveAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsDriveAPI holding the prim adhering to this schema at path on stage.
USDPHYSICS_API UsdAttribute CreateStiffnessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetStiffnessAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
TfType represents a dynamic runtime type.
Singleton registry that provides access to schema type information and the prim definitions for regis...
USDPHYSICS_API UsdAttribute GetMaxForceAttr() const
Maximum force that can be applied to drive.
The base class for all schema types in Usd.
UsdPhysicsDriveAPI(const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
Construct a UsdPhysicsDriveAPI on UsdPrim prim with name name .
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static USDPHYSICS_API bool IsSchemaPropertyBaseName(const TfToken &baseName)
Checks if the given name baseName is the base name of a property of PhysicsDriveAPI.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
const TfToken & _GetInstanceName() const
Returns the instance name of the API schema object belonging to a multiple-apply API schema...
USDPHYSICS_API UsdAttribute CreateTargetPositionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTargetPositionAttr(), and also Create vs Get Property Methods for when to use Get vs Create...