UsdHoudiniHoudiniViewportGuideAPI Class Reference

#include <houdiniViewportGuideAPI.h>

Inheritance diagram for UsdHoudiniHoudiniViewportGuideAPI:

Public Member Functions
	UsdHoudiniHoudiniViewportGuideAPI (const UsdPrim &prim=UsdPrim())
	UsdHoudiniHoudiniViewportGuideAPI (const UsdSchemaBase &schemaObj)
virtual	~UsdHoudiniHoudiniViewportGuideAPI () override
	Destructor. More...
UsdAttribute	GetHoudiniGuidescaleAttr () const
UsdAttribute	CreateHoudiniGuidescaleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
UsdAttribute	GetHoudiniInviewermenuAttr () const
UsdAttribute	CreateHoudiniInviewermenuAttr (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 UsdHoudiniHoudiniViewportGuideAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
static UsdHoudiniHoudiniViewportGuideAPI	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 const UsdSchemaKind	schemaType = 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
UsdSchemaKind	_GetSchemaType () 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
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

Houdini API schema for controlling light and camera guides in the LOP viewport.

Definition at line 58 of file houdiniViewportGuideAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

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

Definition at line 77 of file houdiniViewportGuideAPI.h.

UsdHoudiniHoudiniViewportGuideAPI::UsdHoudiniHoudiniViewportGuideAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

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

Definition at line 85 of file houdiniViewportGuideAPI.h.

virtual UsdHoudiniHoudiniViewportGuideAPI::~UsdHoudiniHoudiniViewportGuideAPI ( )

overridevirtual

Destructor.

Member Function Documentation

UsdSchemaKind UsdHoudiniHoudiniViewportGuideAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

Reimplemented from UsdSchemaBase.

UsdSchemaKind UsdHoudiniHoudiniViewportGuideAPI::_GetSchemaType ( ) const

overrideprotectedvirtual

Deprecated:

Same as _GetSchemaKind, provided to maintain temporary backward compatibility with older generated schemas.

Reimplemented from UsdSchemaBase.

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

static

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

Returns

A valid UsdHoudiniHoudiniViewportGuideAPI object is returned upon success. An invalid (or empty) UsdHoudiniHoudiniViewportGuideAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

See Also

UsdPrim::GetAppliedSchemas()

UsdPrim::HasAPI()

UsdPrim::ApplyAPI()

UsdPrim::RemoveAPI()

UsdAttribute UsdHoudiniHoudiniViewportGuideAPI::CreateHoudiniGuidescaleAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetHoudiniGuidescaleAttr(), 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 UsdHoudiniHoudiniViewportGuideAPI::CreateHoudiniInviewermenuAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

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

static

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

UsdHoudiniHoudiniViewportGuideAPI(stage->GetPrimAtPath(path));

UsdAttribute UsdHoudiniHoudiniViewportGuideAPI::GetHoudiniGuidescaleAttr

(

)

const

Scales the guide geometry drawn in the Houdini viewport for this primitive.

Declaration	float houdini:guidescale = 1
C++ Type	float
Usd Type	SdfValueTypeNames->Float

UsdAttribute UsdHoudiniHoudiniViewportGuideAPI::GetHoudiniInviewermenuAttr

(

)

const

If true, then this light or camera will appear in the viewport's Look Through Camera menu.

Declaration	uniform bool houdini:inviewermenu = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

static const TfTokenVector& UsdHoudiniHoudiniViewportGuideAPI::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 142 of file houdiniViewportGuideAPI.h.

Member Data Documentation

const UsdSchemaKind UsdHoudiniHoudiniViewportGuideAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also

UsdSchemaKind

Definition at line 66 of file houdiniViewportGuideAPI.h.

const UsdSchemaKind UsdHoudiniHoudiniViewportGuideAPI::schemaType = UsdSchemaKind::SingleApplyAPI

static

Deprecated:

Same as schemaKind, provided to maintain temporary backward compatibility with older generated schemas.

Definition at line 71 of file houdiniViewportGuideAPI.h.

---

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

• HUSD/UsdHoudini/houdiniViewportGuideAPI.h