#include <nodeGraphNodeAPI.h>

Inheritance diagram for UsdUINodeGraphNodeAPI:

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

	UsdUINodeGraphNodeAPI (const UsdSchemaBase &schemaObj)

virtual USDUI_API	~UsdUINodeGraphNodeAPI ()
	Destructor. More...

USDUI_API UsdAttribute	GetPosAttr () const

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

USDUI_API UsdAttribute	GetStackingOrderAttr () const

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

USDUI_API UsdAttribute	GetDisplayColorAttr () const

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

USDUI_API UsdAttribute	GetIconAttr () const

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

USDUI_API UsdAttribute	GetExpansionStateAttr () const

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

USDUI_API UsdAttribute	GetSizeAttr () const

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

static USDUI_API UsdUINodeGraphNodeAPI	Get (const UsdStagePtr &stage, const SdfPath &path)

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

static USDUI_API UsdUINodeGraphNodeAPI	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
USDUI_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
static USD_API TfTokenVector	_GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)

Detailed Description

This api helps storing information about nodes in node graphs.

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

Definition at line 64 of file nodeGraphNodeAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

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

Definition at line 76 of file nodeGraphNodeAPI.h.

UsdUINodeGraphNodeAPI::UsdUINodeGraphNodeAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

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

Definition at line 84 of file nodeGraphNodeAPI.h.

virtual USDUI_API UsdUINodeGraphNodeAPI::~UsdUINodeGraphNodeAPI ( )

virtual

Destructor.

Member Function Documentation

USDUI_API UsdSchemaKind UsdUINodeGraphNodeAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDUI_API UsdUINodeGraphNodeAPI UsdUINodeGraphNodeAPI::Apply ( const UsdPrim & prim )

static

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

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

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::CreateDisplayColorAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::CreateExpansionStateAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::CreateIconAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::CreatePosAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::CreateSizeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::CreateStackingOrderAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

static

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

UsdUINodeGraphNodeAPI(stage->GetPrimAtPath(path));

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::GetDisplayColorAttr ( ) const

This hint defines what tint the node should have in the node graph.


Declaration	`uniform color3f ui:nodegraph:node:displayColor`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Color3f
Variability	SdfVariabilityUniform

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::GetExpansionStateAttr ( ) const

The current expansionState of the node in the ui. 'open' = fully expanded 'closed' = fully collapsed 'minimized' = should take the least space possible


Declaration	`uniform token ui:nodegraph:node:expansionState`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	open, closed, minimized

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::GetIconAttr ( ) const

This points to an image that should be displayed on the node. It is intended to be useful for summary visual classification of nodes, rather than a thumbnail preview of the computed result of the node in some computational system.


Declaration	`uniform asset ui:nodegraph:node:icon`
C++ Type	SdfAssetPath
Usd Type	SdfValueTypeNames->Asset
Variability	SdfVariabilityUniform

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::GetPosAttr ( ) const

Declared relative position to the parent in a node graph. X is the horizontal position. Y is the vertical position. Higher numbers correspond to lower positions (coordinates are Qt style, not cartesian).

These positions are not explicitly meant in pixel space, but rather assume that the size of a node is approximately 1.0x1.0. Where size-x is the node width and size-y height of the node. Depending on graph UI implementation, the size of a node may vary in each direction.

Example: If a node's width is 300 and it is position is at 1000, we store for x-position: 1000 * (1.0/300)


Declaration	`uniform float2 ui:nodegraph:node:pos`
C++ Type	GfVec2f
Usd Type	SdfValueTypeNames->Float2
Variability	SdfVariabilityUniform

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

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::GetSizeAttr ( ) const

Optional size hint for a node in a node graph. X is the width. Y is the height.

This value is optional, because node size is often determined based on the number of in- and outputs of a node.


Declaration	`uniform float2 ui:nodegraph:node:size`
C++ Type	GfVec2f
Usd Type	SdfValueTypeNames->Float2
Variability	SdfVariabilityUniform

USDUI_API UsdAttribute UsdUINodeGraphNodeAPI::GetStackingOrderAttr ( ) const

This optional value is a useful hint when an application cares about the visibility of a node and whether each node overlaps another.

Nodes with lower stacking order values are meant to be drawn below higher ones. Negative values are meant as background. Positive values are meant as foreground. Undefined values should be treated as 0.

There are no set limits in these values.