NimbusBaseInterface Class Reference

#include <nimbusbase.h>

Inheritance diagram for NimbusBaseInterface:

Detailed Description

NimbusBaseRef manages a NodesGraphModelRef that is owned by a classic BaseList2D object. A BaseList2D object can own multiple graphs, one for each node space.

Public Member Functions

const MAXON_METHOD nodes::NodesGraphModelRef & GetGraph ()
 
MAXON_METHOD BaseList2DGetBaseListRoot ()
 
const MAXON_METHOD IdGetSpaceId ()
 
MAXON_METHOD Result< void > SetPath (NIMBUS_PATH type, const NodePath &path)
 
MAXON_METHOD NodePath GetPath (NIMBUS_PATH type)
 
MAXON_METHOD Result< void > OpenInEditor (const NodePath &path=NodePath::NullValue())
 
MAXON_METHOD Result< BaseList2D * > UuidToBaseList2D (const Uuid &uuid) const
 
MAXON_METHOD Result< UuidBaseList2DToUuid (BaseList2D *object) const
 
MAXON_METHOD Result< void > GetDescID (const NodePath &port, DescID &result)
 

Private Member Functions

 MAXON_INTERFACE (NimbusBaseInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.nimbusbase")
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( NimbusBaseInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.interface.nimbusbase"   
)
private

◆ GetGraph()

const MAXON_METHOD nodes::NodesGraphModelRef& GetGraph ( )

Returns the node graph connected to this object.

Returns
NodesGraphModelRef on success.

◆ GetBaseListRoot()

MAXON_METHOD BaseList2D* GetBaseListRoot ( )

Returns the C4D object that holds the NimbusBaseRef.

Returns
BaseList2D element, e.g. a Material.

◆ GetSpaceId()

const MAXON_METHOD Id& GetSpaceId ( )

Returns the identifier of the node space of the node graph.

Returns
Node space identifier.

◆ SetPath()

MAXON_METHOD Result<void> SetPath ( NIMBUS_PATH  type,
const NodePath &  path 
)

Sets a path.

Parameters
[in]typePath type.
[in]pathAbsolute Path to a Node or an empty path.
Returns
OK on success.

◆ GetPath()

MAXON_METHOD NodePath GetPath ( NIMBUS_PATH  type)

Returns a path. Note that the returned path can be invalid and point to a non-existing object.

Parameters
[in]typePath type.
Returns
Absolute Path to a Node or Port, depending on the given type.

◆ OpenInEditor()

MAXON_METHOD Result<void> OpenInEditor ( const NodePath &  path = NodePath::NullValue())

Opens the node editor for the node graph held by this NimbusBaseRef.

Parameters
[in]pathAn optional path pointing to a group of the node graph.

◆ UuidToBaseList2D()

MAXON_METHOD Result<BaseList2D*> UuidToBaseList2D ( const Uuid uuid) const

Returns the BaseList2D element with the given uuid.

Parameters
[in]uuidUuid to find.
Returns
BaseList2D object on success.

◆ BaseList2DToUuid()

MAXON_METHOD Result<Uuid> BaseList2DToUuid ( BaseList2D object) const

Returns the uuid of the given BaseList2D object.

Parameters
[in]objectBaseList2D object to find.
Returns
Uuid on success.

◆ GetDescID()

MAXON_METHOD Result<void> GetDescID ( const NodePath &  port,
DescID result 
)

Sets up the DescID of the parameter which corresponds to the given port.

Parameters
[in]portA port path.
[out]resultThe DescID to set up.