7#ifndef USDPHYSICS_GENERATED_DRIVEAPI_H
8#define USDPHYSICS_GENERATED_DRIVEAPI_H
13#include "pxr/usd/usdPhysics/api.h"
19#include "pxr/base/vt/value.h"
26#include "pxr/base/tf/type.h"
28PXR_NAMESPACE_OPEN_SCOPE
136 static std::vector<UsdPhysicsDriveAPI>
171 std::string *whyNot=
nullptr);
207 static const TfType &_GetStaticTfType();
209 static bool _IsTypedSchema();
213 const TfType &_GetTfType()
const override;
375PXR_NAMESPACE_CLOSE_SCOPE
Contains an asset path and an optional resolved path.
A path value used to locate objects in layers or scenegraphs.
Token for efficient comparison, assignment, and hashing of known strings.
TfType represents a dynamic runtime type.
The base class for all API schemas.
const TfToken & _GetInstanceName() const
Returns the instance name of the API schema object belonging to a multiple-apply API schema.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
The PhysicsDriveAPI when applied to any joint primitive will drive the joint towards a given target.
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,...
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.
static USDPHYSICS_API bool IsSchemaPropertyBaseName(const TfToken &baseName)
Checks if the given name baseName is the base name of a property of PhysicsDriveAPI.
virtual USDPHYSICS_API ~UsdPhysicsDriveAPI()
Destructor.
static USDPHYSICS_API TfTokenVector GetSchemaAttributeNames(bool includeInherited, const TfToken &instanceName)
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.
TfToken GetName() const
Returns the name of this multiple-apply schema instance.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
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 GetTargetPositionAttr() const
Target value for position.
USDPHYSICS_API UsdAttribute GetTypeAttr() const
Drive spring is for the acceleration at the joint (rather than the force).
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 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.
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.
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 std::vector< UsdPhysicsDriveAPI > GetAll(const UsdPrim &prim)
Return a vector of all named instances of UsdPhysicsDriveAPI on the given prim.
USDPHYSICS_API UsdAttribute GetDampingAttr() const
Damping of the drive.
static USDPHYSICS_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...
USDPHYSICS_API UsdAttribute GetStiffnessAttr() const
Stiffness of the drive.
static USDPHYSICS_API UsdPhysicsDriveAPI Get(const UsdPrim &prim, const TfToken &name)
Return a UsdPhysicsDriveAPI with name name holding the prim prim.
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 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.
UsdPhysicsDriveAPI(const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
Construct a UsdPhysicsDriveAPI on UsdPrim prim with name name .
USDPHYSICS_API UsdAttribute GetMaxForceAttr() const
Maximum force that can be applied to drive.
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
The base class for all schema types in Usd.
Singleton registry that provides access to schema type information and the prim definitions for regis...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.