WARNING: This is a draft API; the design is not fixed and may change in the future. More...
Inherits UsdAPISchemaBase.
Public Member Functions | |
PhysxSchemaPhysxParticleAnisotropyAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxParticleAnisotropyAPI on UsdPrim prim . More... | |
PhysxSchemaPhysxParticleAnisotropyAPI (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxParticleAnisotropyAPI on the prim held by schemaObj . More... | |
virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxParticleAnisotropyAPI () |
Destructor. More... | |
PHYSXSCHEMA_API UsdAttribute | GetParticleAnisotropyEnabledAttr () const |
Enables use of fluid anisotropy information for rendering. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateParticleAnisotropyEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetParticleAnisotropyEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetScaleAttr () const |
Scale of anisotropy for rendering. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateScaleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetScaleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetMinAttr () const |
Minimum scale of anisotropy relative to fluidRestOffset for rendering. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateMinAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetMinAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetMaxAttr () const |
Maximum scale of anisotropy relative to fluidRestOffset for rendering. More... | |
PHYSXSCHEMA_API UsdAttribute | CreateMaxAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetMaxAttr(), 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 PhysxSchemaPhysxParticleAnisotropyAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxParticleAnisotropyAPI holding the prim adhering to this schema at path on stage . More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleAnisotropyAPI | 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 |
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.
Definition at line 60 of file physxParticleAnisotropyAPI.h.
|
inlineexplicit |
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
Definition at line 72 of file physxParticleAnisotropyAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxParticleAnisotropyAPI on the prim held by schemaObj
.
Should be preferred over PhysxSchemaPhysxParticleAnisotropyAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 80 of file physxParticleAnisotropyAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the type of schema this class belongs to.
|
static |
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.
PHYSXSCHEMA_API UsdAttribute CreateMaxAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetMaxAttr(), 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 CreateMinAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetMinAttr(), 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 CreateParticleAnisotropyEnabledAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetParticleAnisotropyEnabledAttr(), 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 CreateScaleAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetScaleAttr(), 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 |
Return a PhysxSchemaPhysxParticleAnisotropyAPI 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:
PHYSXSCHEMA_API 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 |
PHYSXSCHEMA_API 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 |
PHYSXSCHEMA_API UsdAttribute GetParticleAnisotropyEnabledAttr | ( | ) | const |
Enables use of fluid anisotropy information for rendering.
Declaration | bool physxParticleAnisotropy:particleAnisotropyEnabled = 1 |
C++ Type | bool |
Usd Type | SdfValueTypeNames->Bool |
PHYSXSCHEMA_API 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 |
|
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.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 66 of file physxParticleAnisotropyAPI.h.