CC3NodeSequencerVisitor Class Reference

This visitor is used to visit CC3NodeSequencers to perform operations on nodes within the sequencers. More...

#import <CC3NodeSequencer.h>

List of all members.

Public Member Functions
(void)	- addMisplacedNode:
(void)	- clearMisplacedNodes
(id)	- initWithWorld:
Static Public Member Functions
(id)	+ visitorWithWorld:
Properties
BOOL	hasMisplacedNodes
CCArray *	misplacedNodes
CC3World *	world

---

Detailed Description

This visitor is used to visit CC3NodeSequencers to perform operations on nodes within the sequencers.

The visitor maintains a reference to the CC3World, so that the sequencer may use aspects of the world during operations.

This visitor can be used to visit CC3NodeSequencers to detect and keep track of nodes that are misplaced within the sequencer, using the updateSequenceWithVisitor: method on the sequencer.

What it means for a node to be "misplaced" is defined by the sequencer itself. A sequencer may determine that the node no longer meets the criteria of the sequencer's evaluator, or that the node is now out of order, relative to the sorting or grouping criteria defined by the sequencer.

A sequencer visitor can either be instantiated for a single visitation of a sequencer, or can be instantiated once and reused to visit different sequencers over and over. In doing so, you should invoke the reset method on the sequencer visitor prior to using it to visit a sequencer.

---

Member Function Documentation

- (void) addMisplacedNode:

(CC3Node *)

aNode

Adds the specified node to the array of nodes held in the misplacedNodes property.

- (void) clearMisplacedNodes

Clears the misplacedNodes array.

- (id) initWithWorld:

(CC3World *)

aCC3World

Initializes this instance with the specified CC3World.

+ (id) visitorWithWorld:

(CC3World *)

aCC3World

Allocates and initializes an autoreleased instance with the specified CC3World.

---

Property Documentation

- (BOOL) hasMisplacedNodes [read, assign]

Indicates whether the misplacedNodes property contains nodes.

- (CCArray *) misplacedNodes [read, assign]

Returns an array of nodes that the sequencer deems to be misplaced after being visited by this visitor.

The returned array may be nil.

- (CC3World *) world [read, write, assign]

The CC3World instance.

The sequencer may use aspects of the world when performing sequencing operations with a node.

---

The documentation for this class was generated from the following file:

• CC3NodeSequencer.h