|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jme.intersection.PickResults
public abstract class PickResults
PickResults
contains information resulting from a pick test.
The results will contain a list of every node that was "struck" during a
pick test. Distance can be used to order the results. If checkDistance
is set, objects will be ordered with the first element in the list being the
closest picked object.
Constructor Summary | |
---|---|
PickResults()
Constructor instantiates a new PickResults object. |
Method Summary | |
---|---|
abstract void |
addPick(Ray ray,
Geometry g)
addPick generates an entry to be added to the list
of picked objects. |
void |
addPickData(PickData data)
Places a new geometry (enclosed in PickData) into the results list. |
void |
clear()
clear clears the list of all Geometry objects. |
int |
getNumber()
getNumber retrieves the number of geometries that have been
placed in the results. |
PickData |
getPickData(int i)
Retrieves a geometry (enclosed in PickData) from a specific index. |
abstract void |
processPick()
Optional method that can be implemented by sub classes to define methods for handling picked objects. |
void |
setCheckDistance(boolean checkDistance)
Sets if these pick results will order the data by distance from the origin of the Ray. |
boolean |
willCheckDistance()
Reports if these pick results will order the data by distance from the origin of the Ray. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PickResults()
PickResults
object.
Method Detail |
---|
public void addPickData(PickData data)
data
- the PickData to be placed in the results list.public int getNumber()
getNumber
retrieves the number of geometries that have been
placed in the results.
public PickData getPickData(int i)
i
- the index requested.
public void clear()
clear
clears the list of all Geometry objects.
public abstract void addPick(Ray ray, Geometry g)
addPick
generates an entry to be added to the list
of picked objects. If checkDistance is true, the implementing class
should order the object.
ray
- the ray that was cast for the pick calculation.g
- the object to add to the pick data.public abstract void processPick()
public boolean willCheckDistance()
public void setCheckDistance(boolean checkDistance)
checkDistance
- true if objects will be ordered by distance, false otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |