PhysxSchemaPhysxParticleIsosurfaceAPI 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
	PhysxSchemaPhysxParticleIsosurfaceAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxParticleIsosurfaceAPI on UsdPrim prim . More...
	PhysxSchemaPhysxParticleIsosurfaceAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxParticleIsosurfaceAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxParticleIsosurfaceAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetIsosurfaceEnabledAttr () const
	Enable or disable the creation of an isosurface. More...
PHYSXSCHEMA_API UsdAttribute	CreateIsosurfaceEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetIsosurfaceEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxVerticesAttr () const
	Maximum number of vertices the extracted isosurface can have. More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxVerticesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxVerticesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxTrianglesAttr () const
	Maximum number of triangles the extracted isosurface can have. More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxTrianglesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxTrianglesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxSubgridsAttr () const
	Maximum number of blocks the sparse grid structure can contain. More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxSubgridsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxSubgridsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGridSpacingAttr () const
	Cell Size of the grid used for isosurface extraction. More...
PHYSXSCHEMA_API UsdAttribute	CreateGridSpacingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGridSpacingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSurfaceDistanceAttr () const
	Distance from particle center to isosurface. More...
PHYSXSCHEMA_API UsdAttribute	CreateSurfaceDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSurfaceDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGridFilteringPassesAttr () const
	Grid filtering sequence, defined as capital letters "S":Smooth, "G":Grow, "R":Reduce. More...
PHYSXSCHEMA_API UsdAttribute	CreateGridFilteringPassesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGridFilteringPassesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGridSmoothingRadiusAttr () const
	The radius used during the smoothing process on the grid. More...
PHYSXSCHEMA_API UsdAttribute	CreateGridSmoothingRadiusAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGridSmoothingRadiusAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetNumMeshSmoothingPassesAttr () const
	Number of smoothing passes applied to the generated isosurface triangle mesh. More...
PHYSXSCHEMA_API UsdAttribute	CreateNumMeshSmoothingPassesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetNumMeshSmoothingPassesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetNumMeshNormalSmoothingPassesAttr () const
	Number of smoothing passes applied to the normals of the generated isosurface triangle mesh. More...
PHYSXSCHEMA_API UsdAttribute	CreateNumMeshNormalSmoothingPassesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetNumMeshNormalSmoothingPassesAttr(), 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 PhysxSchemaPhysxParticleIsosurfaceAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxParticleIsosurfaceAPI 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 PhysxSchemaPhysxParticleIsosurfaceAPI	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 a PhysxParticleSystem. Defines settings to extract an isosurface from the fluid particles in the particle system. The isosurface extraction is a post-processing step that does not affect the particle dynamics.

Definition at line 59 of file physxParticleIsosurfaceAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxParticleIsosurfaceAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxParticleIsosurfaceAPI on UsdPrim prim .

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

Definition at line 71 of file physxParticleIsosurfaceAPI.h.

PhysxSchemaPhysxParticleIsosurfaceAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxParticleIsosurfaceAPI on the prim held by schemaObj .

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

Definition at line 79 of file physxParticleIsosurfaceAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxParticleIsosurfaceAPI ( )

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

static

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

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

Returns

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

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

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

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

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

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

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

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

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

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

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

static

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

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

PHYSXSCHEMA_API UsdAttribute GetGridFilteringPassesAttr

(

)

const

Grid filtering sequence, defined as capital letters "S":Smooth, "G":Grow, "R":Reduce.

Up to 32 passes.

Declaration	string physxParticleIsosurface:gridFilteringPasses = "GSRS"
C++ Type	std::string
Usd Type	SdfValueTypeNames->String

PHYSXSCHEMA_API UsdAttribute GetGridSmoothingRadiusAttr

(

)

const

The radius used during the smoothing process on the grid.

Default value -inf results in a simulation-determined value. Range: [0, inf) Units: dimensionless

Declaration	float physxParticleIsosurface:gridSmoothingRadius = -inf
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetGridSpacingAttr

(

)

const

Cell Size of the grid used for isosurface extraction.

Default value -inf results in a simulation-determined value. Range: [0, inf) Units: distance

Declaration	float physxParticleIsosurface:gridSpacing = -inf
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetIsosurfaceEnabledAttr

(

)

const

Enable or disable the creation of an isosurface.

Declaration	bool physxParticleIsosurface:isosurfaceEnabled = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetMaxSubgridsAttr

(

)

const

Maximum number of blocks the sparse grid structure can contain.

Range: [1, inf)

Declaration	uniform int physxParticleIsosurface:maxSubgrids = 2048
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

PHYSXSCHEMA_API UsdAttribute GetMaxTrianglesAttr

(

)

const

Maximum number of triangles the extracted isosurface can have.

Range: [1, inf)

Declaration	uniform int physxParticleIsosurface:maxTriangles = 2097152
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

PHYSXSCHEMA_API UsdAttribute GetMaxVerticesAttr

(

)

const

Maximum number of vertices the extracted isosurface can have.

Range: [3, inf)

Declaration	uniform int physxParticleIsosurface:maxVertices = 1048576
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

PHYSXSCHEMA_API UsdAttribute GetNumMeshNormalSmoothingPassesAttr

(

)

const

Number of smoothing passes applied to the normals of the generated isosurface triangle mesh.

Range: [0, inf)

Declaration	int physxParticleIsosurface:numMeshNormalSmoothingPasses = 4
C++ Type	int
Usd Type	SdfValueTypeNames->Int

PHYSXSCHEMA_API UsdAttribute GetNumMeshSmoothingPassesAttr

(

)

const

Number of smoothing passes applied to the generated isosurface triangle mesh.

Range: [0, inf)

Declaration	int physxParticleIsosurface:numMeshSmoothingPasses = 4
C++ Type	int
Usd Type	SdfValueTypeNames->Int

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 GetSurfaceDistanceAttr

(

)

const

Distance from particle center to isosurface.

Default value -inf results in a simulation-determined value. Range: [0, 2.5*gridSpacing) Units: distance

Declaration	float physxParticleIsosurface:surfaceDistance = -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 65 of file physxParticleIsosurfaceAPI.h.

---

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

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