ForceFieldSchemaPhysxForceFieldAPI Class Reference

Force field base class that simply specifies the position and enables or disables the ForceField. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	ForceFieldSchemaPhysxForceFieldAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
	Construct a ForceFieldSchemaPhysxForceFieldAPI on UsdPrim prim with name name . More...
	ForceFieldSchemaPhysxForceFieldAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
	Construct a ForceFieldSchemaPhysxForceFieldAPI on the prim held by schemaObj with name name. More...
virtual FORCEFIELDSCHEMA_API	~ForceFieldSchemaPhysxForceFieldAPI ()
	Destructor. More...
TfToken	GetName () const
	Returns the name of this multiple-apply schema instance. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetEnabledAttr () const
	Enable or disable this ForceField. More...
FORCEFIELDSCHEMA_API UsdAttribute	CreateEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetSurfaceSampleDensityAttr () const
	Number of rays to cast per square unit of surface area. More...
FORCEFIELDSCHEMA_API UsdAttribute	CreateSurfaceSampleDensityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSurfaceSampleDensityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetSurfaceAreaScaleEnabledAttr () const
	Enable or disable scaling forces by the surface area that faces in the direction of the applied force. More...
FORCEFIELDSCHEMA_API UsdAttribute	CreateSurfaceAreaScaleEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSurfaceAreaScaleEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetPositionAttr () const
	The location of the force field. More...
FORCEFIELDSCHEMA_API UsdAttribute	CreatePositionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPositionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
FORCEFIELDSCHEMA_API UsdAttribute	GetRangeAttr () const
	Forces are not applied when the distance to the force field is outside of this (minimum, maximum) range. More...
FORCEFIELDSCHEMA_API UsdAttribute	CreateRangeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetRangeAttr(), 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 ForceFieldSchemaPhysxForceFieldAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a ForceFieldSchemaPhysxForceFieldAPI holding the prim adhering to this schema at path on stage. More...
static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldAPI	Get (const UsdPrim &prim, const TfToken &name)
	Return a ForceFieldSchemaPhysxForceFieldAPI with name name holding the prim prim. More...
static FORCEFIELDSCHEMA_API std::vector < ForceFieldSchemaPhysxForceFieldAPI >	GetAll (const UsdPrim &prim)
	Return a vector of all named instances of ForceFieldSchemaPhysxForceFieldAPI 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 PhysxForceFieldAPI. More...
static FORCEFIELDSCHEMA_API bool	IsPhysxForceFieldAPIPath (const SdfPath &path, TfToken *name)
	Checks if the given path path is of an API schema of type PhysxForceFieldAPI. 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 ForceFieldSchemaPhysxForceFieldAPI	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

Force field base class that simply specifies the position and enables or disables the ForceField.

Definition at line 57 of file physxForceFieldAPI.h.

Constructor & Destructor Documentation

ForceFieldSchemaPhysxForceFieldAPI ( const UsdPrim &  prim = UsdPrim(), const TfToken &  name = TfToken()  )

inlineexplicit

Construct a ForceFieldSchemaPhysxForceFieldAPI on UsdPrim prim with name name .

Equivalent to ForceFieldSchemaPhysxForceFieldAPI::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 physxForceFieldAPI.h.

ForceFieldSchemaPhysxForceFieldAPI ( const UsdSchemaBase &  schemaObj, const TfToken &  name  )

inlineexplicit

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

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

Definition at line 83 of file physxForceFieldAPI.h.

virtual FORCEFIELDSCHEMA_API ~ForceFieldSchemaPhysxForceFieldAPI ( )

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 ForceFieldSchemaPhysxForceFieldAPI 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 "PhysxForceFieldAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'PhysxForceFieldAPI:instance1' is added to 'apiSchemas'.

Returns

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

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

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

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

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

See GetSurfaceSampleDensityAttr(), 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 ForceFieldSchemaPhysxForceFieldAPI Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a ForceFieldSchemaPhysxForceFieldAPI 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());
*  ForceFieldSchemaPhysxForceFieldAPI(
*      stage->GetPrimAtPath(path.GetPrimPath()), name);
*  

static FORCEFIELDSCHEMA_API ForceFieldSchemaPhysxForceFieldAPI Get ( const UsdPrim &  prim, const TfToken &  name  )

static

Return a ForceFieldSchemaPhysxForceFieldAPI with name name holding the prim prim.

Shorthand for ForceFieldSchemaPhysxForceFieldAPI(prim, name);

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

static

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

FORCEFIELDSCHEMA_API UsdAttribute GetEnabledAttr

(

)

const

Enable or disable this ForceField.

Overrides all other settings.

Declaration	bool physxForceField:enabled = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

TfToken GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 109 of file physxForceFieldAPI.h.

FORCEFIELDSCHEMA_API UsdAttribute GetPositionAttr

(

)

const

The location of the force field.

Set to (0, 0, 0) to obtain the position from the prim and continuously update it if it is animated.

Declaration	float3 physxForceField:position = (0, 0, 0)
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Float3

FORCEFIELDSCHEMA_API UsdAttribute GetRangeAttr

(

)

const

Forces are not applied when the distance to the force field is outside of this (minimum, maximum) range.

Each force field can have a different definition of distance, e.g. for a spherical fore field, the distance is to the center, for a plane, the distance is to the closest point on the surface, for a line, it is to the closest point on the line. The minimum or maximum range is ignored if the value is negative.

Declaration	float2 physxForceField:range = (-1, -1)
C++ Type	GfVec2f
Usd Type	SdfValueTypeNames->Float2

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.

FORCEFIELDSCHEMA_API UsdAttribute GetSurfaceAreaScaleEnabledAttr

(

)

const

Enable or disable scaling forces by the surface area that faces in the direction of the applied force.

If a rigid body has no geometry to sample, the surface area scaling is also disabled for that rigid body. The surface area measurement is an approximation based on the collision object bounding box. Certain forces, like wind and drag increase as the exposed surface area increases, but this may not always be desirable.

Declaration	bool physxForceField:surfaceAreaScaleEnabled = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

FORCEFIELDSCHEMA_API UsdAttribute GetSurfaceSampleDensityAttr

(

)

const

Number of rays to cast per square unit of surface area.

When Surface Sampling is disabled, by setting this value to 0.0, (or when it is enabled and a rigid body has no geometry to sample) all forces act through the Center of Mass of the Rigid Body and no rotational torques will be applied. Any positive value will enable Surface Sampling. Ray casts are performed against the Collision Object of the Rigid Body in order to apply forces on the surface along the direction of the surface normal. This will apply torques to the Rigid Body that will induce rotation. Higher densities will cast more rays over the surface and spread the same force over the surface area. More ray casts will generate more accurate forces and torques, but will take additional compute time.

Declaration	float physxForceField:surfaceSampleDensity = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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

static

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

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

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 physxForceFieldAPI.h.

---

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

• C:/g/19412595/omni/schema/source/forceFieldSchema/physxForceFieldAPI.h