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

#include <nonboundableLightBase.h>

+ Inheritance diagram for UsdLuxNonboundableLightBase:

Public Member Functions

 UsdLuxNonboundableLightBase (const UsdPrim &prim=UsdPrim())
 
 UsdLuxNonboundableLightBase (const UsdSchemaBase &schemaObj)
 
virtual USDLUX_API ~UsdLuxNonboundableLightBase ()
 Destructor. More...
 
LightAPI

Convenience accessors for the light's built-in UsdLuxLightAPI

USDLUX_API UsdLuxLightAPI LightAPI () const
 Contructs and returns a UsdLuxLightAPI object for this light. More...
 
USDLUX_API UsdAttribute GetIntensityAttr () const
 See UsdLuxLightAPI::GetIntensityAttr(). More...
 
USDLUX_API UsdAttribute CreateIntensityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdLuxLightAPI::CreateIntensityAttr(). More...
 
USDLUX_API UsdAttribute GetExposureAttr () const
 See UsdLuxLightAPI::GetExposureAttr(). More...
 
USDLUX_API UsdAttribute CreateExposureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdLuxLightAPI::CreateExposureAttr(). More...
 
USDLUX_API UsdAttribute GetDiffuseAttr () const
 See UsdLuxLightAPI::GetDiffuseAttr(). More...
 
USDLUX_API UsdAttribute CreateDiffuseAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdLuxLightAPI::CreateDiffuseAttr(). More...
 
USDLUX_API UsdAttribute GetSpecularAttr () const
 See UsdLuxLightAPI::GetSpecularAttr(). More...
 
USDLUX_API UsdAttribute CreateSpecularAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdLuxLightAPI::CreateSpecularAttr(). More...
 
USDLUX_API UsdAttribute GetNormalizeAttr () const
 See UsdLuxLightAPI::GetNormalizeAttr(). More...
 
USDLUX_API UsdAttribute CreateNormalizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdLuxLightAPI::CreateNormalizeAttr(). More...
 
USDLUX_API UsdAttribute GetColorAttr () const
 See UsdLuxLightAPI::GetColorAttr(). More...
 
USDLUX_API UsdAttribute CreateColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdLuxLightAPI::CreateColorAttr(). More...
 
USDLUX_API UsdAttribute GetEnableColorTemperatureAttr () const
 See UsdLuxLightAPI::GetEnableColorTemperatureAttr(). More...
 
USDLUX_API UsdAttribute CreateEnableColorTemperatureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdLuxLightAPI::CreateEnableColorTemperatureAttr(). More...
 
USDLUX_API UsdAttribute GetColorTemperatureAttr () const
 See UsdLuxLightAPI::GetColorTemperatureAttr(). More...
 
USDLUX_API UsdAttribute CreateColorTemperatureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdLuxLightAPI::CreateColorTemperatureAttr(). More...
 
USDLUX_API UsdRelationship GetFiltersRel () const
 See UsdLuxLightAPI::GetFiltersRel(). More...
 
USDLUX_API UsdRelationship CreateFiltersRel () const
 See UsdLuxLightAPI::CreateFiltersRel(). More...
 
- Public Member Functions inherited from UsdGeomXformable
 UsdGeomXformable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomXformable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomXformable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetXformOpOrderAttr () const
 
USDGEOM_API UsdAttribute CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdGeomXformOp AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API bool SetResetXformStack (bool resetXform) const
 
USDGEOM_API bool GetResetXformStack () const
 
USDGEOM_API bool SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
 
USDGEOM_API std::vector
< UsdGeomXformOp
GetOrderedXformOps (bool *resetsXformStack) const
 
USDGEOM_API bool ClearXformOpOrder () const
 Clears the local transform stack. More...
 
USDGEOM_API UsdGeomXformOp MakeMatrixXform () const
 
USDGEOM_API bool TransformMightBeTimeVarying () const
 
USDGEOM_API bool TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
 
USDGEOM_API bool GetTimeSamples (std::vector< double > *times) const
 
USDGEOM_API bool GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const
 
- Public Member Functions inherited from UsdGeomImageable
 UsdGeomImageable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomImageable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomImageable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetVisibilityAttr () const
 
USDGEOM_API UsdAttribute CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdAttribute GetPurposeAttr () const
 
USDGEOM_API UsdAttribute CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdRelationship GetProxyPrimRel () const
 
USDGEOM_API UsdRelationship CreateProxyPrimRel () const
 
USDGEOM_API void MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API void MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API TfToken ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
 
USDGEOM_API UsdAttribute GetPurposeVisibilityAttr (const TfToken &purpose=UsdGeomTokens->default_) const
 
USDGEOM_API TfToken ComputeEffectiveVisibility (const TfToken &purpose=UsdGeomTokens->default_, const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API PurposeInfo ComputePurposeInfo () const
 
USDGEOM_API PurposeInfo ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
 
USDGEOM_API TfToken ComputePurpose () const
 
USDGEOM_API UsdPrim ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
 
USDGEOM_API bool SetProxyPrim (const UsdPrim &proxy) const
 
USDGEOM_API bool SetProxyPrim (const UsdSchemaBase &proxy) const
 
USDGEOM_API GfBBox3d ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfBBox3d ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfBBox3d ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfMatrix4d ComputeLocalToWorldTransform (UsdTimeCode const &time) const
 
USDGEOM_API GfMatrix4d ComputeParentToWorldTransform (UsdTimeCode const &time) const
 
USDGEOM_API UsdGeomPrimvar CreatePrimvar (const TfToken &attrName, const SdfValueTypeName &typeName, const TfToken &interpolation=TfToken(), int elementSize=-1) const
 
USDGEOM_API UsdGeomPrimvar GetPrimvar (const TfToken &name) const
 
USDGEOM_API std::vector
< UsdGeomPrimvar
GetPrimvars () const
 
USDGEOM_API std::vector
< UsdGeomPrimvar
GetAuthoredPrimvars () const
 
USDGEOM_API bool HasPrimvar (const TfToken &name) const
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdTyped ()
 
- 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
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDLUX_API
UsdLuxNonboundableLightBase 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdGeomXformable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomXformable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API bool GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times)
 
static USDGEOM_API bool GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times)
 
static USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time)
 
static USDGEOM_API bool IsTransformationAffectedByAttrNamed (const TfToken &attrName)
 
- Static Public Member Functions inherited from UsdGeomImageable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomImageable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API const
TfTokenVector
GetOrderedPurposeTokens ()
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped
 
- Static Public Attributes inherited from UsdGeomXformable
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped
 
- Static Public Attributes inherited from UsdGeomImageable
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped
 
- Static Public Attributes inherited from UsdTyped
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 UsdTyped
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
 

Friends

class UsdSchemaRegistry
 

Detailed Description

Base class for intrinsic lights that are not boundable.

The primary purpose of this class is to provide a direct API to the functions provided by LightAPI for concrete derived light types.

Definition at line 61 of file nonboundableLightBase.h.

Constructor & Destructor Documentation

UsdLuxNonboundableLightBase::UsdLuxNonboundableLightBase ( const UsdPrim prim = UsdPrim())
inlineexplicit

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

Definition at line 73 of file nonboundableLightBase.h.

UsdLuxNonboundableLightBase::UsdLuxNonboundableLightBase ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 81 of file nonboundableLightBase.h.

virtual USDLUX_API UsdLuxNonboundableLightBase::~UsdLuxNonboundableLightBase ( )
virtual

Destructor.

Member Function Documentation

USDLUX_API UsdSchemaKind UsdLuxNonboundableLightBase::_GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also
UsdSchemaKind

Reimplemented from UsdGeomXformable.

USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::CreateColorAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::CreateColorTemperatureAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::CreateDiffuseAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::CreateEnableColorTemperatureAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::CreateExposureAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDLUX_API UsdRelationship UsdLuxNonboundableLightBase::CreateFiltersRel ( ) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::CreateIntensityAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::CreateNormalizeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::CreateSpecularAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const
static USDLUX_API UsdLuxNonboundableLightBase UsdLuxNonboundableLightBase::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

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

UsdLuxNonboundableLightBase(stage->GetPrimAtPath(path));
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::GetColorAttr ( ) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::GetColorTemperatureAttr ( ) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::GetDiffuseAttr ( ) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::GetEnableColorTemperatureAttr ( ) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::GetExposureAttr ( ) const
USDLUX_API UsdRelationship UsdLuxNonboundableLightBase::GetFiltersRel ( ) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::GetIntensityAttr ( ) const
USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::GetNormalizeAttr ( ) const
static USDLUX_API const TfTokenVector& UsdLuxNonboundableLightBase::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.

USDLUX_API UsdAttribute UsdLuxNonboundableLightBase::GetSpecularAttr ( ) const
USDLUX_API UsdLuxLightAPI UsdLuxNonboundableLightBase::LightAPI ( ) const

Contructs and returns a UsdLuxLightAPI object for this light.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 120 of file nonboundableLightBase.h.

Member Data Documentation

const UsdSchemaKind UsdLuxNonboundableLightBase::schemaKind = UsdSchemaKind::AbstractTyped
static

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

See Also
UsdSchemaKind

Definition at line 67 of file nonboundableLightBase.h.


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