PhysxSchemaPhysxIsosurfaceAPI Class Reference

Applied to a PhysxParticleSystem. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxIsosurfaceAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxIsosurfaceAPI on UsdPrim prim . More...
	PhysxSchemaPhysxIsosurfaceAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxIsosurfaceAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxIsosurfaceAPI ()
	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	GetKernelRadiusAttr () const
	Radius of the kernel used to transfer the density to the isosurface grid. More...
PHYSXSCHEMA_API UsdAttribute	CreateKernelRadiusAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetKernelRadiusAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetIsosurfaceLevelAttr () const
	The level at which the isosurface is located. More...
PHYSXSCHEMA_API UsdAttribute	CreateIsosurfaceLevelAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetIsosurfaceLevelAttr(), 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	GetGridSmoothingRadiusRelativeToCellSizeAttr () const
	The radius used during the smoothing process on the grid. More...
PHYSXSCHEMA_API UsdAttribute	CreateGridSmoothingRadiusRelativeToCellSizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGridSmoothingRadiusRelativeToCellSizeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetEnableAnisotropyAttr () const
	Enables usage of anisotropy information during isosurface extraction process. More...
PHYSXSCHEMA_API UsdAttribute	CreateEnableAnisotropyAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetEnableAnisotropyAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetAnisotropyMinAttr () const
	The minimal scale anisotropy can apply to a particle radius. More...
PHYSXSCHEMA_API UsdAttribute	CreateAnisotropyMinAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetAnisotropyMinAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetAnisotropyMaxAttr () const
	The maximal scale anisotropy can apply to a particle radius. More...
PHYSXSCHEMA_API UsdAttribute	CreateAnisotropyMaxAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetAnisotropyMaxAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetAnisotropyRadiusAttr () const
	Radius that defines the size of the neighborhood used to determine the anisotropy information. More...
PHYSXSCHEMA_API UsdAttribute	CreateAnisotropyRadiusAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetAnisotropyRadiusAttr(), 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...

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 PhysxSchemaPhysxIsosurfaceAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxIsosurfaceAPI holding the prim adhering to this schema at path on stage. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxIsosurfaceAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given prim. More...

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

Protected Member Functions
PHYSXSCHEMA_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

Applied to a PhysxParticleSystem.

Defines settings to extract an isosurface from the particles in the particle system.

Definition at line 58 of file physxIsosurfaceAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxIsosurfaceAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxIsosurfaceAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxIsosurfaceAPI::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 physxIsosurfaceAPI.h.

PhysxSchemaPhysxIsosurfaceAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxIsosurfaceAPI on the prim held by schemaObj .

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

Definition at line 78 of file physxIsosurfaceAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxIsosurfaceAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType ( ) const

overrideprotected

Returns the type of schema this class belongs to.

See Also

UsdSchemaType

static PHYSXSCHEMA_API PhysxSchemaPhysxIsosurfaceAPI Apply ( const UsdPrim &  prim )

static

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

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

Returns

A valid PhysxSchemaPhysxIsosurfaceAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxIsosurfaceAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

See Also

UsdPrim::GetAppliedSchemas()

UsdPrim::HasAPI()

UsdPrim::ApplyAPI()

UsdPrim::RemoveAPI()

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

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

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

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

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

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

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

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

static PHYSXSCHEMA_API PhysxSchemaPhysxIsosurfaceAPI Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

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

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

PHYSXSCHEMA_API UsdAttribute GetAnisotropyMaxAttr

(

)

const

The maximal scale anisotropy can apply to a particle radius.

Range: [anisotropyMin, inf) Units: dimensionless

Declaration	float physxIsosurface:anisotropyMax = 2
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetAnisotropyMinAttr

(

)

const

The minimal scale anisotropy can apply to a particle radius.

Range: [0, anisotropyMax] Units: dimensionless

Declaration	float physxIsosurface:anisotropyMin = 0.1
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetAnisotropyRadiusAttr

(

)

const

Radius that defines the size of the neighborhood used to determine the anisotropy information.

Range: [0, inf) Units: distance

Declaration	float physxIsosurface:anisotropyRadius = 0.5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetEnableAnisotropyAttr

(

)

const

Enables usage of anisotropy information during isosurface extraction process.

Declaration	bool physxIsosurface:enableAnisotropy = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetGridFilteringPassesAttr

(

)

const

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

Up to 8 passes, every pass can consist of up to 4 repetitions.

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

PHYSXSCHEMA_API UsdAttribute GetGridSmoothingRadiusRelativeToCellSizeAttr

(

)

const

The radius used during the smoothing process on the grid.

It is measured relative to the grid's cell size. Range: [0, inf) Units: dimensionless

Declaration	float physxIsosurface:gridSmoothingRadiusRelativeToCellSize = 0.5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetGridSpacingAttr

(

)

const

Cell Size of the grid used for isosurface extraction.

Range: (0, inf) Units: distance

Declaration	float physxIsosurface:gridSpacing = 0.25
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetIsoSurfaceEnabledAttr

(

)

const

Enable or disable the creation of an isosurface.

Declaration	bool physxIsosurface:isoSurfaceEnabled = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetIsosurfaceLevelAttr

(

)

const

The level at which the isosurface is located.

Allows to control the droplet size. The signed distance field is more negative towards the center of the fluid and positive outside. Range: (-inf, inf) Units: distance

Declaration	float physxIsosurface:isosurfaceLevel = -0.3
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetKernelRadiusAttr

(

)

const

Radius of the kernel used to transfer the density to the isosurface grid.

Range: (0, inf) Units: distance

Declaration	float physxIsosurface:kernelRadius = 0.5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMaxSubgridsAttr

(

)

const

Maximum number of blocks the sparse grid structure can contain.

Range: [1, inf)

Declaration	int physxIsosurface:maxSubgrids = 1024
C++ Type	int
Usd Type	SdfValueTypeNames->Int

PHYSXSCHEMA_API UsdAttribute GetMaxTrianglesAttr

(

)

const

Maximum number of triangles the extracted isosurface can have.

Range: [1, inf)

Declaration	int physxIsosurface:maxTriangles = 2097152
C++ Type	int
Usd Type	SdfValueTypeNames->Int

PHYSXSCHEMA_API UsdAttribute GetMaxVerticesAttr

(

)

const

Maximum number of vertices the extracted isosurface can have.

Range: [3, inf)

Declaration	int physxIsosurface:maxVertices = 1048576
C++ Type	int
Usd Type	SdfValueTypeNames->Int

PHYSXSCHEMA_API UsdAttribute GetNumMeshSmoothingPassesAttr

(

)

const

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

Using an even number of passes leads to less shrinking. Range: [0, inf)

Declaration	int physxIsosurface:numMeshSmoothingPasses = 2
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.

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

static

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

See Also

UsdSchemaType

Definition at line 64 of file physxIsosurfaceAPI.h.

---

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

• W:/919a5455eee1e83c/src/physxSchema/physxIsosurfaceAPI.h