All Classes Files Functions Variables Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
ForceFieldSchemaPhysxForceFieldSphericalAPI Class Reference

A spherical force field that attracts and/or repels rigid bodies from a central point depending on the function coefficients. More...

Inherits UsdAPISchemaBase.

Public Member Functions

 ForceFieldSchemaPhysxForceFieldSphericalAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
 Construct a ForceFieldSchemaPhysxForceFieldSphericalAPI on UsdPrim prim with name name . More...
 
 ForceFieldSchemaPhysxForceFieldSphericalAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
 Construct a ForceFieldSchemaPhysxForceFieldSphericalAPI on the prim held by schemaObj with name name. More...
 
virtual FORCEFIELDSCHEMA_API ~ForceFieldSchemaPhysxForceFieldSphericalAPI ()
 Destructor. More...
 
TfToken GetName () const
 Returns the name of this multiple-apply schema instance. More...
 
FORCEFIELDSCHEMA_API UsdAttribute GetConstantAttr () const
 constant applies a steady force. More...
 
FORCEFIELDSCHEMA_API UsdAttribute CreateConstantAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetConstantAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
FORCEFIELDSCHEMA_API UsdAttribute GetLinearAttr () const
 linear sets a force that varies with distance to the center. More...
 
FORCEFIELDSCHEMA_API UsdAttribute CreateLinearAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetLinearAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
FORCEFIELDSCHEMA_API UsdAttribute GetInverseSquareAttr () const
 inverseSquare sets a force that varies with the reciprocal of the square of the distance to the center. More...
 
FORCEFIELDSCHEMA_API UsdAttribute CreateInverseSquareAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetInverseSquareAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 

Static Public Member Functions

static FORCEFIELDSCHEMA_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 classes. More...
 
static FORCEFIELDSCHEMA_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 classes for a given instance name. More...
 
static FORCEFIELDSCHEMA_API
ForceFieldSchemaPhysxForceFieldSphericalAPI 		Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a ForceFieldSchemaPhysxForceFieldSphericalAPI holding the prim adhering to this schema at path on stage. More...
 
static FORCEFIELDSCHEMA_API
ForceFieldSchemaPhysxForceFieldSphericalAPI 		Get (const UsdPrim &prim, const TfToken &name)
 Return a ForceFieldSchemaPhysxForceFieldSphericalAPI with name name holding the prim prim. More...
 
static FORCEFIELDSCHEMA_API
std::vector
< ForceFieldSchemaPhysxForceFieldSphericalAPI > 		GetAll (const UsdPrim &prim)
 Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldSphericalAPI on the given prim. More...
 
static FORCEFIELDSCHEMA_API bool IsSchemaPropertyBaseName (const TfToken &baseName)
 Checks if the given name baseName is the base name of a property of PhysxForceFieldSphericalAPI. More...
 
static FORCEFIELDSCHEMA_API bool IsPhysxForceFieldSphericalAPIPath (const SdfPath &path, TfToken *name)
 Checks if the given path path is of an API schema of type PhysxForceFieldSphericalAPI. More...
 
static FORCEFIELDSCHEMA_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, name, to the given prim. More...
 
static FORCEFIELDSCHEMA_API
ForceFieldSchemaPhysxForceFieldSphericalAPI 		Apply (const UsdPrim &prim, const TfToken &name)
 Applies this multiple-apply API schema to the given prim along with the given instance name, name. More...
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

FORCEFIELDSCHEMA_API UsdSchemaKind _GetSchemaKind () const override
 Returns the kind of schema this class belongs to. More...
 

Friends

class UsdSchemaRegistry
 

Detailed Description

A spherical force field that attracts and/or repels rigid bodies from a central point depending on the function coefficients.

Positive values attract and negative values repel. The net force on the rigid body is calculated using f = constant + linear * r + inverseSquare / r^2, where r is the distance to the center.

Definition at line 60 of file physxForceFieldSphericalAPI.h.

Constructor & Destructor Documentation

ForceFieldSchemaPhysxForceFieldSphericalAPI ( const UsdPrim &  prim = UsdPrim(),
const TfToken &  name = TfToken() 
)
inlineexplicit

Construct a ForceFieldSchemaPhysxForceFieldSphericalAPI on UsdPrim prim with name name .

Equivalent to ForceFieldSchemaPhysxForceFieldSphericalAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "physxForceField:name"));

for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 77 of file physxForceFieldSphericalAPI.h.

ForceFieldSchemaPhysxForceFieldSphericalAPI ( const UsdSchemaBase &  schemaObj,
const TfToken &  name 
)
inlineexplicit

Construct a ForceFieldSchemaPhysxForceFieldSphericalAPI on the prim held by schemaObj with name name.

Should be preferred over ForceFieldSchemaPhysxForceFieldSphericalAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

Definition at line 86 of file physxForceFieldSphericalAPI.h.

virtual FORCEFIELDSCHEMA_API ~ForceFieldSchemaPhysxForceFieldSphericalAPI ( )
virtual

Destructor.

Member Function Documentation

FORCEFIELDSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const
overrideprotected

Returns the kind of schema this class belongs to.

See Also
UsdSchemaKind
static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldSphericalAPI Apply ( const UsdPrim &  prim,
const TfToken &  name 
)
static

Applies this multiple-apply API schema to the given prim along with the given instance name, name.

This information is stored by adding "PhysxForceFieldSphericalAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'PhysxForceFieldSphericalAPI:instance1' is added to 'apiSchemas'.

Returns
A valid ForceFieldSchemaPhysxForceFieldSphericalAPI object is returned upon success. An invalid (or empty) ForceFieldSchemaPhysxForceFieldSphericalAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
static FORCEFIELDSCHEMA_API bool CanApply ( const UsdPrim &  prim,
const TfToken &  name,
std::string *  whyNot = nullptr 
)
static

Returns true if this multiple-apply API schema can be applied, with the given instance name, name, to the given prim.

If this schema can not be a applied the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
FORCEFIELDSCHEMA_API UsdAttribute CreateConstantAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetConstantAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

FORCEFIELDSCHEMA_API UsdAttribute CreateInverseSquareAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetInverseSquareAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

FORCEFIELDSCHEMA_API UsdAttribute CreateLinearAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetLinearAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldSphericalAPI Get ( const UsdStagePtr &  stage,
const SdfPath &  path 
)
static

Return a ForceFieldSchemaPhysxForceFieldSphericalAPI holding the prim adhering to this schema at path on stage.

If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. path must be of the format <path>.physxForceField:name .

This is shorthand for the following:

* TfToken name = SdfPath::StripNamespace(path.GetToken());
* ForceFieldSchemaPhysxForceFieldSphericalAPI(
* stage->GetPrimAtPath(path.GetPrimPath()), name);
*
static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldSphericalAPI Get ( const UsdPrim &  prim,
const TfToken &  name 
)
static

Return a ForceFieldSchemaPhysxForceFieldSphericalAPI with name name holding the prim prim.

Shorthand for ForceFieldSchemaPhysxForceFieldSphericalAPI(prim, name);

static FORCEFIELDSCHEMA_API std::vector<ForceFieldSchemaPhysxForceFieldSphericalAPI> GetAll ( const UsdPrim &  prim)
static

Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldSphericalAPI on the given prim.

FORCEFIELDSCHEMA_API UsdAttribute GetConstantAttr ( ) const

constant applies a steady force.

Declaration float physxForceFieldSpherical:constant = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
FORCEFIELDSCHEMA_API UsdAttribute GetInverseSquareAttr ( ) const

inverseSquare sets a force that varies with the reciprocal of the square of the distance to the center.

Declaration float physxForceFieldSpherical:inverseSquare = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
FORCEFIELDSCHEMA_API UsdAttribute GetLinearAttr ( ) const

linear sets a force that varies with distance to the center.

Declaration float physxForceFieldSpherical:linear = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
TfToken GetName ( ) const
inline

Returns the name of this multiple-apply schema instance.

Definition at line 112 of file physxForceFieldSphericalAPI.h.

static FORCEFIELDSCHEMA_API const TfTokenVector& GetSchemaAttributeNames ( bool  includeInherited = true)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

static FORCEFIELDSCHEMA_API TfTokenVector GetSchemaAttributeNames ( bool  includeInherited,
const TfToken &  instanceName 
)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name.

Does not include attributes that may be authored by custom/extended methods of the schemas involved. The names returned will have the proper namespace prefix.

static FORCEFIELDSCHEMA_API bool IsPhysxForceFieldSphericalAPIPath ( const SdfPath &  path,
TfToken *  name 
)
static

Checks if the given path path is of an API schema of type PhysxForceFieldSphericalAPI.

If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

static FORCEFIELDSCHEMA_API bool IsSchemaPropertyBaseName ( const TfToken &  baseName)
static

Checks if the given name baseName is the base name of a property of PhysxForceFieldSphericalAPI.

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI
static

Compile time constant representing what kind of schema this class is.

See Also
UsdSchemaKind

Definition at line 66 of file physxForceFieldSphericalAPI.h.

The documentation for this class was generated from the following file: