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

#include <volumeLightAPI.h>

+ Inheritance diagram for UsdLuxVolumeLightAPI:

Public Member Functions

 UsdLuxVolumeLightAPI (const UsdPrim &prim=UsdPrim())
 UsdLuxVolumeLightAPI (const UsdSchemaBase &schemaObj)
virtual USDLUX_API ~UsdLuxVolumeLightAPI ()
 Destructor. More...
- 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)
Get (const UsdStagePtr &stage, const SdfPath &path)
static USDLUX_API bool CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
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

Detailed Description

This is the preferred API schema to apply to Volume type prims when adding light behaviors to a volume. At its base, this API schema has the built-in behavior of applying LightAPI to the volume and overriding the default materialSyncMode to allow the emission/glow of the bound material to affect the color of the light. But, it additionally serves as a hook for plugins to attach additional properties to "volume lights" through the creation of API schemas which are authored to auto-apply to VolumeLightAPI.

See Also

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 71 of file volumeLightAPI.h.

Constructor & Destructor Documentation

UsdLuxVolumeLightAPI::UsdLuxVolumeLightAPI ( const UsdPrim prim = UsdPrim())

Construct a UsdLuxVolumeLightAPI on UsdPrim prim . Equivalent to UsdLuxVolumeLightAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 83 of file volumeLightAPI.h.

UsdLuxVolumeLightAPI::UsdLuxVolumeLightAPI ( const UsdSchemaBase schemaObj)

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

Definition at line 91 of file volumeLightAPI.h.

virtual USDLUX_API UsdLuxVolumeLightAPI::~UsdLuxVolumeLightAPI ( )


Member Function Documentation

USDLUX_API UsdSchemaKind UsdLuxVolumeLightAPI::_GetSchemaKind ( ) const

Returns the kind of schema this class belongs to.

See Also

Reimplemented from UsdAPISchemaBase.

static USDLUX_API UsdLuxVolumeLightAPI UsdLuxVolumeLightAPI::Apply ( const UsdPrim prim)

Applies this single-apply API schema to the given prim. This information is stored by adding "VolumeLightAPI" to the token-valued, listOp metadata apiSchemas on the prim.

A valid UsdLuxVolumeLightAPI object is returned upon success. An invalid (or empty) UsdLuxVolumeLightAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
static USDLUX_API bool UsdLuxVolumeLightAPI::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
static USDLUX_API UsdLuxVolumeLightAPI UsdLuxVolumeLightAPI::Get ( const UsdStagePtr &  stage,
const SdfPath path 

Return a UsdLuxVolumeLightAPI 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 USDLUX_API const TfTokenVector& UsdLuxVolumeLightAPI::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.

Friends And Related Function Documentation

friend class UsdSchemaRegistry

Definition at line 169 of file volumeLightAPI.h.

Member Data Documentation

const UsdSchemaKind UsdLuxVolumeLightAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

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

See Also

Definition at line 77 of file volumeLightAPI.h.

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