UsdLuxShapingAPI

Fully qualified name: usdrt::UsdLuxShapingAPI

class UsdLuxShapingAPI : public usdrt::UsdAPISchemaBase

Controls for shaping a light’s emission.

Public Functions

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

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.

inline explicit UsdLuxShapingAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~UsdLuxShapingAPI()

Destructor.

inline 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 inputs:shaping:focus = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateShapingFocusAttr() 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.

inline UsdAttribute GetShapingFocusTintAttr() const

Off-axis color tint. This tints the emission in the falloff region. The default tint is black. TODO: clarify semantics.

Declaration	color3f inputs:shaping:focusTint = (0, 0, 0)
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Color3f

inline UsdAttribute CreateShapingFocusTintAttr() 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.

inline UsdAttribute GetShapingConeAngleAttr() const

Angular limit off the primary axis to restrict the light spread.

Declaration	float inputs:shaping:cone:angle = 90
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateShapingConeAngleAttr() 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.

inline UsdAttribute GetShapingConeSoftnessAttr() const

Controls the cutoff softness for cone angle. TODO: clarify semantics.

Declaration	float inputs:shaping:cone:softness = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateShapingConeSoftnessAttr() 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.

inline UsdAttribute GetShapingIesFileAttr() const

An IES (Illumination Engineering Society) light profile describing the angular distribution of light.

Declaration	asset inputs:shaping:ies:file
C++ Type	SdfAssetPath
Usd Type	SdfValueTypeNames->Asset

inline UsdAttribute CreateShapingIesFileAttr() 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.

inline UsdAttribute GetShapingIesAngleScaleAttr() const

Rescales the angular distribution of the IES profile. TODO: clarify semantics.

Declaration	float inputs:shaping:ies:angleScale = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateShapingIesAngleScaleAttr() 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.

inline UsdAttribute GetShapingIesNormalizeAttr() const

Normalizes the IES profile so that it affects the shaping of the light while preserving the overall energy output.

Declaration	bool inputs:shaping:ies:normalize = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateShapingIesNormalizeAttr() 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.

UsdPrim GetPrim() const

Return this schema object’s held prim.

SdfPath GetPath() const

Return the SdfPath to this schema object’s held prim.

inline explicit operator bool() const

Check if this schema object is compatible with it’s held prim and that the prim is valid.

A typed schema object is compatible if the held prim’s type is or is a subtype of the schema’s type. Based on prim.IsA().

An API schema object is compatible if the API is of type SingleApplyAPI or UsdSchemaType::MultipleApplyAPI, and the schema has been applied to the prim. Based on prim.HasAPI.

This method invokes polymorphic behaviour.

See also

UsdSchemaBase::_IsCompatible()

Returns:

True if the help prim is valid, and the schema object is compatible with its held prim.

Public Static Functions

static inline UsdLuxShapingAPI Apply(const UsdPrim &prim)

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.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns:

A valid UsdLuxShapingAPI object is returned upon success. An invalid (or empty) UsdLuxShapingAPI 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.

inline virtual bool _IsCompatible() const

Check whether this APISchema object is valid for the currently held prim.

If this is an applied API schema, this returns true if the held prim is valid and already has the API schema applied to it, along with the instanceName (in the case of multiple-apply). The instanceName should not be empty in the case of a multiple-apply API schema.

This check is performed when clients invoke the explicit bool conversion operator, implemented in UsdSchemaBase.

See also

UsdPrim::HasAPI()

inline const TfToken _GetType() const

Helper for subclasses to get this schema’s type token.

Note

This diverges from Usd and returns a TfToken, since we don’t implements TfType.

Returns:

The token representing the schema’s TfType.