alias_api.AlClusterNode

class alias_api.AlClusterNode

Bases: AlDagNode

The dag node class for clusters.

This class is a dag node class used specifically for clusters. Every AlClusterNode object has an AlCluster attached to it. (For more information on how AlCluster’s and AlClusterNode’s work together, see the Class Description for the AlCluster object.)

To create a cluster node, the user must instantiate and call the create method on an AlCluster object, which will automatically create an AlClusterNode. The user cannot directly instantiate an AlClusterNode.

A cluster node can be deleted in two ways. When a cluster node is deleted, its associated cluster is deleted. When a

cluster is deleted, its cluster node is also deleted.

cluster(*args, **kwargs)

Overloaded function.

  1. cluster(self: alias_api.AlClusterNode) -> alias_api.AlCluster

Return a pointer to the attached AlCluster object.

  1. cluster(self: alias_api.AlClusterNode, arg0: alias_api.AlTM) -> alias_api.AlCluster

    Return the attached AlCluster object.

    The AlTM will be updated with the cluster node’s transformation amtrix, if a cluster exists.

    param tm

    The transform matrix.

    type tm

    AlTM

    return

    The attached AlCluster object.

    rtype

    AlCluster

copy_wrapper(self: alias_api.AlClusterNode) → alias_api.AlObject

Return an exact duplicate of this AlClusterNode wrapper.

is_instanceable(self: alias_api.AlClusterNode) → int

Return False. An AlClusterNode is not instanceable.

type(self: alias_api.AlClusterNode) → alias_api.AlObjectType

Return the AlClusterNode type identifier.