usdrt::UsdLuxListAPI

Defined in usdrt/scenegraph/usd/usdLux/listAPI.h

Functions

usdrt::UsdLuxListAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "ListAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::UsdLuxListAPI::CreateLightListCacheBehaviorAttr: See GetLightListCacheBehaviorAttr() , 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::UsdLuxListAPI::CreateLightListRel: See GetLightListRel() , and also Create vs Get Property Methods for when to use Get vs Create.
usdrt::UsdLuxListAPI::GetLightListCacheBehaviorAttr: Controls how the lightList should be interpreted. Valid values are:
usdrt::UsdLuxListAPI::GetLightListRel: Relationship to lights in the scene.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdLuxListAPI::UsdLuxListAPI: Construct a UsdLuxListAPI on the prim held by schemaObj . Should be preferred over UsdLuxListAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::UsdLuxListAPI::UsdLuxListAPI: Construct a UsdLuxListAPI on UsdPrim prim . Equivalent to UsdLuxListAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::UsdLuxListAPI::operator bool: Boolean operator.
usdrt::UsdLuxListAPI::~UsdLuxListAPI: Destructor.

Variables

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

class UsdLuxListAPI : public usdrt::UsdAPISchemaBase 

///

Deprecated:: Use LightListAPI instead

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdLuxTokens. So to set an attribute to the value “rightHanded”, use UsdLuxTokens->rightHanded as the value.

Public Functions

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

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

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

Controls how the lightList should be interpreted. Valid values are:

consumeAndHalt: The lightList should be consulted, and if it exists, treated as a final authoritative statement of any lights that exist at or below this prim, halting recursive discovery of lights.
consumeAndContinue: The lightList should be consulted, but recursive traversal over nameChildren should continue in case additional lights are added by descendants.
ignore: The lightList should be entirely ignored. This provides a simple way to temporarily invalidate an existing cache. This is the fallback behavior.


Declaration	`token lightList:cacheBehavior`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Allowed Values	consumeAndHalt, consumeAndContinue, ignore

inline UsdAttribute CreateLightListCacheBehaviorAttr() const: See GetLightListCacheBehaviorAttr(), 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 UsdRelationship GetLightListRel() const: Relationship to lights in the scene.

inline UsdRelationship CreateLightListRel() const: See GetLightListRel(), and also Create vs Get Property Methods for when to use Get vs Create.

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 UsdLuxListAPI Apply(const UsdPrim &prim)

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