#include <houdiniHairDeformAPI.h>

Inheritance diagram for UsdHoudiniHoudiniHairDeformAPI:

Public Member Functions
	UsdHoudiniHoudiniHairDeformAPI (const UsdPrim &prim=UsdPrim())

	UsdHoudiniHoudiniHairDeformAPI (const UsdSchemaBase &schemaObj)

virtual	~UsdHoudiniHoudiniHairDeformAPI () override
	Destructor. More...

UsdAttribute	GetPreserveShapeEnableAttr () const

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

UsdAttribute	GetPreserveShapeIterationsAttr () const

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

UsdAttribute	GetPreserveShapeLockRootsAttr () const

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

UsdAttribute	GetPreserveShapeKStretchAttr () const

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

UsdAttribute	GetPreserveShapeKBendAttr () const

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

UsdAttribute	GetPreserveShapeRefPosStrengthAttr () const

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

UsdAttribute	GetPreserveClumpsStiffnessAttr () const

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

UsdAttribute	GetPreserveClumpsDampingAttr () const

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

UsdAttribute	GetPreserveClumpsEnableAttr () const

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

UsdAttribute	GetPreserveClumpsMaxNeighborsAttr () const

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

UsdAttribute	GetPreserveClumpsMaxConstraintsAttr () const

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

UsdAttribute	GetCaptureRadiusAttr () const

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

UsdAttribute	GetCaptureMaxPointsAttr () const

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

UsdAttribute	GetCaptureMinPointsAttr () const

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

UsdAttribute	GetDeformMethodAttr () const

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

UsdAttribute	GetSmoothCaptureAttr () const

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

UsdAttribute	GetSmoothCaptureRadiusAttr () const

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

UsdAttribute	GetKernelTypeAttr () const

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

UsdAttribute	GetSmoothingMethodAttr () const

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

UsdAttribute	GetSmoothingLevelAttr () const

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

UsdAttribute	GetTetMeshTreatmentAttr () const

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

UsdAttribute	GetUseOrientAttribAttr () const

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

UsdAttribute	GetOrientBlendAttr () const

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

UsdAttribute	GetGsiMaxCandidatesAttr () const

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

UsdAttribute	GetGsiSearchRadiusAttr () const

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

UsdAttribute	GetGsiNSamplesAttr () const

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

UsdAttribute	GetGsiMinGuidesAttr () const

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

UsdAttribute	GetGsiMaxGuidesAttr () const

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

UsdAttribute	GetGsiSigmaScaleAttr () const

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

UsdAttribute	GetGsiWeightThresholdAttr () const

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

UsdAttribute	GetGsiLengthPenaltyScaleAttr () const

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

UsdRelationship	GetSkinPrimRel () const

UsdRelationship	CreateSkinPrimRel () const

UsdRelationship	GetDeformerPrimRel () const

UsdRelationship	CreateDeformerPrimRel () const

UsdRelationship	GetGuideInterpMeshPrimRel () const

UsdRelationship	CreateGuideInterpMeshPrimRel () const

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor. More...

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const

bool	IsTyped () const

bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...

bool	IsAppliedAPISchema () const

bool	IsMultipleApplyAPISchema () const

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim. More...

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`. More...

virtual USD_API	~UsdSchemaBase ()
	Destructor. More...

USD_API	operator bool () const

UsdPrim	GetPrim () const
	Return this schema object's held prim. More...

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

static UsdHoudiniHoudiniHairDeformAPI	Get (const UsdStagePtr &stage, const SdfPath &path)

static bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)

static UsdHoudiniHoudiniHairDeformAPI	Apply (const UsdPrim &prim)

Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
UsdSchemaKind	_GetSchemaKind () const override

Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind	_GetSchemaKind () const override

	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)

const TfToken &	_GetInstanceName () const

USD_API bool	_IsCompatible () const override

Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind	_GetSchemaType () const

const TfType &	_GetType () const

USD_API UsdAttribute	_CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const

Friends
class	UsdSchemaRegistry

Additional Inherited Members
Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector	_GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)

Detailed Description

API for deforming hair curves.

Definition at line 40 of file houdiniHairDeformAPI.h.

Constructor & Destructor Documentation

UsdHoudiniHoudiniHairDeformAPI::UsdHoudiniHoudiniHairDeformAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

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

Definition at line 54 of file houdiniHairDeformAPI.h.

UsdHoudiniHoudiniHairDeformAPI::UsdHoudiniHoudiniHairDeformAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdHoudiniHoudiniHairDeformAPI on the prim held by schemaObj . Should be preferred over UsdHoudiniHoudiniHairDeformAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 62 of file houdiniHairDeformAPI.h.

virtual UsdHoudiniHoudiniHairDeformAPI::~UsdHoudiniHoudiniHairDeformAPI ( )

overridevirtual

Destructor.

Member Function Documentation

UsdSchemaKind UsdHoudiniHoudiniHairDeformAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdSchemaBase.

static UsdHoudiniHoudiniHairDeformAPI UsdHoudiniHoudiniHairDeformAPI::Apply ( const UsdPrim & prim )

static

Applies this single-apply API schema to the given prim. This information is stored by adding "HoudiniHairDeformAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns: A valid UsdHoudiniHoudiniHairDeformAPI object is returned upon success. An invalid (or empty) UsdHoudiniHoudiniHairDeformAPI 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 bool UsdHoudiniHoudiniHairDeformAPI::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()

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateCaptureMaxPointsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateCaptureMinPointsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateCaptureRadiusAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdRelationship UsdHoudiniHoudiniHairDeformAPI::CreateDeformerPrimRel ( ) const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateDeformMethodAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateGsiLengthPenaltyScaleAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateGsiMaxCandidatesAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateGsiMaxGuidesAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateGsiMinGuidesAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateGsiNSamplesAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateGsiSearchRadiusAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateGsiSigmaScaleAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateGsiWeightThresholdAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdRelationship UsdHoudiniHoudiniHairDeformAPI::CreateGuideInterpMeshPrimRel ( ) const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateKernelTypeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateOrientBlendAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveClumpsDampingAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveClumpsEnableAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveClumpsMaxConstraintsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveClumpsMaxNeighborsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveClumpsStiffnessAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveShapeEnableAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveShapeIterationsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveShapeKBendAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveShapeKStretchAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveShapeLockRootsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreatePreserveShapeRefPosStrengthAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdRelationship UsdHoudiniHoudiniHairDeformAPI::CreateSkinPrimRel ( ) const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateSmoothCaptureAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateSmoothCaptureRadiusAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateSmoothingLevelAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateSmoothingMethodAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateTetMeshTreatmentAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::CreateUseOrientAttribAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetUseOrientAttribAttr(), 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 UsdHoudiniHoudiniHairDeformAPI UsdHoudiniHoudiniHairDeformAPI::Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a UsdHoudiniHoudiniHairDeformAPI 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:

UsdHoudiniHoudiniHairDeformAPI(stage->GetPrimAtPath(path));

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetCaptureMaxPointsAttr ( ) const

Maximum number of deformer points to capture per groom point.


Declaration	`uniform int houdini:hairdeform:capturemaxpoints = 10`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetCaptureMinPointsAttr ( ) const

Minimum number of deformer points to capture per groom point (radius will expand if needed).


Declaration	`uniform int houdini:hairdeform:captureminpoints = 1`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetCaptureRadiusAttr ( ) const

Search radius for point capture when capture attributes are not present.


Declaration	`uniform float houdini:hairdeform:captureradius = 1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdRelationship UsdHoudiniHoudiniHairDeformAPI::GetDeformerPrimRel ( ) const

Deformer curves or guides used for point deform and guide interpolation mesh methods.

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetDeformMethodAttr ( ) const

Method to use for the basic deformation. Currently either 'pointdeform' or 'surfacedeform'.


Declaration	`uniform string houdini:hairdeform:deformmethod = ""`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetGsiLengthPenaltyScaleAttr ( ) const

Guide Shape Interpolation: scale applied to the squared relative length difference between groom and guide curves.


Declaration	`uniform float houdini:hairdeform:gsilengthpenaltyscale = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetGsiMaxCandidatesAttr ( ) const

Guide Shape Interpolation: maximum number of candidate guide roots to consider in the spatial search.


Declaration	`uniform int houdini:hairdeform:gsimaxcandidates = 32`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetGsiMaxGuidesAttr ( ) const

Guide Shape Interpolation: maximum number of guide influences per groom curve.


Declaration	`uniform int houdini:hairdeform:gsimaxguides = 8`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetGsiMinGuidesAttr ( ) const

Guide Shape Interpolation: minimum number of guide influences kept per groom curve regardless of weight threshold.


Declaration	`uniform int houdini:hairdeform:gsiminguides = 1`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetGsiNSamplesAttr ( ) const

Guide Shape Interpolation: number of arc-length samples used to compute shape distance between curves.


Declaration	`uniform int houdini:hairdeform:gsinsamples = 20`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetGsiSearchRadiusAttr ( ) const

Guide Shape Interpolation: spatial search radius around each groom curve root.


Declaration	`uniform float houdini:hairdeform:gsisearchradius = 0.2`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetGsiSigmaScaleAttr ( ) const

Guide Shape Interpolation: Gaussian sigma scale factor applied to the median shape distance.


Declaration	`uniform float houdini:hairdeform:gsisigmascale = 0.1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetGsiWeightThresholdAttr ( ) const

Guide Shape Interpolation: minimum normalised weight below which a guide influence is discarded.


Declaration	`uniform float houdini:hairdeform:gsiweightthreshold = 0.1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdRelationship UsdHoudiniHoudiniHairDeformAPI::GetGuideInterpMeshPrimRel ( ) const

Guide interpolation mesh with 'guides' and 'weights' array attributes for guide interpolation mesh deformation method.

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetKernelTypeAttr ( ) const

Kernel type for smooth capture weight falloff.


Declaration	`uniform string houdini:hairdeform:kerneltype = "exponentialbump"`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String
Variability	SdfVariabilityUniform
Allowed Values	exponentialbump, truncatedgaussian, quadratic, linear

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetOrientBlendAttr ( ) const

Blend between position-only guide deformation and orient-augmented guide deformation for BasisCurves point deform.


Declaration	`uniform float houdini:hairdeform:orientblend = 1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveClumpsDampingAttr ( ) const

Damping for clump forces in preserve shape solve.


Declaration	`uniform float houdini:hairdeform:preserveclumpsdamping = 1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveClumpsEnableAttr ( ) const

Enable clump constraints during the solve.


Declaration	`uniform bool houdini:hairdeform:preserveclumpsenable = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveClumpsMaxConstraintsAttr ( ) const

Maximum number of cross-curve clump constraints to keep per point.


Declaration	`uniform int houdini:hairdeform:preserveclumpsmaxconstraints = 3`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveClumpsMaxNeighborsAttr ( ) const

Maximum number of candidate neighbors to search per point for clumping.


Declaration	`uniform int houdini:hairdeform:preserveclumpsmaxneighbors = 50`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveClumpsStiffnessAttr ( ) const

Clump stiffness for volume preservation in preserve shape solve.


Declaration	`uniform float houdini:hairdeform:preserveclumpsstiffness = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveShapeEnableAttr ( ) const

Enable preserve shape physics solve which targets the hair's original shape, while keeping deformation.


Declaration	`uniform bool houdini:hairdeform:preserveshapeenable = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveShapeIterationsAttr ( ) const

Number of preserve shape physics solve iterations.


Declaration	`uniform int houdini:hairdeform:preserveshapeiterations = 10`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveShapeKBendAttr ( ) const

Bend stiffness for preserve shape solve (Cosserat model).


Declaration	`uniform float houdini:hairdeform:preserveshapekbend = 0.001`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveShapeKStretchAttr ( ) const

Stretch stiffness for preserve shape solve (Cosserat model).


Declaration	`uniform float houdini:hairdeform:preserveshapekstretch = 0.01`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveShapeLockRootsAttr ( ) const

Keep curve root points fixed during preserve shape solve.


Declaration	`uniform bool houdini:hairdeform:preserveshapelockroots = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetPreserveShapeRefPosStrengthAttr ( ) const

Strength of reference position constraint in preserve shape solve.


Declaration	`uniform float houdini:hairdeform:preserveshaperefposstrength = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

static const TfTokenVector& UsdHoudiniHoudiniHairDeformAPI::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.

UsdRelationship UsdHoudiniHoudiniHairDeformAPI::GetSkinPrimRel ( ) const

Hair roots will stick to this mesh.

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetSmoothCaptureAttr ( ) const

Enable smooth RBF-based capture instead of BVH point capture.


Declaration	`uniform bool houdini:hairdeform:smoothcapture = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetSmoothCaptureRadiusAttr ( ) const

Capture radius for smooth RBF capture method.


Declaration	`uniform float houdini:hairdeform:smoothcaptureradius = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetSmoothingLevelAttr ( ) const

Number of smoothing subdivisions for smooth capture.


Declaration	`uniform int houdini:hairdeform:smoothinglevel = 1`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetSmoothingMethodAttr ( ) const

Smoothing method for smooth capture subdivision.


Declaration	`uniform string houdini:hairdeform:smoothingmethod = "approximating"`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String
Variability	SdfVariabilityUniform
Allowed Values	approximating, interpolating, none

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetTetMeshTreatmentAttr ( ) const

How to treat tet meshes in smooth capture geometry.


Declaration	`uniform string houdini:hairdeform:tetmeshtreatment = "as_surface"`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String
Variability	SdfVariabilityUniform
Allowed Values	as_surface, as_solid, none

UsdAttribute UsdHoudiniHoudiniHairDeformAPI::GetUseOrientAttribAttr ( ) const

Use orient/restorient quaternion attributes on the deformer instead of computing transforms from neighbour topology.


Declaration	`uniform bool houdini:hairdeform:useorientattrib = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 134 of file houdiniHairDeformAPI.h.

Member Data Documentation

const UsdSchemaKind UsdHoudiniHoudiniHairDeformAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 48 of file houdiniHairDeformAPI.h.

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

HUSD/UsdHoudini/houdiniHairDeformAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation