PhysxSchemaPhysxHairMaterialAPI Class Reference

WARNING: This is a draft API; the design is not fixed and may change in the future. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxHairMaterialAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxHairMaterialAPI on UsdPrim prim . More...
	PhysxSchemaPhysxHairMaterialAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxHairMaterialAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxHairMaterialAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetDynamicFrictionAttr () const
	Dynamic friction coefficient. More...
PHYSXSCHEMA_API UsdAttribute	CreateDynamicFrictionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDynamicFrictionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetDensityAttr () const
	If non-zero, defines the density of the material. More...
PHYSXSCHEMA_API UsdAttribute	CreateDensityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDensityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetYoungsModulusAttr () const
	Young's modulus, i.e. More...
PHYSXSCHEMA_API UsdAttribute	CreateYoungsModulusAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetYoungsModulusAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetCurveThicknessAttr () const
	Diameter along curve. More...
PHYSXSCHEMA_API UsdAttribute	CreateCurveThicknessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCurveThicknessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetCurveBendStiffnessAttr () const
	Optional override for bending stiffness; by default derived from youngsModulus and curveThickness. More...
PHYSXSCHEMA_API UsdAttribute	CreateCurveBendStiffnessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCurveBendStiffnessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetContactOffsetMultiplierAttr () const
	Distance at which collisions are generated as a multiple of curveThickness. More...
PHYSXSCHEMA_API UsdAttribute	CreateContactOffsetMultiplierAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetContactOffsetMultiplierAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetContactOffsetAttr () const
	Distance at which collisions are generated. More...
PHYSXSCHEMA_API UsdAttribute	CreateContactOffsetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetContactOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Static Public Member Functions
static PHYSXSCHEMA_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 PHYSXSCHEMA_API PhysxSchemaPhysxHairMaterialAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxHairMaterialAPI holding the prim adhering to this schema at path on stage. More...
static PHYSXSCHEMA_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
	Returns true if this single-apply API schema can be applied to the given prim. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxHairMaterialAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given prim. More...

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
PHYSXSCHEMA_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

WARNING: This is a draft API; the design is not fixed and may change in the future.

Applied to USD Material. Defines material properties for hair simulation.

Definition at line 58 of file physxHairMaterialAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxHairMaterialAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxHairMaterialAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxHairMaterialAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 70 of file physxHairMaterialAPI.h.

PhysxSchemaPhysxHairMaterialAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxHairMaterialAPI on the prim held by schemaObj .

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

Definition at line 78 of file physxHairMaterialAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxHairMaterialAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

static PHYSXSCHEMA_API PhysxSchemaPhysxHairMaterialAPI Apply ( const UsdPrim &  prim )

static

Applies this single-apply API schema to the given prim.

This information is stored by adding "PhysxHairMaterialAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns

A valid PhysxSchemaPhysxHairMaterialAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxHairMaterialAPI 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 PHYSXSCHEMA_API bool CanApply ( const UsdPrim &  prim, std::string *  whyNot = nullptr  )

static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to 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()

PHYSXSCHEMA_API UsdAttribute CreateContactOffsetAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetContactOffsetAttr(), 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.

PHYSXSCHEMA_API UsdAttribute CreateContactOffsetMultiplierAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetContactOffsetMultiplierAttr(), 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.

PHYSXSCHEMA_API UsdAttribute CreateCurveBendStiffnessAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetCurveBendStiffnessAttr(), 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.

PHYSXSCHEMA_API UsdAttribute CreateCurveThicknessAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetCurveThicknessAttr(), 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.

PHYSXSCHEMA_API UsdAttribute CreateDensityAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetDensityAttr(), 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.

PHYSXSCHEMA_API UsdAttribute CreateDynamicFrictionAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetDynamicFrictionAttr(), 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.

PHYSXSCHEMA_API UsdAttribute CreateYoungsModulusAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetYoungsModulusAttr(), 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 PHYSXSCHEMA_API PhysxSchemaPhysxHairMaterialAPI Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a PhysxSchemaPhysxHairMaterialAPI 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. This is shorthand for the following:

*  PhysxSchemaPhysxHairMaterialAPI(stage->GetPrimAtPath(path));
*  

PHYSXSCHEMA_API UsdAttribute GetContactOffsetAttr

(

)

const

Distance at which collisions are generated.

Overrides the contactOffsetMultiplier attribute if set to a non-negative value. Range: [0.0, inf) Units: distance

Declaration	float physxHairMaterial:contactOffset = -inf
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetContactOffsetMultiplierAttr

(

)

const

Distance at which collisions are generated as a multiple of curveThickness.

This attribute has no effect if contactOffset is non-negative. Range: [0.0, inf) Units: dimensionless

Declaration	float physxHairMaterial:contactOffsetMultiplier = 1
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetCurveBendStiffnessAttr

(

)

const

Optional override for bending stiffness; by default derived from youngsModulus and curveThickness.

Override is active if the value is non-negative. Range: [0, inf) Units: mass/(distance*seconds*seconds).

Declaration	float physxHairMaterial:curveBendStiffness = -inf
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetCurveThicknessAttr

(

)

const

Diameter along curve.

A negative value means the simulation will pick a default. Range: [0, inf) Units: distance.

Declaration	float physxHairMaterial:curveThickness = -inf
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetDensityAttr

(

)

const

If non-zero, defines the density of the material.

This can be used for body mass computation, see PhysicsMassAPI. Note that if the density is 0.0 it is ignored. Units: mass/distance/distance/distance.

Declaration	float physxHairMaterial:density = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetDynamicFrictionAttr

(

)

const

Dynamic friction coefficient.

Unitless.

Declaration	float physxHairMaterial:dynamicFriction = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

static PHYSXSCHEMA_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.

PHYSXSCHEMA_API UsdAttribute GetYoungsModulusAttr

(

)

const

Young's modulus, i.e.

the tensile stiffness of the material. A negative value means the simulation will pick a default. Range: [0, inf) Units: mass/(distance*seconds*seconds).

Declaration	float physxHairMaterial:youngsModulus = -inf
C++ Type	float
Usd Type	SdfValueTypeNames->Float

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also

UsdSchemaKind

Definition at line 64 of file physxHairMaterialAPI.h.

---

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

• C:/g/19412595/omni/schema/source/physxSchema/physxHairMaterialAPI.h