![]() |
Controls for shaping a light's emission. More...
Public Member Functions | |
UsdLuxShapingAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdLuxShapingAPI on UsdPrim prim . More... | |
UsdLuxShapingAPI (const UsdSchemaBase &schemaObj) | |
Construct a UsdLuxShapingAPI on the prim held by schemaObj . More... | |
virtual USDLUX_API | ~UsdLuxShapingAPI () |
Destructor. More... | |
USDLUX_API UsdAttribute | GetShapingFocusAttr () const |
A control to shape the spread of light. More... | |
USDLUX_API UsdAttribute | CreateShapingFocusAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetShapingFocusAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDLUX_API UsdAttribute | GetShapingFocusTintAttr () const |
Off-axis color tint. More... | |
USDLUX_API UsdAttribute | CreateShapingFocusTintAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetShapingFocusTintAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDLUX_API UsdAttribute | GetShapingConeAngleAttr () const |
Angular limit off the primary axis to restrict the light spread. More... | |
USDLUX_API UsdAttribute | CreateShapingConeAngleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetShapingConeAngleAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDLUX_API UsdAttribute | GetShapingConeSoftnessAttr () const |
Controls the cutoff softness for cone angle. More... | |
USDLUX_API UsdAttribute | CreateShapingConeSoftnessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetShapingConeSoftnessAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDLUX_API UsdAttribute | GetShapingIesFileAttr () const |
An IES (Illumination Engineering Society) light profile describing the angular distribution of light. More... | |
USDLUX_API UsdAttribute | CreateShapingIesFileAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetShapingIesFileAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDLUX_API UsdAttribute | GetShapingIesAngleScaleAttr () const |
Rescales the angular distribution of the IES profile. More... | |
USDLUX_API UsdAttribute | CreateShapingIesAngleScaleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetShapingIesAngleScaleAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDLUX_API UsdAttribute | GetShapingIesNormalizeAttr () const |
Normalizes the IES profile so that it affects the shaping of the light while preserving the overall energy output. More... | |
USDLUX_API UsdAttribute | CreateShapingIesNormalizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetShapingIesNormalizeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
![]() | |
UsdAPISchemaBase (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdAPISchemaBase on UsdPrim prim . More... | |
UsdAPISchemaBase (const UsdSchemaBase &schemaObj) | |
Construct a UsdAPISchemaBase on the prim held by schemaObj . More... | |
virtual USD_API | ~UsdAPISchemaBase ()=0 |
Destructor. More... | |
![]() | |
bool | IsConcrete () const |
Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. More... | |
bool | IsTyped () const |
Returns whether or not this class inherits from UsdTyped. More... | |
bool | IsAPISchema () const |
Returns whether this is an API schema or not. More... | |
bool | IsAppliedAPISchema () const |
Returns whether this is an applied API schema or not. More... | |
bool | IsMultipleApplyAPISchema () const |
Returns whether this is an applied API schema or not. More... | |
UsdSchemaKind | GetSchemaKind () const |
Returns the kind of schema this class is. More... | |
UsdSchemaKind | GetSchemaType () const |
USD_API | UsdSchemaBase (const UsdPrim &prim=UsdPrim()) |
Construct and store prim as the held prim. More... | |
USD_API | UsdSchemaBase (const UsdSchemaBase &otherSchema) |
Construct and store for the same prim held by otherSchema . More... | |
virtual USD_API | ~UsdSchemaBase () |
Destructor. More... | |
USD_API | operator bool () const |
Return true if this schema object is compatible with its held prim, false otherwise. More... | |
UsdPrim | GetPrim () const |
Return this schema object's held prim. More... | |
SdfPath | GetPath () const |
Shorthand for GetPrim()->GetPath(). More... | |
USD_API const UsdPrimDefinition * | GetSchemaClassPrimDefinition () const |
Return the prim definition associated with this schema instance if one exists, otherwise return null. More... | |
Static Public Member Functions | |
static USDLUX_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 USDLUX_API UsdLuxShapingAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdLuxShapingAPI holding the prim adhering to this schema at path on stage . More... | |
static USDLUX_API UsdLuxShapingAPI | Apply (const UsdPrim &prim) |
Applies this single-apply API schema to the given prim . More... | |
![]() | |
static USD_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 const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::SingleApplyAPI |
Compile time constant representing what kind of schema this class is. More... | |
static const UsdSchemaKind | schemaType = UsdSchemaKind::SingleApplyAPI |
![]() | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. More... | |
static const UsdSchemaKind | schemaType = UsdSchemaKind::AbstractBase |
![]() | |
static const UsdSchemaKind | schemaKind = UsdSchemaType::AbstractBase |
Compile time constant representing what kind of schema this class is. More... | |
static const UsdSchemaKind | schemaType = UsdSchemaKind::AbstractBase |
Protected Member Functions | |
USDLUX_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. More... | |
USDLUX_API UsdSchemaKind | _GetSchemaType () const override |
![]() | |
UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName) | |
Construct a multiple-apply UsdAPISchemaBase on UsdPrim prim with the specified instanceName . More... | |
UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName) | |
Construct a multiple-apply UsdAPISchemaBase on the prim held by schemaObj with the given instanceName . More... | |
const TfToken & | _GetInstanceName () const |
Returns the instance name of the API schema object belonging to a multiple-apply API schema. More... | |
USD_API bool | _IsCompatible () const override |
Check whether this APISchema object is valid for the currently held prim. More... | |
![]() | |
const TfType & | _GetType () const |
USD_API UsdAttribute | _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const |
Friends | |
class | UsdSchemaRegistry |
Additional Inherited Members | |
![]() | |
template<typename APISchemaType > | |
static APISchemaType | _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName) |
Helper method to apply a single-apply API schema with the given schema name apiSchemaName' and C++ type 'APISchemaType'. More... | |
template<typename APISchemaType > | |
static APISchemaType | _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName) |
Helper method to apply a multiple-apply API schema with the given schema name apiSchemaName' , C++ type 'APISchemaType' and instance name instanceName . More... | |
Controls for shaping a light's emission.
Definition at line 57 of file shapingAPI.h.
|
inlineexplicit |
Construct a UsdLuxShapingAPI on UsdPrim prim
.
Equivalent to UsdLuxShapingAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim
, but will not immediately throw an error for an invalid prim
Definition at line 74 of file shapingAPI.h.
|
inlineexplicit |
Construct a UsdLuxShapingAPI on the prim held by schemaObj
.
Should be preferred over UsdLuxShapingAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 82 of file shapingAPI.h.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdAPISchemaBase.
|
overrideprotectedvirtual |
Reimplemented from UsdAPISchemaBase.
|
static |
Applies this single-apply API schema to the given prim
.
This information is stored by adding "ShapingAPI" to the token-valued, listOp metadata apiSchemas on the prim.
USDLUX_API UsdAttribute CreateShapingConeAngleAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetShapingConeAngleAttr(), 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
.
USDLUX_API UsdAttribute CreateShapingConeSoftnessAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetShapingConeSoftnessAttr(), 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
.
USDLUX_API UsdAttribute CreateShapingFocusAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetShapingFocusAttr(), 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
.
USDLUX_API UsdAttribute CreateShapingFocusTintAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetShapingFocusTintAttr(), 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
.
USDLUX_API UsdAttribute CreateShapingIesAngleScaleAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetShapingIesAngleScaleAttr(), 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
.
USDLUX_API UsdAttribute CreateShapingIesFileAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetShapingIesFileAttr(), 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
.
USDLUX_API UsdAttribute CreateShapingIesNormalizeAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetShapingIesNormalizeAttr(), 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
.
|
static |
Return a UsdLuxShapingAPI 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:
|
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.
USDLUX_API UsdAttribute GetShapingConeAngleAttr | ( | ) | const |
Angular limit off the primary axis to restrict the light spread.
Declaration | float shaping:cone:angle = 90 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDLUX_API UsdAttribute GetShapingConeSoftnessAttr | ( | ) | const |
Controls the cutoff softness for cone angle.
TODO: clarify semantics
Declaration | float shaping:cone:softness = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDLUX_API UsdAttribute GetShapingFocusAttr | ( | ) | const |
A control to shape the spread of light.
Higher focus values pull light towards the center and narrow the spread. Implemented as an off-axis cosine power exponent. TODO: clarify semantics
Declaration | float shaping:focus = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDLUX_API UsdAttribute GetShapingFocusTintAttr | ( | ) | const |
USDLUX_API UsdAttribute GetShapingIesAngleScaleAttr | ( | ) | const |
Rescales the angular distribution of the IES profile.
TODO: clarify semantics
Declaration | float shaping:ies:angleScale = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDLUX_API UsdAttribute GetShapingIesFileAttr | ( | ) | const |
An IES (Illumination Engineering Society) light profile describing the angular distribution of light.
Declaration | asset shaping:ies:file |
C++ Type | SdfAssetPath |
Usd Type | SdfValueTypeNames->Asset |
USDLUX_API UsdAttribute GetShapingIesNormalizeAttr | ( | ) | const |
Normalizes the IES profile so that it affects the shaping of the light while preserving the overall energy output.
Declaration | bool shaping:ies:normalize = 0 |
C++ Type | bool |
Usd Type | SdfValueTypeNames->Bool |
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 63 of file shapingAPI.h.
|
static |
Definition at line 68 of file shapingAPI.h.