SubThinker

java.lang.Object
- org.cell2d.Thinker<T,U,V>
- - org.cell2d.SubThinker<T,U,V>

Type Parameters:

T - The type of CellGame that uses this SubThinker's GameStates

U - The type of GameState that uses this SubThinker

V - The type of SubThinker that this SubThinker is for GameState interaction purposes

Direct Known Subclasses:

BasicThinker, SpaceThinker
```
public abstract class SubThinker<T extends CellGame,U extends GameState<T,U,V>,V extends SubThinker<T,U,V>>
extends Thinker<T,U,V>
```
A SubThinker is a type of Thinker that contributes to the mechanics of another Thinker to which it is assigned. This Thinker is called its super-Thinker. If its time factor is negative, a SubThinker will use the time factor of its super-Thinker.

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

The SubThinker class is intended to be extended by classes V that extend SubThinker<T,U,V> and interact with GameStates of class U. BasicThinker is an example of such a class. This allows a SubThinker's GameStates to interact with it in ways unique to its subclass of SubThinker.

It is useful to implicitly extend subclasses of SubThinker to override their methods for single instances without creating completely new class files.

See Also:

Thinker.addSubThinker(org.cell2d.SubThinker), Event

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addedActions(T game, U state)` Actions for this SubThinker to take after being added to a new super-Thinker, immediately after the super-Thinker takes its addSubThinkerActions().
`long`	`getEffectiveTimeFactor()` Returns this Thinker's effective time factor; that is, the average number of time units it experiences every frame.
`int`	`getFramePriority()` Returns this SubThinker's frame priority.
`T`	`getGame()` Returns the CellGame of the GameState to which this Thinker is assigned, or null if it is not assigned to a GameState.
`U`	`getGameState()` Returns the GameState to which this Thinker is assigned, or null if it is not assigned to one.
`Thinker<T,U,V>`	`getNewSuperThinker()` Returns the Thinker to which this SubThinker is about to be assigned, but has not yet been due to one or more of the SubThinker lists involved being iterated over.
`Thinker<T,U,V>`	`getSuperThinker()` Returns this SubThinker's super-Thinker, or null if it has none.
`V`	`getThis()` Returns this SubThinker as a V, rather than as a SubThinker<T,U,V>.
`void`	`removedActions(T game, U state)` Actions for this SubThinker to take before being removed from its current super-Thinker, immediately before the super-Thinker takes its removeSubThinkerActions().
`void`	`setFramePriority(int framePriority)` Sets this SubThinker's frame priority to the specified value.
`void`	`setSuperThinker(Thinker<T,U,V> thinker)` Sets this SubThinker's super-Thinker to the specified one.

Methods inherited from class org.cell2d.Thinker
addSubThinker, addSubThinkerActions, clearLineages, clearSubThinkers, frameActions, getFrameEvents, getGameClass, getNumSubThinkers, getStateClass, getSubThinkerClass, getTimeFactor, getTimerValue, iteratingThroughSubThinkers, removeLineage, removeSubThinker, removeSubThinkerActions, setTimeFactor, setTimerValue, subThinkerIterator

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SubThinker
```
public SubThinker(java.lang.Class<T> gameClass,
                  java.lang.Class<U> stateClass,
                  java.lang.Class<V> subThinkerClass)
```
    Constructs a SubThinker.
    
    Parameters:
    
    gameClass - The Class object representing the type of CellGame that uses this SubThinker's GameStates
    
    stateClass - The Class object representing the type of GameState that uses this SubThinker
    
    subThinkerClass - The Class object representing the type of SubThinker that this SubThinker is for GameState interaction purposes
- Method Detail
  - getThis
```
public final V getThis()
```
    Returns this SubThinker as a V, rather than as a SubThinker<T,U,V>.
    
    Returns:
    
    This SubThinker as a V
  - getGame
```
public final T getGame()
```
    Description copied from class: Thinker
    
    Returns the CellGame of the GameState to which this Thinker is assigned, or null if it is not assigned to a GameState.
    
    Specified by:
    
    getGame in class Thinker<T extends CellGame,U extends GameState<T,U,V>,V extends SubThinker<T,U,V>>
    
    Returns:
    
    This Thinker's GameState's CellGame
  - getGameState
```
public final U getGameState()
```
    Description copied from class: Thinker
    
    Returns the GameState to which this Thinker is assigned, or null if it is not assigned to one.
    
    Specified by:
    
    getGameState in class Thinker<T extends CellGame,U extends GameState<T,U,V>,V extends SubThinker<T,U,V>>
    
    Returns:
    
    The GameState to which this Thinker is assigned
  - getEffectiveTimeFactor
```
public final long getEffectiveTimeFactor()
```
    Description copied from class: Thinker
    
    Returns this Thinker's effective time factor; that is, the average number of time units it experiences every frame. If it is not assigned to a GameState, this will be 0.
    
    Specified by:
    
    getEffectiveTimeFactor in class Thinker<T extends CellGame,U extends GameState<T,U,V>,V extends SubThinker<T,U,V>>
    
    Returns:
    
    This Thinker's effective time factor
  - getSuperThinker
```
public final Thinker<T,U,V> getSuperThinker()
```
    Returns this SubThinker's super-Thinker, or null if it has none.
    
    Returns:
    
    This SubThinker's super-Thinker
  - getNewSuperThinker
```
public final Thinker<T,U,V> getNewSuperThinker()
```
    Returns the Thinker to which this SubThinker is about to be assigned, but has not yet been due to one or more of the SubThinker lists involved being iterated over. If this SubThinker is about to be removed from its super-Thinker without being added to a new one afterward, this will be null. If this SubThinker is not about to change super-Thinkers, this method will simply return its current super-Thinker.
    
    Returns:
    
    The Thinker to which this SubThinker is about to be assigned
  - setSuperThinker
```
public final void setSuperThinker(Thinker<T,U,V> thinker)
```
    Sets this SubThinker's super-Thinker to the specified one. If it is set to a null Thinker, or if this SubThinker cannot be added to the specified one, this SubThinker will simply be removed from its current super-Thinker if it has one.
    
    Parameters:
    
    thinker - This SubThinker's new super-Thinker
  - addedActions
```
public void addedActions(T game,
                         U state)
```
    Actions for this SubThinker to take after being added to a new super-Thinker, immediately after the super-Thinker takes its addSubThinkerActions().
    
    Parameters:
    
    game - This SubThinker's GameState's CellGame, or null if it has no GameState
    
    state - This SubThinker's GameState, or null if it has none
  - removedActions
```
public void removedActions(T game,
                           U state)
```
    Actions for this SubThinker to take before being removed from its current super-Thinker, immediately before the super-Thinker takes its removeSubThinkerActions().
    
    Parameters:
    
    game - This SubThinker's GameState's CellGame, or null if it has no GameState
    
    state - This SubThinker's GameState, or null if it has none
  - getFramePriority
```
public final int getFramePriority()
```
    Returns this SubThinker's frame priority.
    
    Returns:
    
    This SubThinker's frame priority
  - setFramePriority
```
public final void setFramePriority(int framePriority)
```
    Sets this SubThinker's frame priority to the specified value.
    
    Parameters:
    
    framePriority - This SubThinker's new frame priority

Class SubThinker<T extends CellGame,U extends GameState<T,U,V>,V extends SubThinker<T,U,V>>

Constructor Summary

Method Summary

Methods inherited from class org.cell2d.Thinker

Methods inherited from class java.lang.Object

Constructor Detail

SubThinker

Method Detail

getThis

getGame

getGameState

getEffectiveTimeFactor

getSuperThinker

getNewSuperThinker

setSuperThinker

addedActions

removedActions

getFramePriority

setFramePriority