org.cell2d.space

Class SpaceThinker<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>

java.lang.Object

org.cell2d.Thinker<T,U,V>

org.cell2d.SubThinker<T,U,V>

org.cell2d.space.SpaceThinker<T,U,V>

Type Parameters:

T - The type of CellGame that uses this SpaceThinker's SpaceStates

U - The type of SpaceState that uses this SpaceThinker

V - The type of SpaceThinker that this SpaceThinker is for SpaceState interaction purposes

Direct Known Subclasses:

BasicSpaceThinker

public abstract class SpaceThinker<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>
extends SubThinker<T,U,V>

A SpaceThinker is the type of SubThinker that is used by SpaceStates. A SpaceThinker has beforeMovementActions() that it takes once each frame, after all Thinkers have experienced all of their time units for that frame, but before its SpaceState moves its assigned MobileObjects. Like a SpaceState, it also has an EventGroup of before-movement Events that it performs once each frame. A SpaceThinker performs these events immediately after it takes its beforeMovementActions(). Both taking beforeMovementActions() and performing before-movement Events count as time-dependent actions, and thus a SpaceThinker will only do them when assigned to an active SpaceState.

Similarly to its frameActions(), the process in which a SpaceThinker takes its beforeMovementActions() and then performs its before-movement Events is itself an Event, and the SpaceThinker automatically ensures that this Event is in the before-movement Events of its current super-Thinker. The SpaceThinker's before-movement priority (0 by default) is the Event's priority in its super-Thinker's before-movement Events. This means that the SpaceThinkers assigned to a given Thinker will take their beforeMovementActions() in order from highest to lowest before-movement priority, and that a SpaceThinker will take its beforeMovementActions() after its super-Thinker, but, if its super-Thinker is itself a SpaceThinker, before the next Thinker assigned to its super-Thinker's super-Thinker.

See Also:

SpaceState, ThinkerObject

Constructor Summary

Constructors

Constructor and Description
SpaceThinker(java.lang.Class<T> gameClass, java.lang.Class<U> stateClass, java.lang.Class<V> subThinkerClass) Constructs a SpaceThinker.

Method Summary

Modifier and Type	Method and Description
void	addSubThinkerActions(T game, U state, V subThinker) Actions for this Thinker to take immediately after adding a SubThinker to itself, before the added SubThinker takes its addedActions().
void	beforeMovementActions(T game, U state) Actions for this SpaceThinker to take once each frame, after all Thinkers have experienced all of their time units for that frame, but before its SpaceState moves its assigned MobileObjects.
EventGroup<T,U>	getBeforeMovementEvents() Returns the EventGroup of this SpaceThinker's before-movement Events.
int	getBeforeMovementPriority() Returns this SpaceThinker's before-movement priority.
void	removeSubThinkerActions(T game, U state, V subThinker) Actions for this Thinker to take immediately before removing a SubThinker from itself, after the soon-to-be-removed SubThinker takes its removedActions().
void	setBeforeMovementPriority(int beforeMovementPriority) Sets this SpaceThinker's before-movement priority to the specified value.

Methods inherited from class org.cell2d.SubThinker

addedActions, getEffectiveTimeFactor, getFramePriority, getGame, getGameState, getNewSuperThinker, getSuperThinker, getThis, removedActions, setFramePriority, setSuperThinker

Methods inherited from class org.cell2d.Thinker

addSubThinker, clearLineages, clearSubThinkers, frameActions, getFrameEvents, getGameClass, getNumSubThinkers, getStateClass, getSubThinkerClass, getTimeFactor, getTimerValue, iteratingThroughSubThinkers, removeLineage, removeSubThinker, setTimeFactor, setTimerValue, subThinkerIterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpaceThinker

public SpaceThinker(java.lang.Class<T> gameClass,
                    java.lang.Class<U> stateClass,
                    java.lang.Class<V> subThinkerClass)

Constructs a SpaceThinker.

Parameters:

gameClass - The Class object representing the type of CellGame that uses this SpaceThinker's SpaceStates

stateClass - The Class object representing the type of SpaceState that uses this SpaceThinker

subThinkerClass - The Class object representing the type of SpaceThinker that this SpaceThinker is for SpaceState interaction purposes

Method Detail

beforeMovementActions

public void beforeMovementActions(T game,
                                  U state)

Actions for this SpaceThinker to take once each frame, after all Thinkers have experienced all of their time units for that frame, but before its SpaceState moves its assigned MobileObjects.

Parameters:

game - This SpaceThinker's SpaceState's CellGame

state - This SpaceThinker's SpaceState

addSubThinkerActions

public void addSubThinkerActions(T game,
                                 U state,
                                 V subThinker)

Description copied from class: Thinker

Actions for this Thinker to take immediately after adding a SubThinker to itself, before the added SubThinker takes its addedActions().

Overrides:

addSubThinkerActions in class Thinker<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>

Parameters:

game - This Thinker's GameState's CellGame, or null if it has no GameState

state - This Thinker's GameState, or null if it has none

subThinker - The SubThinker that was added

removeSubThinkerActions

public void removeSubThinkerActions(T game,
                                    U state,
                                    V subThinker)

Description copied from class: Thinker

Actions for this Thinker to take immediately before removing a SubThinker from itself, after the soon-to-be-removed SubThinker takes its removedActions().

Overrides:

removeSubThinkerActions in class Thinker<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>

Parameters:

game - This Thinker's GameState's CellGame, or null if it has no GameState

state - This Thinker's GameState, or null if it has none

subThinker - The SubThinker that is about to be removed

getBeforeMovementEvents

public final EventGroup<T,U> getBeforeMovementEvents()

Returns the EventGroup of this SpaceThinker's before-movement Events.

Returns:

The EventGroup of this SpaceThinker's before-movement Events

getBeforeMovementPriority

public final int getBeforeMovementPriority()

Returns this SpaceThinker's before-movement priority.

Returns:

This SpaceThinker's before-movement priority

setBeforeMovementPriority

public final void setBeforeMovementPriority(int beforeMovementPriority)

Sets this SpaceThinker's before-movement priority to the specified value.

Parameters:

beforeMovementPriority - This SpaceThinker's new before-movement priority