org.cell2d.space

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

java.lang.Object

org.cell2d.space.SpaceObject

org.cell2d.space.MobileObject

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

Type Parameters:

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

U - The type of SpaceState that uses this ThinkerObject's SpaceThinker

V - The type of SpaceThinker that this ThinkerObject mimics

Direct Known Subclasses:

BasicThinkerObject

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

A ThinkerObject is a MobileObject that mimics a type of SpaceThinker by permanently assigning to itself a SpaceThinker of that type. A ThinkerObject has methods that access and manipulate properties of its assigned SpaceThinker, such as its timers and list of its own SpaceThinkers, allowing the ThinkerObject to effectively inherit those properties. A ThinkerObject will automatically set its assigned SpaceThinker's time factor and add and remove it from SpaceStates that can use it as appropriate to match the ThinkerObject's own time factor and assigned SpaceState.

See Also:

SpaceThinker

Constructor Summary

Constructors

Constructor and Description
ThinkerObject() Constructs a ThinkerObject with no locator Hitbox or assigned SpaceThinker.

Method Summary

Modifier and Type	Method and Description
boolean	addSubThinker(V subThinker) Adds the specified SpaceThinker to this ThinkerObject if it is not already assigned to a Thinker, and if doing so would not create a loop of assignments in which SpaceThinkers are directly or indirectly assigned to themselves.
void	clearLineages() Removes from their super-Thinkers all of the SpaceThinkers that are directly or indirectly assigned to this Thinker.
void	clearSubThinkers() Removes from this ThinkerObject all of the SpaceThinkers that are currently assigned to it.
EventGroup<T,U>	getBeforeMovementEvents() Returns the EventGroup of this ThinkerObject's before-movement Events.
int	getBeforeMovementPriority() Returns this ThinkerObject's before-movement priority.
EventGroup<T,U>	getFrameEvents() Returns the EventGroup of this ThinkerObject's frame Events.
int	getFramePriority() Returns this ThinkerObject's frame priority.
java.lang.Class<T>	getGameClass() Returns the Class object representing the type of CellGame that uses this ThinkerObject's SpaceThinker's SpaceStates.
int	getNumSubThinkers() Returns the number of SpaceThinkers that are assigned to this ThinkerObject.
java.lang.Class<U>	getStateClass() Returns the Class object representing the type of SpaceState that uses this ThinkerObject's SpaceThinker.
java.lang.Class<V>	getSubThinkerClass() Returns the Class object representing the type of SpaceThinker that this ThinkerObject mimics.
V	getThinker() Returns this ThinkerObject's assigned SpaceThinker, or null if it has none.
int	getTimerValue(Event<T,U> event) Returns the current value of this ThinkerObject's timer for the specified Event.
boolean	iteratingThroughSubThinkers() Returns whether any Iterators over this ThinkerObject's list of SpaceThinkers are in progress.
boolean	removeLineage(V subThinker) Removes from their super-Thinkers all of the SpaceThinkers that are directly or indirectly assigned to this ThinkerObject, and are either assigned to or assignees of the specified SpaceThinker.
boolean	removeSubThinker(V subThinker) Removes the specified SpaceThinker from this ThinkerObject if it is currently assigned to it.
void	setBeforeMovementPriority(int beforeMovementPriority) Sets this ThinkerObject's before-movement priority to the specified value.
void	setFramePriority(int framePriority) Sets this ThinkerObject's frame priority to the specified value.
boolean	setThinker(V thinker) Sets this ThinkerObject's assigned SpaceThinker to the specified one, if this ThinkerObject does not already have a SpaceThinker and the specified SpaceThinker is not already assigned to a Thinker.
void	setTimerValue(Event<T,U> event, int value) Sets the value of this ThinkerObject's timer for the specified Event to the specified value.
SafeIterator<V>	subThinkerIterator() Returns a new SafeIterator over this ThinkerObject's list of SpaceThinkers.

Methods inherited from class org.cell2d.space.MobileObject

addFollower, changePosition, changePosition, changeStep, changeStep, changeStepX, changeStepY, changeX, changeY, clearFollowers, collide, collided, collided, doMovement, doMovement, getAbsPressingAngle, getCollisionDirections, getCollisionHitbox, getCollisions, getDisplacement, getDisplacementLength, getDisplacementX, getDisplacementY, getFollowers, getLeader, getMovementPriority, getNewMovementPriority, getNumFollowers, getRelPressingAngle, getSpeed, getStep, getStepLength, getStepX, getStepY, getVelocity, getVelocityX, getVelocityY, hasCollision, isPressingIn, moveToward, moveToward, removeFollower, setCollision, setCollisionHitbox, setGameState, setLeader, setMovementPriority, setPosition, setPosition, setRelPressingAngle, setRelPressingAngle, setSpeed, setStep, setStep, setStepLength, setStepX, setStepY, setVelocity, setVelocity, setVelocityX, setVelocityY, setX, setY, solidBoundingBoxesMeet

Methods inherited from class org.cell2d.space.SpaceObject

addAnimInstance, addAnimInstance, angleTo, boundingBoxesMeet, changeAngle, changePosition, changePosition, changeX, changeY, clearAnimInstances, distanceTo, draw, flipX, flipY, getAlpha, getAngle, getAngleX, getAngleY, getAnimation, getAnimation, getAnimInstance, getAnimInstance, getAppearance, getBottomEdge, getCenter, getCenterOffset, getCenterOffsetX, getCenterOffsetY, getCenterX, getCenterY, getDrawPriority, getEffectiveTimeFactor, getFilter, getGame, getGameState, getHeight, getLeftEdge, getLocatorHitbox, getNewGameState, getNumAnimInstances, getOverlapHitbox, getPosition, getRightEdge, getSolidHitbox, getTimeFactor, getTopEdge, getWidth, getX, getXFlip, getXSign, getY, getYFlip, getYSign, intersectingSolidObject, intersectingSolidObjects, isIntersectingSolidObject, isOverlappingObject, isSolid, isVisible, isVisible, nearestObject, nearestObjectWithinCircle, nearestObjectWithinCircle, nearestObjectWithinRadius, nearestObjectWithinRectangle, nearestOverlappingObject, objectIsWithinRadius, objectsWithinRadius, objectWithinRadius, overlap, overlappingObject, overlappingObjects, overlaps, removeAnimInstance, setAlpha, setAngle, setAnimation, setAnimation, setAnimInstance, setAnimInstance, setAppearance, setCenterOffset, setCenterOffset, setCenterOffsetX, setCenterOffsetY, setDrawPriority, setFilter, setGameState, setLocatorHitbox, setOverlapHitbox, setPosition, setPosition, setSolid, setSolidHitbox, setSurfaceSolid, setTimeFactor, setX, setXFlip, setY, setYFlip, surfaceIsSolid

Methods inherited from class java.lang.Object

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

Constructor Detail

ThinkerObject

public ThinkerObject()

Constructs a ThinkerObject with no locator Hitbox or assigned SpaceThinker. This ThinkerObject must be assigned a locator Hitbox with its setLocatorHitbox() method and a SpaceThinker with its setThinker() method before any of its other methods are called.

See Also:

SpaceObject.setLocatorHitbox(org.cell2d.space.Hitbox), setThinker(org.cell2d.space.SpaceThinker)

Method Detail

getGameClass

public final java.lang.Class<T> getGameClass()

Returns the Class object representing the type of CellGame that uses this ThinkerObject's SpaceThinker's SpaceStates.

Returns:

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

getStateClass

public final java.lang.Class<U> getStateClass()

Returns the Class object representing the type of SpaceState that uses this ThinkerObject's SpaceThinker.

Returns:

The Class object representing the type of SpaceState that uses this ThinkerObject's SpaceThinker

getSubThinkerClass

public final java.lang.Class<V> getSubThinkerClass()

Returns the Class object representing the type of SpaceThinker that this ThinkerObject mimics.

Returns:

The Class object representing the type of SpaceThinker that this ThinkerObject mimics

getThinker

public final V getThinker()

Returns this ThinkerObject's assigned SpaceThinker, or null if it has none.

Returns:

This ThinkerObject's assigned SpaceThinker

setThinker

public final boolean setThinker(V thinker)

Sets this ThinkerObject's assigned SpaceThinker to the specified one, if this ThinkerObject does not already have a SpaceThinker and the specified SpaceThinker is not already assigned to a Thinker.

Parameters:

thinker - The SpaceThinker to be assigned

Returns:

Whether the assignment occurred

getTimerValue

public final int getTimerValue(Event<T,U> event)

Returns the current value of this ThinkerObject's timer for the specified Event.

Parameters:

event - The Event whose timer value should be returned

Returns:

The current value of the timer for the specified Event

setTimerValue

public final void setTimerValue(Event<T,U> event,
                                int value)

Sets the value of this ThinkerObject's timer for the specified Event to the specified value.

Parameters:

event - The Event whose timer value should be set

value - The new value of the specified Event's timer

getFrameEvents

public final EventGroup<T,U> getFrameEvents()

Returns the EventGroup of this ThinkerObject's frame Events.

Returns:

The EventGroup of this ThinkerObject's frame Events

getNumSubThinkers

public final int getNumSubThinkers()

Returns the number of SpaceThinkers that are assigned to this ThinkerObject.

Returns:

The number of SpaceThinkers that are assigned to this ThinkerObject

iteratingThroughSubThinkers

public final boolean iteratingThroughSubThinkers()

Returns whether any Iterators over this ThinkerObject's list of SpaceThinkers are in progress.

Returns:

Whether any Iterators over this ThinkerObject's list of SpaceThinkers are in progress

subThinkerIterator

public final SafeIterator<V> subThinkerIterator()

Returns a new SafeIterator over this ThinkerObject's list of SpaceThinkers.

Returns:

A new SafeIterator over this ThinkerObject's list of SpaceThinkers

addSubThinker

public final boolean addSubThinker(V subThinker)

Adds the specified SpaceThinker to this ThinkerObject if it is not already assigned to a Thinker, and if doing so would not create a loop of assignments in which SpaceThinkers are directly or indirectly assigned to themselves.

Parameters:

subThinker - The SpaceThinker to be added

Returns:

Whether the addition occurred

removeSubThinker

public final boolean removeSubThinker(V subThinker)

Removes the specified SpaceThinker from this ThinkerObject if it is currently assigned to it.

Parameters:

subThinker - The SpaceThinker to be removed

Returns:

Whether the removal occurred

clearSubThinkers

public final void clearSubThinkers()

Removes from this ThinkerObject all of the SpaceThinkers that are currently assigned to it.

removeLineage

public final boolean removeLineage(V subThinker)

Removes from their super-Thinkers all of the SpaceThinkers that are directly or indirectly assigned to this ThinkerObject, and are either assigned to or assignees of the specified SpaceThinker. For instance, if a SpaceThinker is assigned to a SpaceThinker that is assigned to a SpaceThinker that is assigned to this ThinkerObject, and the second SpaceThinker is the specified SubThinker, the first SpaceThinker will be removed from the second, the second from the third, and the third from this ThinkerObject. This method is useful for ThinkerObjects that use SpaceThinkers to model a hierarchy of states in which they can exist.

Parameters:

subThinker - The SpaceThinker with which the removed SpaceThinkers must share a lineage of assignments

Returns:

Whether any removals occurred

clearLineages

public final void clearLineages()

Removes from their super-Thinkers all of the SpaceThinkers that are directly or indirectly assigned to this Thinker. For instance, if a SpaceThinker is assigned to a SpaceThinker that is assigned to this ThinkerObject, the first SpaceThinker will be removed from the second, and the second will be removed from this ThinkerObject.

getFramePriority

public int getFramePriority()

Returns this ThinkerObject's frame priority.

Returns:

This ThinkerObject's frame priority

setFramePriority

public void setFramePriority(int framePriority)

Sets this ThinkerObject's frame priority to the specified value.

Parameters:

framePriority - This ThinkerObject's new frame priority

getBeforeMovementEvents

public final EventGroup<T,U> getBeforeMovementEvents()

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

Returns:

The EventGroup of this ThinkerObject's before-movement Events

getBeforeMovementPriority

public final int getBeforeMovementPriority()

Returns this ThinkerObject's before-movement priority.

Returns:

This ThinkerObject's before-movement priority

setBeforeMovementPriority

public final void setBeforeMovementPriority(int beforeMovementPriority)

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

Parameters:

beforeMovementPriority - This ThinkerObject's new before-movement priority