#include <lightPortalAPI.h>

Inheritance diagram for UsdRiLightPortalAPI:

Public Member Functions
	UsdRiLightPortalAPI (const UsdPrim &prim=UsdPrim())

	UsdRiLightPortalAPI (const UsdSchemaBase &schemaObj)

virtual USDRI_API	~UsdRiLightPortalAPI ()
	Destructor. More...

USDRI_API UsdAttribute	GetRiPortalIntensityAttr () const

USDRI_API UsdAttribute	CreateRiPortalIntensityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

USDRI_API UsdAttribute	GetRiPortalTintAttr () const

USDRI_API UsdAttribute	CreateRiPortalTintAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) 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 UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

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 Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (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
USDRI_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

Friends
class	UsdSchemaRegistry

Additional Inherited Members
Static Protected Member Functions inherited from UsdAPISchemaBase
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)

Detailed Description

Deprecated:: RenderMan-specific light portal settings will move to a new schema in a future release.

Renderman-specific attributes for light portals.

Definition at line 61 of file lightPortalAPI.h.

Constructor & Destructor Documentation

UsdRiLightPortalAPI::UsdRiLightPortalAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

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.

UsdRiLightPortalAPI::UsdRiLightPortalAPI ( const UsdSchemaBase & schemaObj )

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 USDRI_API UsdRiLightPortalAPI::~UsdRiLightPortalAPI ( )

virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaKind UsdRiLightPortalAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDRI_API UsdRiLightPortalAPI UsdRiLightPortalAPI::Apply ( const UsdPrim & prim )

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.

Returns: A valid UsdRiLightPortalAPI object is returned upon success. An invalid (or empty) UsdRiLightPortalAPI 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()

static USDRI_API bool UsdRiLightPortalAPI::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()

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 USDRI_API UsdRiLightPortalAPI UsdRiLightPortalAPI::Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

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:

UsdRiLightPortalAPI(stage->GetPrimAtPath(path));

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 USDRI_API const TfTokenVector& UsdRiLightPortalAPI::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.