AlClusterNode

Alias Programmers’ Interfaces (API) > Class reference > AlCamera – AlCylinderLight >

AlClusterNode

Is the DAG node class for clusters.

Synopsis

#include <AlClusterNode.h>

class AlClusterNode : public AlDagNode

virtual	~AlClusterNode();

virtual AlObject*	copyWrapper() const;

virtual AlObjectType	type() const;

virtual boolean	isInstanceable();

AlCluster *	cluster() const;

AlCluster *	cluster(AlTM&) const;

Description

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 AlClusters and AlClusterNodes work together, see the Class Description for the AlCloud object.)

To create a cluster node, the user must instantiate and call the create method on an AlCluster object, which will 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.

AlClusterNode::~AlClusterNode()

Description

Deletes an AlClusterNode wrapper object.

AlObject* AlClusterNode::copyWrapper() const

Description

Makes an exact copy of this AlClusterNode wrapper.

AlObjectType AlClusterNode::type() const

Description

Returns the class identifier, kClusterNodeType.

boolean AlClusterNode::isInstanceable()

Description

Returns FALSE. An AlClusterNode is not an instanceable DAG node.

AlCluster* AlClusterNode::cluster() const

Description

Returns a pointer to the attached AlCluster object.

AlCluster* AlClusterNode::cluster(AlTM& tm) const

Description

Returns a pointer to the attached AlCluster object. The AlTM will be updated with the clusterNode’s TM if a cluster exists.

Arguments

> tm - the transformation matrix to be updated with the clusterNode’s TM