maxon.NimbusBaseInterface¶

Description¶

maxon.NimbusBaseRef manages a maxon.NodesGraphModelRef that is owned by a classic c4d.BaseList2D object.

A c4d.BaseList2D object can own multiple graphs, one for each node space.

Inheritance diagram¶

Inheritance

Parent Class:

maxon.ObjectInterface

Child Class:

maxon.NimbusBaseRef

Methods Signature¶

`BaseList2DToUuid`(object)	Returns the uuid of the given BaseList2D object.
`FindCorrespondingBaseList`(absolutePath)	Returns the corresponding `c4d.BaseList2D` element for a `maxon.GraphNode` but will not create one if not already present.
`FindOrCreateCorrespondingBaseList`(absolutePath)	Returns the corresponding `c4d.BaseList2D` element for a `maxon.GraphNode`.
`GetBaseListRoot`()	Returns the C4D object that holds the `maxon.NimbusBaseRef`.
`GetDescID`(port)	Sets up the `c4d.DescID` of the parameter which corresponds to the given port.
`GetGraph`()	Returns the node graph connected to this object.
`GetGraphNodeFromBaseList`(bl)	Returns the node connected to the BaseList2D element.
`GetNodePathFromBaseList`(bl)	Returns the path of the node connected to the BaseList2D element.
`GetPath`(type)	Returns a path.
`GetSpaceId`()	Returns the identifier of the node space of the node graph.
`OpenInEditor`([path])	Opens the node editor for the node graph held by this `maxon.NimbusBaseRef`.
`PrviateOpenInEditor`(path)
`SetPath`(type, path)	Sets a path.
`UuidToBaseList2D`(uuid)	Returns the `c4d.BaseList2D` element with the given uuid.

Methods Definition¶

NimbusBaseInterface.BaseList2DToUuid(object)¶

Returns the uuid of the given BaseList2D object.

Parameters: object (c4d.BaseList2D) – BaseList2D object to find.
Returns: Uuid on success.
Return type: maxon.Uuid

NimbusBaseInterface.FindCorrespondingBaseList(absolutePath)¶

Returns the corresponding c4d.BaseList2D element for a maxon.GraphNode but will not create one if not already present.

Parameters: absolutePath (maxon.NodePath) – Absolute Path to the Node.
Returns: c4d.BaseList2D element, e.g. a Material.
Return type: c4d.BaseList2D

NimbusBaseInterface.FindOrCreateCorrespondingBaseList(absolutePath)¶

Returns the corresponding c4d.BaseList2D element for a maxon.GraphNode. This function creates a new one if not already present.

Parameters: absolutePath (maxon.NodePath) – Absolute Path to the Node.
Returns: c4d.BaseList2D element. The return value can be None in case no element can be created for the given path, e.g. if it is invalid
Return type: c4d.BaseList2D

NimbusBaseInterface.GetBaseListRoot()¶

Returns the C4D object that holds the maxon.NimbusBaseRef.

Returns: c4d.BaseList2D element, e.g. a Material.
Return type: c4d.BaseList2D

NimbusBaseInterface.GetDescID(port)¶

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

Parameters: port (maxon.NodePath) – A port path.
Returns: The DescID.
Return type: c4d.DescID

NimbusBaseInterface.GetGraph()¶

Returns the node graph connected to this object.

Returns: NodesGraphModelRef on success.
Return type: maxon.NodesGraphModelRef

static NimbusBaseInterface.GetGraphNodeFromBaseList(bl)¶

Returns the node connected to the BaseList2D element.

Parameters: bl (c4d.BaseList2D) – The BaseList2D representing a GraphNode.
Returns: GraphNode on success.
Return type: maxon.GraphNode

static NimbusBaseInterface.GetNodePathFromBaseList(bl)¶

Returns the path of the node connected to the BaseList2D element.

Parameters: bl (c4d.BaseList2D) – The BaseList2D representing a GraphNode.
Returns: NodePath on success.
Return type: maxon.NodePath

NimbusBaseInterface.GetPath(type)¶

Returns a path.

Note

The returned path can be invalid and point to a non-existing object.

Parameters: type (maxon.NIMBUS_PATH) – Path type.
Returns: Absolute Path to a Node or Port, depending on the given type.
Return type: maxon.NodePath

NimbusBaseInterface.GetSpaceId()¶

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

Returns: Node space identifier.
Return type: maxon.Id

NimbusBaseInterface.OpenInEditor(path=None)¶

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

Parameters: path (maxon.NodePath) – An optional path pointing to a group of the node graph.

NimbusBaseInterface.PrviateOpenInEditor(path)¶

NimbusBaseInterface.SetPath(type, path)¶

Sets a path.

Parameters

type (maxon.NIMBUS_PATH) – Path type.
path (maxon.NodePath) – Absolute Path to a Node or an empty path.

NimbusBaseInterface.UuidToBaseList2D(uuid)¶

Returns the c4d.BaseList2D element with the given uuid.

Parameters: uuid (maxon.Uuid) – Uuid to find.
Returns: BaseList2D object on success.
Return type: c4d.BaseList2D