#include <houdiniLightBarnDoorAPI.h>

Inheritance diagram for UsdHoudiniHoudiniLightBarnDoorAPI:

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

	UsdHoudiniHoudiniLightBarnDoorAPI (const UsdSchemaBase &schemaObj)

virtual	~UsdHoudiniHoudiniLightBarnDoorAPI () override
	Destructor. More...

UsdAttribute	GetBarndoorleftAttr () const

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

UsdAttribute	GetBarndoorleftedgeAttr () const

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

UsdAttribute	GetBarndoorrightAttr () const

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

UsdAttribute	GetBarndoorrightedgeAttr () const

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

UsdAttribute	GetBarndoortopAttr () const

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

UsdAttribute	GetBarndoortopedgeAttr () const

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

UsdAttribute	GetBarndoorbottomAttr () const

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

UsdAttribute	GetBarndoorbottomedgeAttr () const

UsdAttribute	CreateBarndoorbottomedgeAttr (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 const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

static UsdHoudiniHoudiniLightBarnDoorAPI	Get (const UsdStagePtr &stage, const SdfPath &path)

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

static UsdHoudiniHoudiniLightBarnDoorAPI	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
UsdSchemaKind	_GetSchemaKind () const override

Protected Member Functions inherited from UsdAPISchemaBase
USD_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

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)

Detailed Description

Houdini API schema for describing barn door attributes on lights. This should not be avoided, if possible, in favour of using Light Filters instead. This schema (and the associated attributes) will be deprecated and removed from Solaris in a later release of Houdini.

Definition at line 43 of file houdiniLightBarnDoorAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

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

Definition at line 57 of file houdiniLightBarnDoorAPI.h.

UsdHoudiniHoudiniLightBarnDoorAPI::UsdHoudiniHoudiniLightBarnDoorAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

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

Definition at line 65 of file houdiniLightBarnDoorAPI.h.

virtual UsdHoudiniHoudiniLightBarnDoorAPI::~UsdHoudiniHoudiniLightBarnDoorAPI ( )

overridevirtual

Destructor.

Member Function Documentation

UsdSchemaKind UsdHoudiniHoudiniLightBarnDoorAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdSchemaBase.

static UsdHoudiniHoudiniLightBarnDoorAPI UsdHoudiniHoudiniLightBarnDoorAPI::Apply ( const UsdPrim & prim )

static

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

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

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::CreateBarndoorbottomAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetBarndoorbottomAttr(), 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.

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::CreateBarndoorbottomedgeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetBarndoorbottomedgeAttr(), 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.

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::CreateBarndoorleftAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetBarndoorleftAttr(), 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.

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::CreateBarndoorleftedgeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetBarndoorleftedgeAttr(), 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.

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::CreateBarndoorrightAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetBarndoorrightAttr(), 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.

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::CreateBarndoorrightedgeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetBarndoorrightedgeAttr(), 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.

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::CreateBarndoortopAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetBarndoortopAttr(), 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.

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::CreateBarndoortopedgeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetBarndoortopedgeAttr(), 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 UsdHoudiniHoudiniLightBarnDoorAPI UsdHoudiniHoudiniLightBarnDoorAPI::Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

UsdHoudiniHoudiniLightBarnDoorAPI(stage->GetPrimAtPath(path));

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::GetBarndoorbottomAttr ( ) const

Slides in a light blocker from the bottom, covering part of the spotlight cone. 1.0 reaches all the way across the cone, blocking all light.


Declaration	`float barndoorbottom = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::GetBarndoorbottomedgeAttr ( ) const

Extends the solid light blocker above by an additional soft edge. 1.0 creates a gradient as wide as the spotlight cone.


Declaration	`float barndoorbottomedge = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::GetBarndoorleftAttr ( ) const

Slides in a light blocker from the left, covering part of the spotlight cone. 1.0 reaches all the way across the cone, blocking all light.


Declaration	`float barndoorleft = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::GetBarndoorleftedgeAttr ( ) const

Extends the solid light blocker above by an additional soft edge. 1.0 creates a gradient as wide as the spotlight cone.


Declaration	`float barndoorleftedge = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::GetBarndoorrightAttr ( ) const

Slides in a light blocker from the right, covering part of the spotlight cone. 1.0 reaches all the way across the cone, blocking all light.


Declaration	`float barndoorright = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::GetBarndoorrightedgeAttr ( ) const

Extends the solid light blocker above by an additional soft edge. 1.0 creates a gradient as wide as the spotlight cone.


Declaration	`float barndoorrightedge = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::GetBarndoortopAttr ( ) const

Slides in a light blocker from the top, covering part of the spotlight cone. 1.0 reaches all the way across the cone, blocking all light.


Declaration	`float barndoortop = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

UsdAttribute UsdHoudiniHoudiniLightBarnDoorAPI::GetBarndoortopedgeAttr ( ) const

Extends the solid light blocker above by an additional soft edge. 1.0 creates a gradient as wide as the spotlight cone.


Declaration	`float barndoortopedge = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

static const TfTokenVector& UsdHoudiniHoudiniLightBarnDoorAPI::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.

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 137 of file houdiniLightBarnDoorAPI.h.

Member Data Documentation

const UsdSchemaKind UsdHoudiniHoudiniLightBarnDoorAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 51 of file houdiniLightBarnDoorAPI.h.

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

HUSD/UsdHoudini/houdiniLightBarnDoorAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation