usdrt::PhysxSchemaPhysxParticleIsosurfaceAPI

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

Functions

Variables

class PhysxSchemaPhysxParticleIsosurfaceAPI : public usdrt::UsdAPISchemaBase

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.

Public Functions

inline explicit PhysxSchemaPhysxParticleIsosurfaceAPI(const UsdPrim &prim = UsdPrim())

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.

inline explicit PhysxSchemaPhysxParticleIsosurfaceAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~PhysxSchemaPhysxParticleIsosurfaceAPI()

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 GetIsosurfaceEnabledAttr() const

Enable or disable the creation of an isosurface.

Declaration

bool physxParticleIsosurface:isosurfaceEnabled = 1

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateIsosurfaceEnabledAttr() const

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

inline UsdAttribute CreateMaxVerticesAttr() const

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

inline UsdAttribute CreateMaxTrianglesAttr() const

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

inline UsdAttribute CreateMaxSubgridsAttr() const

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

inline UsdAttribute CreateGridSpacingAttr() const

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

inline UsdAttribute CreateSurfaceDistanceAttr() const

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

inline UsdAttribute CreateGridFilteringPassesAttr() const

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

inline UsdAttribute CreateGridSmoothingRadiusAttr() const

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

inline UsdAttribute CreateNumMeshSmoothingPassesAttr() const

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

inline UsdAttribute CreateNumMeshNormalSmoothingPassesAttr() const

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

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.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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.

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.