UsdUINodeGraphNodeAPI Class Reference

This api helps storing information about nodes in node graphs. More...

#include <nodeGraphNodeAPI.h>

Inheritance diagram for UsdUINodeGraphNodeAPI:

Public Member Functions
	UsdUINodeGraphNodeAPI (const UsdPrim &prim=UsdPrim())
	Construct a UsdUINodeGraphNodeAPI on UsdPrim prim .
	UsdUINodeGraphNodeAPI (const UsdSchemaBase &schemaObj)
	Construct a UsdUINodeGraphNodeAPI on the prim held by schemaObj .
virtual USDUI_API	~UsdUINodeGraphNodeAPI ()
	Destructor.
USDUI_API UsdAttribute	GetPosAttr () const
	Declared relative position to the parent in a node graph.
USDUI_API UsdAttribute	CreatePosAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPosAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDUI_API UsdAttribute	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.
USDUI_API UsdAttribute	CreateStackingOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetStackingOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDUI_API UsdAttribute	GetDisplayColorAttr () const
	This hint defines what tint the node should have in the node graph.
USDUI_API UsdAttribute	CreateDisplayColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDisplayColorAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDUI_API UsdAttribute	GetIconAttr () const
	This points to an image that should be displayed on the node.
USDUI_API UsdAttribute	CreateIconAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetIconAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDUI_API UsdAttribute	GetExpansionStateAttr () const
	The current expansionState of the node in the ui.
USDUI_API UsdAttribute	CreateExpansionStateAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetExpansionStateAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDUI_API UsdAttribute	GetSizeAttr () const
	Optional size hint for a node in a node graph.
USDUI_API UsdAttribute	CreateSizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSizeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDUI_API UsdAttribute	GetDocURIAttr () const
	A URI pointing to additional detailed documentation for this node or node type.
USDUI_API UsdAttribute	CreateDocURIAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDocURIAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
	Construct a UsdAPISchemaBase on UsdPrim prim .
	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
	Construct a UsdAPISchemaBase on the prim held by schemaObj .
virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor.
Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.
bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.
bool	IsAPISchema () const
	Returns whether this is an API schema or not.
bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.
bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.
UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is.
USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store prim as the held prim.
USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by otherSchema.
virtual USD_API	~UsdSchemaBase ()
	Destructor.
UsdPrim	GetPrim () const
	Return this schema object's held prim.
SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath().
USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.
USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

Static Public Member Functions
static USDUI_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
static USDUI_API UsdUINodeGraphNodeAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdUINodeGraphNodeAPI holding the prim adhering to this schema at path on stage.
static USDUI_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
	Returns true if this single-apply API schema can be applied to the given prim.
static USDUI_API UsdUINodeGraphNodeAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given prim.
Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USDUI_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on UsdPrim prim with the specified instanceName.
	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on the prim held by schemaObj with the given instanceName.
const TfToken &	_GetInstanceName () const
	Returns the instance name of the API schema object belonging to a multiple-apply API schema.
USD_API bool	_IsCompatible () const override
	Check whether this APISchema object is valid for the currently held prim.
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)
	Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.

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 47 of file nodeGraphNodeAPI.h.

Constructor & Destructor Documentation

UsdUINodeGraphNodeAPI() [1/2]

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 59 of file nodeGraphNodeAPI.h.

UsdUINodeGraphNodeAPI() [2/2]

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 67 of file nodeGraphNodeAPI.h.

~UsdUINodeGraphNodeAPI()

virtual USDUI_API ~UsdUINodeGraphNodeAPI ( )

virtual

Destructor.

Member Function Documentation

_GetSchemaKind()

USDUI_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

Apply()

static USDUI_API 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()

CanApply()

static USDUI_API bool 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()

CreateDisplayColorAttr()

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

See GetDisplayColorAttr(), and also Create vs Get Property Methods 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.

CreateDocURIAttr()

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

See GetDocURIAttr(), and also Create vs Get Property Methods 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.

CreateExpansionStateAttr()

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

See GetExpansionStateAttr(), and also Create vs Get Property Methods 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.

CreateIconAttr()

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

See GetIconAttr(), and also Create vs Get Property Methods 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.

CreatePosAttr()

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

See GetPosAttr(), and also Create vs Get Property Methods 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.

CreateSizeAttr()

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

See GetSizeAttr(), and also Create vs Get Property Methods 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.

CreateStackingOrderAttr()

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

See GetStackingOrderAttr(), and also Create vs Get Property Methods 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.

Get()

static USDUI_API 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));

GetDisplayColorAttr()

USDUI_API UsdAttribute 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

GetDocURIAttr()

USDUI_API UsdAttribute GetDocURIAttr

(

)

const

A URI pointing to additional detailed documentation for this node or node type.

Declaration	uniform string ui:nodegraph:node:docURI
C++ Type	std::string
Usd Type	SdfValueTypeNames->String
Variability	SdfVariabilityUniform

GetExpansionStateAttr()

USDUI_API UsdAttribute 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

GetIconAttr()

USDUI_API UsdAttribute 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

GetPosAttr()

USDUI_API UsdAttribute 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

GetSchemaAttributeNames()

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

GetSizeAttr()

USDUI_API UsdAttribute 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

GetStackingOrderAttr()

USDUI_API UsdAttribute 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.

Declaration	uniform int ui:nodegraph:node:stackingOrder
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

Friends And Related Function Documentation

UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 145 of file nodeGraphNodeAPI.h.

Member Data Documentation

schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See also

UsdSchemaKind

Definition at line 53 of file nodeGraphNodeAPI.h.

---

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

• pxr/usd/usdUI/nodeGraphNodeAPI.h