GameState (ConvexMerger v1.2 API)

java.lang.Object
- dev.roanh.convexmerger.game.GameState

```
public class GameState
extends java.lang.Object
```
Class managing the main game state, data, players and general control flow.

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`activePlayer` The index of the player whose turn it is.
`private VerticalDecomposition`	`decomp` The vertical decomposition for the game state.
`private boolean`	`ended` Whether the game has ended or not.
`private long`	`gameEnd` Millisecond time the game ended or -1.
`private long`	`gameStart` Millisecond time the game started or -1 if the game has not started.
`private java.util.List<GameStateListener>`	`listeners` Listeners subscribed for gamestate events.
`private java.util.List<ConvexObject>`	`objects` The convex objects in this game.
`private java.util.List<Player>`	`players` The players playing in this game.
`private java.lang.String`	`seed` The seed of the generator that generated this game's playfield.
`private SegmentPartitionTree<ConjugationTree<SegmentPartitionTree.LineSegment>>`	`segmentTreeConj` The conjugation tree based segment intersection tree.
`private SegmentPartitionTree<KDTree<SegmentPartitionTree.LineSegment>>`	`segmentTreeKD` The kd-tree based segment intersection tree.
`private ConvexObject`	`selected` The convex object currently selected by the player, or `null` if there is no selected object.
`private int`	`turns` The number of individual player turns so far in this game.

Constructor Summary

Constructors
Constructor and Description
`GameState(java.util.List<ConvexObject> objects, java.lang.String seed, java.util.List<Player> players)` Constructs a new game state with the given playfield objects, seed and list of participating players.
`GameState(PlayfieldGenerator generator, java.util.List<Player> players)` Constructs a new game state with the given playfield generator and list of participating players.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abort()` Signals that this game was forcefully terminated before it was supposed to finish.
`ClaimResult`	`claimObject(ConvexObject obj)` Attempts to claim the given convex object for the active player.
`ClaimResult`	`claimObject(ConvexObject obj, java.awt.geom.Point2D location)` Attempts to claim the given convex object for the active player.
`void`	`clearSelection()` Clears the object selection for the active player, meaning they are no longer selecting a second object for a merge.
`private void`	`endTurn()` Ends the turn for the active player moving on to the next player.
`void`	`executePlayerTurn()` Executes the turn for the active player.
`Player`	`getActivePlayer()` Gets the active players whose turn it is currently.
`long`	`getGameTime()` Gets the total number of milliseconds this game took or is taking up to this point in time.
`java.util.List<java.awt.geom.Line2D>`	`getHelperLines(java.awt.geom.Point2D p)` Gets the helper lines to be drawn from the currently selected first object to the given point.
`ConvexObject`	`getObject(double x, double y)` Gets the object located at the given coordinates.
`ConvexObject`	`getObject(java.awt.geom.Point2D p)` Gets the object located at the given coordinates.
`java.util.List<ConvexObject>`	`getObjects()` Gets all the objects in this game.
`int`	`getPlayerCount()` Gets the total number of players in this game.
`java.util.List<Player>`	`getPlayers()` Gets a list of all the players in this game.
`int`	`getRounds()` Gets the number of rounds in this game.
`java.lang.String`	`getSeed()` Gets the seed of the playfield generator that was used to generate this game.
`SegmentPartitionTree<ConjugationTree<SegmentPartitionTree.LineSegment>>`	`getSegmentTreeConj()` Gets the conjugation tree based segment intersection tree for this game state.
`SegmentPartitionTree<KDTree<SegmentPartitionTree.LineSegment>>`	`getSegmentTreeKD()` Gets the kd-tree based segment intersection tree for this game state.
`ConvexObject`	`getSelectedObject()` Gets the (first) object selected by the player.
`VerticalDecomposition`	`getVerticalDecomposition()` Gets the vertical decomposition for the game state.
`void`	`init()` Initialises the game state running tasks that need to run on the main game thread.
`boolean`	`isFinished()` Checks if the game is finished.
`boolean`	`isSelectingSecond()` True if the active player is currently selecting a second object to merge with.
`private ConvexObject`	`mergeObjects(ConvexObject first, ConvexObject second)` Attempts to merge the given two convex objects.
`boolean`	`ready()` Checks if the game state is ready to handle the next turn.
`void`	`registerStateListener(GameStateListener listener)` Registers a listener to receive game status updates.
`void`	`setSelectedObject(ConvexObject obj)` Sets the object selected by the current player.
`java.util.stream.Stream<ConvexObject>`	`stream()` Streams all the objects in this game.

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

- Field Detail
  - objects
```
private java.util.List<ConvexObject> objects
```
    The convex objects in this game.
  - players
```
private java.util.List<Player> players
```
    The players playing in this game.
  - decomp
```
private VerticalDecomposition decomp
```
    The vertical decomposition for the game state.
  - activePlayer
```
private int activePlayer
```
    The index of the player whose turn it is.
  - selected
```
private ConvexObject selected
```
    The convex object currently selected by the player, or null if there is no selected object.
  - ended
```
private boolean ended
```
    Whether the game has ended or not.
  - gameStart
```
private long gameStart
```
    Millisecond time the game started or -1 if the game has not started.
  - gameEnd
```
private long gameEnd
```
    Millisecond time the game ended or -1.
  - turns
```
private int turns
```
    The number of individual player turns so far in this game.
  - listeners
```
private java.util.List<GameStateListener> listeners
```
    Listeners subscribed for gamestate events.
  - seed
```
private java.lang.String seed
```
    The seed of the generator that generated this game's playfield.
  - segmentTreeConj
```
private SegmentPartitionTree<ConjugationTree<SegmentPartitionTree.LineSegment>> segmentTreeConj
```
    The conjugation tree based segment intersection tree.
  - segmentTreeKD
```
private SegmentPartitionTree<KDTree<SegmentPartitionTree.LineSegment>> segmentTreeKD
```
    The kd-tree based segment intersection tree.
- Constructor Detail
  - GameState
```
public GameState(PlayfieldGenerator generator,
                 java.util.List<Player> players)
```
    Constructs a new game state with the given playfield generator and list of participating players. The game timer will be started immediately.
    
    Parameters:
    
    generator - The generator to use to generate the playfield.
    
    players - The list of participating players.
  - GameState
```
public GameState(java.util.List<ConvexObject> objects,
                 java.lang.String seed,
                 java.util.List<Player> players)
```
    Constructs a new game state with the given playfield objects, seed and list of participating players. The game timer will be started immediately.
    
    Parameters:
    
    objects - The playfield objects for the game.
    
    seed - The seed of the playfield generator.
    
    players - The list of participating players.
- Method Detail
  - getSegmentTreeConj
```
public SegmentPartitionTree<ConjugationTree<SegmentPartitionTree.LineSegment>> getSegmentTreeConj()
```
    Gets the conjugation tree based segment intersection tree for this game state.
    
    Returns:
    
    The conjugation tree based segment intersection tree.
  - getSegmentTreeKD
```
public SegmentPartitionTree<KDTree<SegmentPartitionTree.LineSegment>> getSegmentTreeKD()
```
    Gets the kd-tree based segment intersection tree for this game state.
    
    Returns:
    
    The kd-tree based segment intersection tree.
  - init
```
public void init()
          throws java.lang.InterruptedException
```
    Initialises the game state running tasks that need to run on the main game thread.
    
    Throws:
    
    java.lang.InterruptedException - When the player was interrupted while making its move. Signalling that the game was aborted.
  - ready
```
public boolean ready()
```
    Checks if the game state is ready to handle the next turn.
    
    Returns:
    
    True if the game state is ready for the next turn.
  - getSeed
```
public java.lang.String getSeed()
```
    Gets the seed of the playfield generator that was used to generate this game.
    
    Returns:
    
    The game seed.
  - registerStateListener
```
public void registerStateListener(GameStateListener listener)
```
    Registers a listener to receive game status updates.
    
    Parameters:
    
    listener - The listener to register.
  - claimObject
```
public ClaimResult claimObject(ConvexObject obj)
                        throws java.lang.InterruptedException
```
    Attempts to claim the given convex object for the active player.
    
    Parameters:
    
    obj - The object to claim.
    
    Returns:
    
    The result of the attempted claim.
    
    Throws:
    
    java.lang.InterruptedException - When the player was interrupted while making its move. Signalling that the game was aborted.
    
    See Also:
    
    getActivePlayer()
  - claimObject
```
public ClaimResult claimObject(ConvexObject obj,
                               java.awt.geom.Point2D location)
                        throws java.lang.InterruptedException
```
    Attempts to claim the given convex object for the active player.
    
    Parameters:
    
    obj - The object to claim.
    
    location - The point within the object that was clicked to claim it.
    
    Returns:
    
    The result of the attempted claim.
    
    Throws:
    
    java.lang.InterruptedException - When the player was interrupted while making its move. Signalling that the game was aborted.
    
    See Also:
    
    getActivePlayer()
  - endTurn
```
private void endTurn()
```
    Ends the turn for the active player moving on to the next player.
    
    See Also:
    
    getActivePlayer()
  - mergeObjects
```
private ConvexObject mergeObjects(ConvexObject first,
                                  ConvexObject second)
                           throws java.lang.InterruptedException
```
    Attempts to merge the given two convex objects.
    
    Parameters:
    
    first - The first object to merge (already owned).
    
    second - The second object to merge (could be unowned).
    
    Returns:
    
    The convex object that is the result of merging the two given objects, or null if the merge was not possible.
    
    Throws:
    
    java.lang.InterruptedException - When the player was interrupted while making its move. Signalling that the game was aborted.
  - getActivePlayer
```
public Player getActivePlayer()
```
    Gets the active players whose turn it is currently.
    
    Returns:
    
    The active player.
  - getObject
```
public ConvexObject getObject(java.awt.geom.Point2D p)
```
    Gets the object located at the given coordinates.
    
    Parameters:
    
    p - The coordinates to get the object at.
    
    Returns:
    
    The object at the given coordinates.
  - getObject
```
public ConvexObject getObject(double x,
                              double y)
```
    Gets the object located at the given coordinates.
    
    Parameters:
    
    x - The x coordinate to look at.
    
    y - The y coordinate to look at.
    
    Returns:
    
    The object at the given coordinates.
  - getObjects
```
public java.util.List<ConvexObject> getObjects()
```
    Gets all the objects in this game.
    
    Returns:
    
    All the objects in this game.
  - getVerticalDecomposition
```
public VerticalDecomposition getVerticalDecomposition()
```
    Gets the vertical decomposition for the game state.
    
    Returns:
    
    The vertical decomposition.
  - getHelperLines
```
public java.util.List<java.awt.geom.Line2D> getHelperLines(java.awt.geom.Point2D p)
```
    Gets the helper lines to be drawn from the currently selected first object to the given point.
    
    Parameters:
    
    p - The point to draw the helper lines to.
    
    Returns:
    
    The helper lines from the currently selected object to the given point, or null if there is no object selected currently.
  - isSelectingSecond
```
public boolean isSelectingSecond()
```
    True if the active player is currently selecting a second object to merge with.
    
    Returns:
    
    True if the active player is selecting a second object for a merge.
  - stream
```
public java.util.stream.Stream<ConvexObject> stream()
```
    Streams all the objects in this game.
    
    Returns:
    
    A stream of all the objects in this game.
  - getPlayers
```
public java.util.List<Player> getPlayers()
```
    Gets a list of all the players in this game.
    
    Returns:
    
    All the players in this game.
  - getPlayerCount
```
public int getPlayerCount()
```
    Gets the total number of players in this game.
    
    Returns:
    
    The total number of players.
  - executePlayerTurn
```
public void executePlayerTurn()
                       throws java.lang.InterruptedException
```
    Executes the turn for the active player.
    
    Throws:
    
    java.lang.InterruptedException - When the current thread is interrupted while the player is executing its move. This signals that the game was aborted.
    
    See Also:
    
    getActivePlayer()
  - isFinished
```
public boolean isFinished()
```
    Checks if the game is finished.
    
    Returns:
    
    True if the game is finished.
  - getGameTime
```
public long getGameTime()
```
    Gets the total number of milliseconds this game took or is taking up to this point in time.
    
    Returns:
    
    The total game time in milliseconds.
  - getRounds
```
public int getRounds()
```
    Gets the number of rounds in this game. In a single round each players gets a single turn. Note that the last round can be a partial round where not every player got a turn.
    
    Returns:
    
    The number of rounds.
  - setSelectedObject
```
public void setSelectedObject(ConvexObject obj)
```
    Sets the object selected by the current player. This is the object the player intends to start a merge from. Note that it is generally safer to use claimObject(ConvexObject) to set this value as this method does not perform any checks to ensure it is actually valid for the player to select the provided object.
    
    Parameters:
    
    obj - The objected to set as selected.
    
    See Also:
    
    claimObject(ConvexObject), claimObject(ConvexObject, Point2D)
  - clearSelection
```
public void clearSelection()
```
    Clears the object selection for the active player, meaning they are no longer selecting a second object for a merge.
  - getSelectedObject
```
public ConvexObject getSelectedObject()
```
    Gets the (first) object selected by the player.
    
    Returns:
    
    The currently selected object to start a merge from or null.
    
    See Also:
    
    isSelectingSecond()
  - abort
```
public void abort()
```
    Signals that this game was forcefully terminated before it was supposed to finish.

Class GameState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

objects

players

decomp

activePlayer

selected

ended

gameStart

gameEnd

turns

listeners

seed

segmentTreeConj

segmentTreeKD

Constructor Detail

GameState

GameState

Method Detail

getSegmentTreeConj

getSegmentTreeKD

init

ready

getSeed

registerStateListener

claimObject

claimObject

endTurn

mergeObjects

getActivePlayer

getObject

getObject

getObjects

getVerticalDecomposition

getHelperLines

isSelectingSecond

stream

getPlayers

getPlayerCount

executePlayerTurn

isFinished

getGameTime

getRounds

setSelectedObject

clearSelection

getSelectedObject

abort