usdrt::PhysxSchemaPhysxHairMaterialAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxHairMaterialAPI.h

Functions

usdrt::PhysxSchemaPhysxHairMaterialAPI::Apply: 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.
usdrt::PhysxSchemaPhysxHairMaterialAPI::CreateContactOffsetAttr: See GetContactOffsetAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxHairMaterialAPI::CreateContactOffsetMultiplierAttr: See GetContactOffsetMultiplierAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxHairMaterialAPI::CreateCurveBendStiffnessAttr: See GetCurveBendStiffnessAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxHairMaterialAPI::CreateCurveThicknessAttr: See GetCurveThicknessAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxHairMaterialAPI::CreateDensityAttr: See GetDensityAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxHairMaterialAPI::CreateDynamicFrictionAttr: See GetDynamicFrictionAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxHairMaterialAPI::CreateYoungsModulusAttr: See GetYoungsModulusAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxHairMaterialAPI::GetContactOffsetAttr: Distance at which collisions are generated. Overrides the contactOffsetMultiplier attribute if set to a non-negative value. Range: [0.0, inf) Units: distance.
usdrt::PhysxSchemaPhysxHairMaterialAPI::GetContactOffsetMultiplierAttr: 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.
usdrt::PhysxSchemaPhysxHairMaterialAPI::GetCurveBendStiffnessAttr: 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).
usdrt::PhysxSchemaPhysxHairMaterialAPI::GetCurveThicknessAttr: Diameter along curve. A negative value means the simulation will pick a default. Range: [0, inf) Units: distance.
usdrt::PhysxSchemaPhysxHairMaterialAPI::GetDensityAttr: 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.
usdrt::PhysxSchemaPhysxHairMaterialAPI::GetDynamicFrictionAttr: Dynamic friction coefficient. Unitless.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxHairMaterialAPI::GetYoungsModulusAttr: 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).
usdrt::PhysxSchemaPhysxHairMaterialAPI::PhysxSchemaPhysxHairMaterialAPI: 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 .
usdrt::PhysxSchemaPhysxHairMaterialAPI::PhysxSchemaPhysxHairMaterialAPI: Construct a PhysxSchemaPhysxHairMaterialAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxHairMaterialAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxHairMaterialAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxHairMaterialAPI::~PhysxSchemaPhysxHairMaterialAPI: Destructor.

Variables

usdrt::PhysxSchemaPhysxHairMaterialAPI::schemaType: Compile time constant representing what kind of schema this class is.

class PhysxSchemaPhysxHairMaterialAPI : public usdrt::UsdAPISchemaBase 

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.

Public Functions

inline explicit PhysxSchemaPhysxHairMaterialAPI(const UsdPrim &prim = UsdPrim()): 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.

inline explicit PhysxSchemaPhysxHairMaterialAPI(const UsdSchemaBase &schemaObj): Construct a PhysxSchemaPhysxHairMaterialAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxHairMaterialAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxHairMaterialAPI(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline UsdAttribute GetDynamicFrictionAttr() const

Dynamic friction coefficient. Unitless.


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

inline UsdAttribute CreateDynamicFrictionAttr() const: See GetDynamicFrictionAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateDensityAttr() const: See GetDensityAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateYoungsModulusAttr() const: See GetYoungsModulusAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateCurveThicknessAttr() const: See GetCurveThicknessAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateCurveBendStiffnessAttr() const: See GetCurveBendStiffnessAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateContactOffsetMultiplierAttr() const: See GetContactOffsetMultiplierAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateContactOffsetAttr() const: See GetContactOffsetAttr(), and also Create vs Get Property Methods 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.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline PhysxSchemaPhysxHairMaterialAPI Apply(const UsdPrim &prim)

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.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI 

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

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.