HDK
|
#include <lightPortalAPI.h>
Static Public Member Functions | |
static USDRI_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
static USDRI_API UsdRiLightPortalAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
static USDRI_API bool | CanApply (const UsdPrim &prim, std::string *whyNot=nullptr) |
static USDRI_API UsdRiLightPortalAPI | Apply (const UsdPrim &prim) |
![]() | |
static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
![]() | |
static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::SingleApplyAPI |
![]() | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
![]() | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Protected Member Functions | |
USDRI_API UsdSchemaKind | _GetSchemaKind () const override |
![]() | |
UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName) | |
UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName) | |
const TfToken & | _GetInstanceName () const |
USD_API bool | _IsCompatible () const override |
![]() | |
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 | |
![]() | |
template<typename APISchemaType > | |
static APISchemaType | _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName) |
template<typename APISchemaType > | |
static APISchemaType | _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName) |
Renderman-specific attributes for light portals.
Definition at line 61 of file lightPortalAPI.h.
Construct a UsdRiLightPortalAPI on UsdPrim prim
. Equivalent to UsdRiLightPortalAPI::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 lightPortalAPI.h.
|
inlineexplicit |
Construct a UsdRiLightPortalAPI on the prim held by schemaObj
. Should be preferred over UsdRiLightPortalAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 81 of file lightPortalAPI.h.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdAPISchemaBase.
|
static |
Applies this single-apply API schema to the given prim
. This information is stored by adding "RiLightPortalAPI" to the token-valued, listOp metadata apiSchemas on the prim.
|
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.
USDRI_API UsdAttribute UsdRiLightPortalAPI::CreateRiPortalIntensityAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetRiPortalIntensityAttr(), 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
.
USDRI_API UsdAttribute UsdRiLightPortalAPI::CreateRiPortalTintAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetRiPortalTintAttr(), 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
.
|
static |
Return a UsdRiLightPortalAPI 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:
USDRI_API UsdAttribute UsdRiLightPortalAPI::GetRiPortalIntensityAttr | ( | ) | const |
Intensity adjustment relative to the light intensity. This gets multiplied by the light's intensity and power
Declaration | float ri:portal:intensity |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute UsdRiLightPortalAPI::GetRiPortalTintAttr | ( | ) | const |
tint: This parameter tints the color from the dome texture.
Declaration | color3f ri:portal:tint |
C++ Type | GfVec3f |
Usd Type | SdfValueTypeNames->Color3f |
|
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.
|
friend |
Definition at line 159 of file lightPortalAPI.h.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 67 of file lightPortalAPI.h.