Loading...
Searching...
No Matches
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())
 Construct a UsdLuxListAPI on UsdPrim prim .
 
 UsdLuxListAPI (const UsdSchemaBase &schemaObj)
 Construct a UsdLuxListAPI on the prim held by schemaObj .
 
virtual USDLUX_API ~UsdLuxListAPI ()
 Destructor.
 
USDLUX_API UsdAttribute GetLightListCacheBehaviorAttr () const
 Controls how the lightList should be interpreted.
 
USDLUX_API UsdAttribute CreateLightListCacheBehaviorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetLightListCacheBehaviorAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
 
USDLUX_API UsdRelationship GetLightListRel () const
 Relationship to lights in the scene.
 
USDLUX_API UsdRelationship CreateLightListRel () const
 See GetLightListRel(), and also Create vs Get Property Methods for when to use Get vs Create.
 
USDLUX_API SdfPathSet ComputeLightList (ComputeMode mode) const
 Computes and returns the list of lights and light filters in the stage, optionally consulting a cached result.
 
USDLUX_API void StoreLightList (const SdfPathSet &) const
 Store the given paths as the lightlist for this prim.
 
USDLUX_API void InvalidateLightList () const
 Mark any stored lightlist as invalid, by setting the lightList:cacheBehavior attribute to ignore.
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 Construct a UsdAPISchemaBase on UsdPrim prim .
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 Construct a UsdAPISchemaBase on the prim held by schemaObj .
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor.
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped.
 
bool IsAPISchema () const
 Returns whether this is an API schema or not.
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not.
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not.
 
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is.
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim.
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema.
 
virtual USD_API ~UsdSchemaBase ()
 Destructor.
 
UsdPrim GetPrim () const
 Return this schema object's held prim.
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath().
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null.
 
USD_API operator bool () const
 Return true if this schema object is compatible with its held prim, false otherwise.
 

Static Public Member Functions

static USDLUX_API const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
 
static USDLUX_API UsdLuxListAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdLuxListAPI holding the prim adhering to this schema at path on stage.
 
static USDLUX_API bool CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
 Returns true if this single-apply API schema can be applied to the given prim.
 
static USDLUX_API UsdLuxListAPI Apply (const UsdPrim &prim)
 Applies this single-apply API schema to the given prim.
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
 Compile time constant representing what kind of schema this class is.
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 Compile time constant representing what kind of schema this class is.
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 Compile time constant representing what kind of schema this class is.
 

Protected Member Functions

USDLUX_API UsdSchemaKind _GetSchemaKind () const override
 Returns the kind of schema this class belongs to.
 
- Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind _GetSchemaKind () const override
 Returns the kind of schema this class belongs to.
 
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on UsdPrim prim with the specified instanceName.
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on the prim held by schemaObj with the given instanceName.
 
const TfToken_GetInstanceName () const
 Returns the instance name of the API schema object belonging to a multiple-apply API schema.
 
USD_API bool _IsCompatible () const override
 Check whether this APISchema object is valid for the currently held
prim.
 
- 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
 

Friends

class UsdSchemaRegistry
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector _GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)
 Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.
 

Detailed Description

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.

Definition at line 65 of file listAPI.h.

Member Enumeration Documentation

◆ ComputeMode

Runtime control over whether to consult stored lightList caches.

Enumerator
ComputeModeConsultModelHierarchyCache 

Consult any caches found on the model hierarchy.

Do not traverse beneath the model hierarchy.

ComputeModeIgnoreCache 

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

Definition at line 235 of file listAPI.h.

Constructor & Destructor Documentation

◆ UsdLuxListAPI() [1/2]

UsdLuxListAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

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() [2/2]

UsdLuxListAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

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.

◆ ~UsdLuxListAPI()

virtual USDLUX_API ~UsdLuxListAPI ( )
virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDLUX_API UsdSchemaKind _GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also
UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDLUX_API UsdLuxListAPI Apply ( const UsdPrim prim)
static

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.

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.
See also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

◆ CanApply()

static USDLUX_API bool CanApply ( const UsdPrim prim,
std::string *  whyNot = nullptr 
)
static

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
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

◆ ComputeLightList()

USDLUX_API SdfPathSet 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.

◆ CreateLightListCacheBehaviorAttr()

USDLUX_API UsdAttribute CreateLightListCacheBehaviorAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) 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.

◆ CreateLightListRel()

USDLUX_API UsdRelationship CreateLightListRel ( ) const

See GetLightListRel(), and also Create vs Get Property Methods for when to use Get vs Create.

◆ Get()

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

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:

UsdLuxListAPI(stage->GetPrimAtPath(path));

◆ GetLightListCacheBehaviorAttr()

USDLUX_API 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

◆ GetLightListRel()

USDLUX_API UsdRelationship GetLightListRel ( ) const

Relationship to lights in the scene.

◆ GetSchemaAttributeNames()

static USDLUX_API const TfTokenVector & GetSchemaAttributeNames ( bool  includeInherited = true)
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.

◆ InvalidateLightList()

USDLUX_API void InvalidateLightList ( ) const

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

◆ StoreLightList()

USDLUX_API void 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

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry
friend

Definition at line 163 of file listAPI.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
static

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

See also
UsdSchemaKind

Definition at line 71 of file listAPI.h.


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