Detailed Description

Base class for custom GUIs that require re-arrangement of node-based attributes in the attribute manager. This class provides the accessors to implement complex GUIs for non-variadic and variadic port bundles like the gradient, spline mapper or BSDF layer.

Public Member Functions
	CustomNodeGuiBase (const cinema::BaseContainer &settings, cinema::CUSTOMGUIPLUGIN *plugin)

virtual Int32	Message (const cinema::BaseContainer &msg, cinema::BaseContainer &result) override

Result< BaseArray< cinema::DescID > >	GetReplacementIds () const

Result< AttributeManagerProxyRef >	GetAttributeManager ()

Protected Attributes
CustomNodeGuiProxyRef	_proxy

Private Member Functions
	INSTANCEOF (CustomNodeGuiBase, cinema::iBaseCustomGui)

Constructor & Destructor Documentation

◆ CustomNodeGuiBase()

CustomNodeGuiBase	(	const cinema::BaseContainer &	settings,
		cinema::CUSTOMGUIPLUGIN *	plugin
	)

Constructor.

Parameters

[in]	settings	The settings container.
[in]	plugin	The plugin structure.

Member Function Documentation

◆ INSTANCEOF()

INSTANCEOF	(	CustomNodeGuiBase	,
		cinema::iBaseCustomGui
	)

private

◆ Message()

virtual Int32 Message	(	const cinema::BaseContainer &	msg,
		cinema::BaseContainer &	result
	)

overridevirtual

Called when a message is received.

Note: Some messages must be consumed by the node gui proxy in order to have functional gui elements that are created through the AttributeManagerProxyRef.

Parameters

[in]	msg	The readable message container.
[out]	result	The writable message result container.

Returns: The message receive status.

◆ GetReplacementIds()

Result<BaseArray<cinema::DescID> > GetReplacementIds ( ) const

Returns the DescIDs of all currently existing elements in the attribute manager that are associated with this gui.

Returns: The container holding the DescIDs on success.

◆ GetAttributeManager()

Result<AttributeManagerProxyRef> GetAttributeManager ( )

Returns the attribute manager proxy which gives access to node-based attribute handling. Please note that access to the attribute manager proxy is only safe during lifetime of this gui instance.

Returns: The attribute manager proxy on success.

Member Data Documentation

◆ _proxy

CustomNodeGuiProxyRef _proxy

protected