#include <houdiniNodeGraphContainerAPI.h>

Inheritance diagram for UsdHoudiniHoudiniNodeGraphContainerAPI:

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

	UsdHoudiniHoudiniNodeGraphContainerAPI (const UsdSchemaBase &schemaObj)

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

UsdAttribute	GetContainerInputPosAttr () const

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

UsdAttribute	GetContainerOutputPosAttr () const

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

UsdAttribute	GetContainerInputDisplayColorAttr () const

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

UsdAttribute	GetContainerOutputDisplayColorAttr () const

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

UsdAttribute	GetContainerWireStyleAttr () const

UsdAttribute	CreateContainerWireStyleAttr (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 UsdHoudiniHoudiniNodeGraphContainerAPI	Get (const UsdStagePtr &stage, const SdfPath &path)

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

static UsdHoudiniHoudiniNodeGraphContainerAPI	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 storing node graph container information, such as input and output positions, display colors, connection wires drawing style, etc.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdHoudiniTokens. So to set an attribute to the value "rightHanded", use UsdHoudiniTokens->rightHanded as the value.

Definition at line 47 of file houdiniNodeGraphContainerAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

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

Definition at line 61 of file houdiniNodeGraphContainerAPI.h.

UsdHoudiniHoudiniNodeGraphContainerAPI::UsdHoudiniHoudiniNodeGraphContainerAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

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

Definition at line 69 of file houdiniNodeGraphContainerAPI.h.

virtual UsdHoudiniHoudiniNodeGraphContainerAPI::~UsdHoudiniHoudiniNodeGraphContainerAPI ( )

overridevirtual

Destructor.

Member Function Documentation

UsdSchemaKind UsdHoudiniHoudiniNodeGraphContainerAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdSchemaBase.

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

static

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

Returns: A valid UsdHoudiniHoudiniNodeGraphContainerAPI object is returned upon success. An invalid (or empty) UsdHoudiniHoudiniNodeGraphContainerAPI 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 UsdHoudiniHoudiniNodeGraphContainerAPI::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 UsdHoudiniHoudiniNodeGraphContainerAPI::CreateContainerInputDisplayColorAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetContainerInputDisplayColorAttr(), 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 UsdHoudiniHoudiniNodeGraphContainerAPI::CreateContainerInputPosAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetContainerInputPosAttr(), 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 UsdHoudiniHoudiniNodeGraphContainerAPI::CreateContainerOutputDisplayColorAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetContainerOutputDisplayColorAttr(), 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 UsdHoudiniHoudiniNodeGraphContainerAPI::CreateContainerOutputPosAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetContainerOutputPosAttr(), 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 UsdHoudiniHoudiniNodeGraphContainerAPI::CreateContainerWireStyleAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

static

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

UsdHoudiniHoudiniNodeGraphContainerAPI(stage->GetPrimAtPath(path));

UsdAttribute UsdHoudiniHoudiniNodeGraphContainerAPI::GetContainerInputDisplayColorAttr ( ) const

Display color for the container input in the node graph.


Declaration	`color3f houdini:containerInputDisplayColor`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Color3f

UsdAttribute UsdHoudiniHoudiniNodeGraphContainerAPI::GetContainerInputPosAttr ( ) const

Position of the container input in the node graph.


Declaration	`float2 houdini:containerInputPos`
C++ Type	GfVec2f
Usd Type	SdfValueTypeNames->Float2

UsdAttribute UsdHoudiniHoudiniNodeGraphContainerAPI::GetContainerOutputDisplayColorAttr ( ) const

Display color for the container output in the node graph.


Declaration	`color3f houdini:containerOutputDisplayColor`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Color3f

UsdAttribute UsdHoudiniHoudiniNodeGraphContainerAPI::GetContainerOutputPosAttr ( ) const

Position of the container output in the node graph.


Declaration	`float2 houdini:containerOutputPos`
C++ Type	GfVec2f
Usd Type	SdfValueTypeNames->Float2

UsdAttribute UsdHoudiniHoudiniNodeGraphContainerAPI::GetContainerWireStyleAttr ( ) const

Drawing style of the wire connections between nodes inside the node graph.


Declaration	`token houdini:containerWireStyle = "inherited"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Allowed Values	inherited, straight, rounded

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