All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdLuxListAPI Class Reference

#include <listAPI.h>

+ Inheritance diagram for UsdLuxListAPI:

Public Types

enum  ComputeMode { ComputeModeConsultModelHierarchyCache, ComputeModeIgnoreCache }
 Runtime control over whether to consult stored lightList caches. More...

Public Member Functions

 UsdLuxListAPI (const UsdPrim &prim=UsdPrim())
 UsdLuxListAPI (const UsdSchemaBase &schemaObj)
virtual USDLUX_API ~UsdLuxListAPI ()
 Destructor. More...
USDLUX_API UsdAttribute GetLightListCacheBehaviorAttr () const
USDLUX_API UsdAttribute CreateLightListCacheBehaviorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDLUX_API UsdRelationship GetLightListRel () const
USDLUX_API UsdRelationship CreateLightListRel () const
USDLUX_API SdfPathSet ComputeLightList (ComputeMode mode) const
USDLUX_API void StoreLightList (const SdfPathSet &) const
USDLUX_API void InvalidateLightList () const
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
bool IsTyped () const
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
bool IsAppliedAPISchema () const
bool IsMultipleApplyAPISchema () const
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is. More...
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
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const

Static Public Member Functions

static USDLUX_API const
GetSchemaAttributeNames (bool includeInherited=true)
static USDLUX_API UsdLuxListAPI Get (const UsdStagePtr &stage, const SdfPath &path)
static USDLUX_API bool CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
static USDLUX_API UsdLuxListAPI Apply (const UsdPrim &prim)
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const
GetSchemaAttributeNames (bool includeInherited=true)
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions

USDLUX_API UsdSchemaKind _GetSchemaKind () const override
- Protected Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
const TfToken_GetInstanceName () const
USD_API bool _IsCompatible () const override
- Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind _GetSchemaType () const
const TfType_GetType () const
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const


class UsdSchemaRegistry

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector _GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)

Detailed Description

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.

Definition at line 65 of file listAPI.h.

Member Enumeration Documentation

Runtime control over whether to consult stored lightList caches.


Consult any caches found on the model hierarchy. Do not traverse beneath the model hierarchy.


Ignore any caches found, and do a full prim traversal.

Definition at line 235 of file listAPI.h.

Constructor & Destructor Documentation

UsdLuxListAPI::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

Definition at line 77 of file listAPI.h.

UsdLuxListAPI::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.

Definition at line 85 of file listAPI.h.

virtual USDLUX_API UsdLuxListAPI::~UsdLuxListAPI ( )


Member Function Documentation

USDLUX_API UsdSchemaKind UsdLuxListAPI::_GetSchemaKind ( ) const

Returns the kind of schema this class belongs to.

See Also

Reimplemented from UsdAPISchemaBase.

static USDLUX_API UsdLuxListAPI 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.

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.
See Also
static USDLUX_API bool UsdLuxListAPI::CanApply ( const UsdPrim prim,
std::string whyNot = nullptr 

Returns true if this single-apply API schema can be applied to the given prim. If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also
USDLUX_API SdfPathSet UsdLuxListAPI::ComputeLightList ( ComputeMode  mode) const

Computes and returns the list of lights and light filters in the stage, optionally consulting a cached result.

In ComputeModeIgnoreCache mode, caching is ignored, and this does a prim traversal looking for prims that have a UsdLuxLightAPI or are of type UsdLuxLightFilter.

In ComputeModeConsultModelHierarchyCache, this does a traversal only of the model hierarchy. In this traversal, any lights that live as model hierarchy prims are accumulated, as well as any paths stored in lightList caches. The lightList:cacheBehavior attribute gives further control over the cache behavior; see the class overview for details.

When instances are present, ComputeLightList(ComputeModeIgnoreCache) will return the instance-uniqiue paths to any lights discovered within those instances. Lights within a UsdGeomPointInstancer will not be returned, however, since they cannot be referred to solely via paths.

USDLUX_API UsdAttribute UsdLuxListAPI::CreateLightListCacheBehaviorAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetLightListCacheBehaviorAttr(), 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.

USDLUX_API UsdRelationship UsdLuxListAPI::CreateLightListRel ( ) const

See GetLightListRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create

static USDLUX_API UsdLuxListAPI UsdLuxListAPI::Get ( const UsdStagePtr &  stage,
const SdfPath path 

Return a UsdLuxListAPI 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:

USDLUX_API UsdAttribute UsdLuxListAPI::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
USDLUX_API UsdRelationship UsdLuxListAPI::GetLightListRel ( ) const

Relationship to lights in the scene.

static USDLUX_API const TfTokenVector& UsdLuxListAPI::GetSchemaAttributeNames ( bool  includeInherited = true)

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 void UsdLuxListAPI::InvalidateLightList ( ) const

Mark any stored lightlist as invalid, by setting the lightList:cacheBehavior attribute to ignore.

USDLUX_API void UsdLuxListAPI::StoreLightList ( const SdfPathSet ) const

Store the given paths as the lightlist for this prim. Paths that do not have this prim's path as a prefix will be silently ignored. This will set the listList:cacheBehavior to "consumeAndContinue".

Friends And Related Function Documentation

friend class UsdSchemaRegistry

Definition at line 163 of file listAPI.h.

Member Data Documentation

const UsdSchemaKind UsdLuxListAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

Compile time constant representing what kind of schema this class is.

See Also

Definition at line 71 of file listAPI.h.

The documentation for this class was generated from the following file: