usdrt::PhysxSchemaPhysxParticleAnisotropyAPI

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

Functions

usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxParticleAnisotropyAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::CreateMaxAttr: See GetMaxAttr() , 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 .
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::CreateMinAttr: See GetMinAttr() , 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 .
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::CreateParticleAnisotropyEnabledAttr: See GetParticleAnisotropyEnabledAttr() , 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 .
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::CreateScaleAttr: See GetScaleAttr() , 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 .
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::GetMaxAttr: Maximum scale of anisotropy relative to fluidRestOffset for rendering. Range: [min, inf) Units: dimensionless.
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::GetMinAttr: Minimum scale of anisotropy relative to fluidRestOffset for rendering. Range: [0, max] Units: dimensionless.
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::GetParticleAnisotropyEnabledAttr: Enables use of fluid anisotropy information for rendering.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::GetScaleAttr: Scale of anisotropy for rendering. Range: [0, inf) Units: dimensionless.
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::PhysxSchemaPhysxParticleAnisotropyAPI: Construct a PhysxSchemaPhysxParticleAnisotropyAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxParticleAnisotropyAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::PhysxSchemaPhysxParticleAnisotropyAPI: Construct a PhysxSchemaPhysxParticleAnisotropyAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxParticleAnisotropyAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::~PhysxSchemaPhysxParticleAnisotropyAPI: Destructor.

Variables

usdrt::PhysxSchemaPhysxParticleAnisotropyAPI::schemaType: Compile time constant representing what kind of schema this class is.

class PhysxSchemaPhysxParticleAnisotropyAPI : 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 compute anisotropic scaling of particles in a post-processing step. The anisotropy post-processing only affects the rendering output including isosurface generation, and not the particle dynamics. Affects point instancer primitives with PhysxParticleSetAPI, which are defined as fluid.

Public Functions

inline explicit PhysxSchemaPhysxParticleAnisotropyAPI(const UsdPrim &prim = UsdPrim()): Construct a PhysxSchemaPhysxParticleAnisotropyAPI on UsdPrim prim. Equivalent to PhysxSchemaPhysxParticleAnisotropyAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxParticleAnisotropyAPI(const UsdSchemaBase &schemaObj): Construct a PhysxSchemaPhysxParticleAnisotropyAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxParticleAnisotropyAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxParticleAnisotropyAPI(): 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 GetParticleAnisotropyEnabledAttr() const

Enables use of fluid anisotropy information for rendering.


Declaration	`bool physxParticleAnisotropy:particleAnisotropyEnabled = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateParticleAnisotropyEnabledAttr() const: See GetParticleAnisotropyEnabledAttr(), 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 GetScaleAttr() const

Scale of anisotropy for rendering. Range: [0, inf) Units: dimensionless.


Declaration	`float physxParticleAnisotropy:scale = 1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateScaleAttr() const: See GetScaleAttr(), 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 GetMinAttr() const

Minimum scale of anisotropy relative to fluidRestOffset for rendering. Range: [0, max] Units: dimensionless.


Declaration	`float physxParticleAnisotropy:min = 0.2`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMinAttr() const: See GetMinAttr(), 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 GetMaxAttr() const

Maximum scale of anisotropy relative to fluidRestOffset for rendering. Range: [min, inf) Units: dimensionless.


Declaration	`float physxParticleAnisotropy:max = 2`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateMaxAttr() const: See GetMaxAttr(), 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 PhysxSchemaPhysxParticleAnisotropyAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxParticleAnisotropyAPI” 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 PhysxSchemaPhysxParticleAnisotropyAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxParticleAnisotropyAPI 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.