synergynetframework.jme.pickingsystem.data
Class PickResultData

java.lang.Object
  synergynetframework.jme.pickingsystem.data.PickResultData

Direct Known Subclasses:

OrthogonalPickResultData, ThreeDPickResultData

public class PickResultData
extends java.lang.Object

The Class PickResultData.

Constructor Summary

PickResultData(long originatingCursorID, com.jme.scene.Spatial pickedSpatial)
Instantiates a new pick result data.

Method Summary

float	getDistanceWhenPicked() Gets the distance when picked.
long	getOriginatingCursorID() Retrieve the ID of the cursor that caused the pick.
com.jme.scene.Spatial	getPickedSpatial() The jME spatial that was picked.
java.lang.String	getPickedSpatialName() Utility method to get the name of the spatial.
void	setDistanceWhenPicked(float distance) Sets the distance when picked.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PickResultData

public PickResultData(long originatingCursorID,
                      com.jme.scene.Spatial pickedSpatial)

Instantiates a new pick result data.

Parameters:

originatingCursorID - the originating cursor id

pickedSpatial - the picked spatial

Method Detail

getDistanceWhenPicked

public float getDistanceWhenPicked()

Gets the distance when picked.

Returns:

the distance when picked

getOriginatingCursorID

public long getOriginatingCursorID()

Retrieve the ID of the cursor that caused the pick.

Returns:

the originating cursor id

getPickedSpatial

public com.jme.scene.Spatial getPickedSpatial()

The jME spatial that was picked.

Returns:

the picked spatial

getPickedSpatialName

public java.lang.String getPickedSpatialName()

Utility method to get the name of the spatial.

Returns:

the picked spatial name

setDistanceWhenPicked

public void setDistanceWhenPicked(float distance)

Sets the distance when picked.

Parameters:

distance - the new distance when picked

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object