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

A force field that adds randomized motion to a rigid body. More...

Inherits UsdAPISchemaBase.

Public Member Functions

 ForceFieldSchemaPhysxForceFieldNoiseAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
 Construct a ForceFieldSchemaPhysxForceFieldNoiseAPI on UsdPrim prim with name name . More...
 
 ForceFieldSchemaPhysxForceFieldNoiseAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
 Construct a ForceFieldSchemaPhysxForceFieldNoiseAPI on the prim held by schemaObj with name name. More...
 
virtual FORCEFIELDSCHEMA_API ~ForceFieldSchemaPhysxForceFieldNoiseAPI ()
 Destructor. More...
 
TfToken GetName () const
 Returns the name of this multiple-apply schema instance. More...
 
FORCEFIELDSCHEMA_API UsdAttribute GetDragAttr () const
 The drag coefficient determines how quickly the body moves along with the noise. More...
 
FORCEFIELDSCHEMA_API UsdAttribute CreateDragAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetDragAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
FORCEFIELDSCHEMA_API UsdAttribute GetAmplitudeAttr () const
 The magnitude of the oscillations along each of the three local axes. More...
 
FORCEFIELDSCHEMA_API UsdAttribute CreateAmplitudeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAmplitudeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
FORCEFIELDSCHEMA_API UsdAttribute GetFrequencyAttr () const
 The frequency of the oscillations for each of the three local axes. More...
 
FORCEFIELDSCHEMA_API UsdAttribute CreateFrequencyAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetFrequencyAttr(), 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
ForceFieldSchemaPhysxForceFieldNoiseAPI 		Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a ForceFieldSchemaPhysxForceFieldNoiseAPI holding the prim adhering to this schema at path on stage. More...
 
static FORCEFIELDSCHEMA_API
ForceFieldSchemaPhysxForceFieldNoiseAPI 		Get (const UsdPrim &prim, const TfToken &name)
 Return a ForceFieldSchemaPhysxForceFieldNoiseAPI with name name holding the prim prim. More...
 
static FORCEFIELDSCHEMA_API
std::vector
< ForceFieldSchemaPhysxForceFieldNoiseAPI > 		GetAll (const UsdPrim &prim)
 Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldNoiseAPI 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 PhysxForceFieldNoiseAPI. More...
 
static FORCEFIELDSCHEMA_API bool IsPhysxForceFieldNoiseAPIPath (const SdfPath &path, TfToken *name)
 Checks if the given path path is of an API schema of type PhysxForceFieldNoiseAPI. 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
ForceFieldSchemaPhysxForceFieldNoiseAPI 		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 force field that adds randomized motion to a rigid body.

Definition at line 57 of file physxForceFieldNoiseAPI.h.

Constructor & Destructor Documentation

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

Construct a ForceFieldSchemaPhysxForceFieldNoiseAPI on UsdPrim prim with name name .

Equivalent to ForceFieldSchemaPhysxForceFieldNoiseAPI::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 74 of file physxForceFieldNoiseAPI.h.

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

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

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

Definition at line 83 of file physxForceFieldNoiseAPI.h.

virtual FORCEFIELDSCHEMA_API ~ForceFieldSchemaPhysxForceFieldNoiseAPI ( )
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 ForceFieldSchemaPhysxForceFieldNoiseAPI 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 "PhysxForceFieldNoiseAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'PhysxForceFieldNoiseAPI:instance1' is added to 'apiSchemas'.

Returns
A valid ForceFieldSchemaPhysxForceFieldNoiseAPI object is returned upon success. An invalid (or empty) ForceFieldSchemaPhysxForceFieldNoiseAPI 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 CreateAmplitudeAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetAmplitudeAttr(), 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 CreateDragAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDragAttr(), 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 CreateFrequencyAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetFrequencyAttr(), 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 ForceFieldSchemaPhysxForceFieldNoiseAPI Get ( const UsdStagePtr &  stage,
const SdfPath &  path 
)
static

Return a ForceFieldSchemaPhysxForceFieldNoiseAPI 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());
* ForceFieldSchemaPhysxForceFieldNoiseAPI(
* stage->GetPrimAtPath(path.GetPrimPath()), name);
*
static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldNoiseAPI Get ( const UsdPrim &  prim,
const TfToken &  name 
)
static

Return a ForceFieldSchemaPhysxForceFieldNoiseAPI with name name holding the prim prim.

Shorthand for ForceFieldSchemaPhysxForceFieldNoiseAPI(prim, name);

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

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

FORCEFIELDSCHEMA_API UsdAttribute GetAmplitudeAttr ( ) const

The magnitude of the oscillations along each of the three local axes.

Declaration float3 physxForceFieldNoise:amplitude = (0, 0, 0)
C++ Type GfVec3f
Usd Type SdfValueTypeNames->Float3
FORCEFIELDSCHEMA_API UsdAttribute GetDragAttr ( ) const

The drag coefficient determines how quickly the body moves along with the noise.

Smaller values cause the body to react more slowly.

Declaration float physxForceFieldNoise:drag = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
FORCEFIELDSCHEMA_API UsdAttribute GetFrequencyAttr ( ) const

The frequency of the oscillations for each of the three local axes.

Declaration float3 physxForceFieldNoise:frequency = (0, 0, 0)
C++ Type GfVec3f
Usd Type SdfValueTypeNames->Float3
TfToken GetName ( ) const
inline

Returns the name of this multiple-apply schema instance.

Definition at line 109 of file physxForceFieldNoiseAPI.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 IsPhysxForceFieldNoiseAPIPath ( const SdfPath &  path,
TfToken *  name 
)
static

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

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 PhysxForceFieldNoiseAPI.

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 63 of file physxForceFieldNoiseAPI.h.

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