PhysxSchemaPhysxConvexDecompositionCollisionAPI Class Reference

PhysX convex decomposition extended parameters. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxConvexDecompositionCollisionAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxConvexDecompositionCollisionAPI on UsdPrim prim . More...
	PhysxSchemaPhysxConvexDecompositionCollisionAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxConvexDecompositionCollisionAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxConvexDecompositionCollisionAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetHullVertexLimitAttr () const
	Convex hull vertex limit used for convex hull cooking. More...
PHYSXSCHEMA_API UsdAttribute	CreateHullVertexLimitAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetHullVertexLimitAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxConvexHullsAttr () const
	Maximum of convex hulls created during convex decomposition. More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxConvexHullsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxConvexHullsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMinThicknessAttr () const
	Convex hull min thickness. More...
PHYSXSCHEMA_API UsdAttribute	CreateMinThicknessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMinThicknessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetVoxelResolutionAttr () const
	Voxel resolution used for convex decomposition. More...
PHYSXSCHEMA_API UsdAttribute	CreateVoxelResolutionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetVoxelResolutionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetErrorPercentageAttr () const
	Convex decomposition errorPercentage parameter. More...
PHYSXSCHEMA_API UsdAttribute	CreateErrorPercentageAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetErrorPercentageAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetShrinkWrapAttr () const
	Attempts to adjust the convex hull points so that they are projected onto the surface of the original graphics mesh. More...
PHYSXSCHEMA_API UsdAttribute	CreateShrinkWrapAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetShrinkWrapAttr(), 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 PhysxSchemaPhysxConvexDecompositionCollisionAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxConvexDecompositionCollisionAPI 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 PhysxSchemaPhysxConvexDecompositionCollisionAPI	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

PhysX convex decomposition extended parameters.

Definition at line 57 of file physxConvexDecompositionCollisionAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxConvexDecompositionCollisionAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxConvexDecompositionCollisionAPI on UsdPrim prim .

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

Definition at line 69 of file physxConvexDecompositionCollisionAPI.h.

PhysxSchemaPhysxConvexDecompositionCollisionAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxConvexDecompositionCollisionAPI on the prim held by schemaObj .

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

Definition at line 77 of file physxConvexDecompositionCollisionAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxConvexDecompositionCollisionAPI ( )

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 PhysxSchemaPhysxConvexDecompositionCollisionAPI Apply ( const UsdPrim &  prim )

static

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

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

Returns

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

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

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

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

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

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

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

static

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

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

PHYSXSCHEMA_API UsdAttribute GetErrorPercentageAttr

(

)

const

Convex decomposition errorPercentage parameter.

Declaration	float physxConvexDecompositionCollision:errorPercentage = 10
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetHullVertexLimitAttr

(

)

const

Convex hull vertex limit used for convex hull cooking.

Declaration	int physxConvexDecompositionCollision:hullVertexLimit = 64
C++ Type	int
Usd Type	SdfValueTypeNames->Int

PHYSXSCHEMA_API UsdAttribute GetMaxConvexHullsAttr

(

)

const

Maximum of convex hulls created during convex decomposition.

Declaration	int physxConvexDecompositionCollision:maxConvexHulls = 32
C++ Type	int
Usd Type	SdfValueTypeNames->Int

PHYSXSCHEMA_API UsdAttribute GetMinThicknessAttr

(

)

const

Convex hull min thickness.

Range: [0, inf) Units: distance

Declaration	float physxConvexDecompositionCollision:minThickness = 0.001
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 GetShrinkWrapAttr

(

)

const

Attempts to adjust the convex hull points so that they are projected onto the surface of the original graphics mesh.

Declaration	bool physxConvexDecompositionCollision:shrinkWrap = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetVoxelResolutionAttr

(

)

const

Voxel resolution used for convex decomposition.

Declaration	int physxConvexDecompositionCollision:voxelResolution = 500000
C++ Type	int
Usd Type	SdfValueTypeNames->Int

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

---

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

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