com.badlogic.gdx.ai.fma

Class Formation<T extends com.badlogic.gdx.math.Vector<T>>

java.lang.Object

com.badlogic.gdx.ai.fma.Formation<T>

Type Parameters:

T - Type of vector, either 2D or 3D, implementing the Vector interface

public class Formation<T extends com.badlogic.gdx.math.Vector<T>>
extends java.lang.Object

A Formation coordinates the movement of a group of characters so that they retain some group organization. Characters belonging to a formation must implement the FormationMember interface. At its simplest, a formation can consist of moving in a fixed geometric pattern such as a V or line abreast, but it is not limited to that. Formations can also make use of the environment. Squads of characters can move between cover points using formation steering with only minor modifications, for example.

Formation motion is used in team sports games, squad-based games, real-time strategy games, and sometimes in first-person shooters, driving games, and action adventures too. It is a simple and flexible technique that is much quicker to write and execute and can produce much more stable behavior than collaborative tactical decision making.

Field Summary

Fields

Modifier and Type	Field and Description
protected Location<T>	anchor The anchor point of this formation.
protected FormationMotionModerator<T>	motionModerator The formation motion moderator
protected FormationPattern<T>	pattern The formation pattern
protected SlotAssignmentStrategy<T>	slotAssignmentStrategy The strategy used to assign a member to his slot

Constructor Summary

Constructors

Constructor and Description
Formation(Location<T> anchor, FormationPattern<T> pattern) Creates a Formation for the specified pattern using a FreeSlotAssignmentStrategy and no motion moderator.
Formation(Location<T> anchor, FormationPattern<T> pattern, SlotAssignmentStrategy<T> slotAssignmentStrategy) Creates a Formation for the specified pattern and slotAssignmentStrategy using no motion moderator.
Formation(Location<T> anchor, FormationPattern<T> pattern, SlotAssignmentStrategy<T> slotAssignmentStrategy, FormationMotionModerator<T> motionModerator) Creates a Formation for the specified pattern, slotAssignmentStrategy and moderator.

Method Summary

Modifier and Type	Method and Description
boolean	addMember(FormationMember<T> member) Adds a new member to the first available slot and updates slot assignments if the number of member is supported by the current pattern.
boolean	changePattern(FormationPattern<T> pattern) Changes the pattern of this formation and updates slot assignments if the number of member is supported by the given pattern.
Location<T>	getAnchorPoint() Returns the current anchor point of the formation.
FormationMotionModerator<T>	getMotionModerator()
FormationPattern<T>	getPattern()
SlotAssignment<T>	getSlotAssignmentAt(int index)
int	getSlotAssignmentCount()
SlotAssignmentStrategy<T>	getSlotAssignmentStrategy()
void	removeMember(FormationMember<T> member) Removes a member from its slot and updates slot assignments.
void	setAnchorPoint(Location<T> anchor) Sets the anchor point of the formation.
void	setMotionModerator(FormationMotionModerator<T> motionModerator) Sets the motion moderator of this formation
void	setPattern(FormationPattern<T> pattern) Sets the pattern of this formation
void	setSlotAssignmentStrategy(SlotAssignmentStrategy<T> slotAssignmentStrategy) Sets the slot assignment strategy of this formation
void	updateSlotAssignments() Updates the assignment of members to slots
void	updateSlots() Writes new slot locations to each member

Methods inherited from class java.lang.Object

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

Field Detail

anchor

protected Location<T extends com.badlogic.gdx.math.Vector<T>> anchor

The anchor point of this formation.

pattern

protected FormationPattern<T extends com.badlogic.gdx.math.Vector<T>> pattern

The formation pattern

slotAssignmentStrategy

protected SlotAssignmentStrategy<T extends com.badlogic.gdx.math.Vector<T>> slotAssignmentStrategy

The strategy used to assign a member to his slot

motionModerator

protected FormationMotionModerator<T extends com.badlogic.gdx.math.Vector<T>> motionModerator

The formation motion moderator

Constructor Detail

Formation

public Formation(Location<T> anchor,
                 FormationPattern<T> pattern)

Creates a Formation for the specified pattern using a FreeSlotAssignmentStrategy and no motion moderator.

Parameters:

anchor - the anchor point of this formation, usually a Steerable. Cannot be null.

pattern - the pattern of this formation

Throws:

java.lang.IllegalArgumentException - if the anchor point is null

Formation

public Formation(Location<T> anchor,
                 FormationPattern<T> pattern,
                 SlotAssignmentStrategy<T> slotAssignmentStrategy)

Creates a Formation for the specified pattern and slotAssignmentStrategy using no motion moderator.

Parameters:

anchor - the anchor point of this formation, usually a Steerable. Cannot be null.

pattern - the pattern of this formation

slotAssignmentStrategy - the strategy used to assign a member to his slot

Throws:

java.lang.IllegalArgumentException - if the anchor point is null

Formation

public Formation(Location<T> anchor,
                 FormationPattern<T> pattern,
                 SlotAssignmentStrategy<T> slotAssignmentStrategy,
                 FormationMotionModerator<T> motionModerator)

Creates a Formation for the specified pattern, slotAssignmentStrategy and moderator.

Parameters:

anchor - the anchor point of this formation, usually a Steerable. Cannot be null.

pattern - the pattern of this formation

slotAssignmentStrategy - the strategy used to assign a member to his slot

motionModerator - the motion moderator. Can be null if moderation is not needed

Throws:

java.lang.IllegalArgumentException - if the anchor point is null

Method Detail

getAnchorPoint

public Location<T> getAnchorPoint()

Returns the current anchor point of the formation. This can be the location (i.e. position and orientation) of a leader member, a modified center of mass of the members in the formation, or an invisible but steered anchor point for a two-level steering system.

setAnchorPoint

public void setAnchorPoint(Location<T> anchor)

Sets the anchor point of the formation.

Parameters:

anchor - the anchor point to set

getPattern

public FormationPattern<T> getPattern()

Returns:

the pattern of this formation

setPattern

public void setPattern(FormationPattern<T> pattern)

Sets the pattern of this formation

Parameters:

pattern - the pattern to set

getSlotAssignmentStrategy

public SlotAssignmentStrategy<T> getSlotAssignmentStrategy()

Returns:

the slot assignment strategy of this formation

setSlotAssignmentStrategy

public void setSlotAssignmentStrategy(SlotAssignmentStrategy<T> slotAssignmentStrategy)

Sets the slot assignment strategy of this formation

Parameters:

slotAssignmentStrategy - the slot assignment strategy to set

getMotionModerator

public FormationMotionModerator<T> getMotionModerator()

Returns:

the motion moderator of this formation

setMotionModerator

public void setMotionModerator(FormationMotionModerator<T> motionModerator)

Sets the motion moderator of this formation

Parameters:

motionModerator - the motion moderator to set

updateSlotAssignments

public void updateSlotAssignments()

Updates the assignment of members to slots

changePattern

public boolean changePattern(FormationPattern<T> pattern)

Changes the pattern of this formation and updates slot assignments if the number of member is supported by the given pattern.

Parameters:

pattern - the pattern to set

Returns:

true if the pattern has effectively changed; false otherwise.

addMember

public boolean addMember(FormationMember<T> member)

Adds a new member to the first available slot and updates slot assignments if the number of member is supported by the current pattern.

Parameters:

member - the member to add

Returns:

false if no more slots are available; true otherwise.

removeMember

public void removeMember(FormationMember<T> member)

Removes a member from its slot and updates slot assignments.

Parameters:

member - the member to remove

getSlotAssignmentAt

public SlotAssignment<T> getSlotAssignmentAt(int index)

getSlotAssignmentCount

public int getSlotAssignmentCount()

updateSlots

public void updateSlots()

Writes new slot locations to each member