synergynetframework.jme.cursorsystem.cursordata
Class ScreenCursor

java.lang.Object
  extended by synergynetframework.jme.cursorsystem.cursordata.ScreenCursor

public class ScreenCursor
extends java.lang.Object

Coordinate sytem for this class is jme screen coordinates.

Author:
dcs0ah1

Constructor Summary
ScreenCursor(long id)
          Instantiates a new screen cursor.
 
Method Summary
 void addPositionItem(ScreenCursorRecord item)
          Adds the position item.
 boolean equals(java.lang.Object obj)
           
 ScreenCursorRecord getCurrentCursorScreenPosition()
          Get current position in jME Screen Coordinates.
 int getCurrentPositionIndex()
          Gets the current position index.
 long getCursorCreatedTime()
          Gets the cursor created time.
 long getCursorLiveTime()
          Gets the cursor live time.
 ScreenCursorRecord getCursorOrigin()
          Gets the cursor origin.
 long getID()
          Gets the id.
 int getNumPoints()
          Gets the num points.
 ScreenCursorRecord getOldCursorScreenPosition()
          Gets the old cursor screen position.
 PickResultData getPickResult()
          Gets the pick result.
 java.util.ArrayList<ScreenCursorRecord> getPoints()
          Gets the points.
 ScreenCursorRecord getPositionAtIndex(int i)
          Get position at specified index in jME Screen Coordinates.
 int hashCode()
           
 boolean isProbablyTheSameAs(ScreenCursor c)
          Checks if is probably the same as.
 void setOldCursorScreenPosition(ScreenCursorRecord c)
          Sets the old cursor screen position.
 void setPickResult(PickResultData pr)
          Sets the pick result.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScreenCursor

public ScreenCursor(long id)
Instantiates a new screen cursor.

Parameters:
id - the id
Method Detail

addPositionItem

public void addPositionItem(ScreenCursorRecord item)
Adds the position item.

Parameters:
item - the item

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

getCurrentCursorScreenPosition

public ScreenCursorRecord getCurrentCursorScreenPosition()
Get current position in jME Screen Coordinates.

Returns:
the current cursor screen position

getCurrentPositionIndex

public int getCurrentPositionIndex()
Gets the current position index.

Returns:
the current position index

getCursorCreatedTime

public long getCursorCreatedTime()
Gets the cursor created time.

Returns:
the cursor created time

getCursorLiveTime

public long getCursorLiveTime()
Gets the cursor live time.

Returns:
the cursor live time

getCursorOrigin

public ScreenCursorRecord getCursorOrigin()
Gets the cursor origin.

Returns:
the cursor origin

getID

public long getID()
Gets the id.

Returns:
the id

getNumPoints

public int getNumPoints()
Gets the num points.

Returns:
the num points

getOldCursorScreenPosition

public ScreenCursorRecord getOldCursorScreenPosition()
Gets the old cursor screen position.

Returns:
the old cursor screen position

getPickResult

public PickResultData getPickResult()
Gets the pick result.

Returns:
the pick result

getPoints

public java.util.ArrayList<ScreenCursorRecord> getPoints()
Gets the points.

Returns:
the points

getPositionAtIndex

public ScreenCursorRecord getPositionAtIndex(int i)
Get position at specified index in jME Screen Coordinates.

Parameters:
i - the i
Returns:
the position at index

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

isProbablyTheSameAs

public boolean isProbablyTheSameAs(ScreenCursor c)
Checks if is probably the same as.

Parameters:
c - the c
Returns:
true, if is probably the same as

setOldCursorScreenPosition

public void setOldCursorScreenPosition(ScreenCursorRecord c)
Sets the old cursor screen position.

Parameters:
c - the new old cursor screen position

setPickResult

public void setPickResult(PickResultData pr)
Sets the pick result.

Parameters:
pr - the new pick result

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object