synergynetframework.jme.pickingsystem
Interface IJMEMultiTouchPicker

All Known Implementing Classes:
JMEMultiTouchPickSystem

public interface IJMEMultiTouchPicker

Defines the picking system for jMonkeyEngine. Each pick request should result in a List of pick results for that location. Each pick result is a spatial that was found to be under the request location. If the pick request asks for all results to be returned, they will, otherwise, only the closest will be returned.

Author:
dcs0ah1

Method Summary
 java.util.List<PickResultData> doPick(PickRequest pickRequest)
          Do pick.
 java.util.List<PickResultData> doPick(PickRequest pickRequest, boolean worldNodeOnly)
          Do pick.
 void setOrthogonalPickingRoot(com.jme.scene.Node twod)
          Sets the orthogonal picking root.
 void setPickingRootNode(com.jme.scene.Node rootNode)
          Sets the picking root node.
 

Method Detail

doPick

java.util.List<PickResultData> doPick(PickRequest pickRequest)
                                      throws PickSystemException
Do pick.

Parameters:
pickRequest - the pick request
Returns:
the list
Throws:
PickSystemException - the pick system exception

doPick

java.util.List<PickResultData> doPick(PickRequest pickRequest,
                                      boolean worldNodeOnly)
                                      throws PickSystemException
Do pick.

Parameters:
pickRequest - the pick request
worldNodeOnly - the world node only
Returns:
the list
Throws:
PickSystemException - the pick system exception

setOrthogonalPickingRoot

void setOrthogonalPickingRoot(com.jme.scene.Node twod)
                              throws PickSystemException
Sets the orthogonal picking root.

Parameters:
twod - the new orthogonal picking root
Throws:
PickSystemException - the pick system exception

setPickingRootNode

void setPickingRootNode(com.jme.scene.Node rootNode)
                        throws PickSystemException
Sets the picking root node.

Parameters:
rootNode - the new picking root node
Throws:
PickSystemException - the pick system exception