com.simsilica.lemur.event

Class PickEventSession

java.lang.Object

com.simsilica.lemur.event.PickEventSession

public class PickEventSession
extends java.lang.Object

Encapsulates the state necessary to deliver events to targets, track capture, track enter/exit, etc. devoid of specific mouse events. This allows it to be used for arbitrary picking as would be needed by joysticks or when clicking on off-screen rendered views of different scenes.

Collision roots may either be perspective or orthogonal and the appropriate type of collision is done. The ViewPort's camera is used to detect the difference.

Events are delivered in near to far order to any 'target' that the cursor ray collides with until the event is consumed. Enter and exit events are delivered as targets are acquired or lost.

If a button down event happens over a target then it is considered 'captured'. This spatial will be provided to subsequent events in addition to the normal target. Furthermore, any new motion events are always delivered to the captured spatial first.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PickEventSession.RootEntry

Constructor Summary

Constructors

Modifier	Constructor and Description
	PickEventSession()
protected	PickEventSession(java.util.Map<com.jme3.collision.Collidable,PickEventSession.RootEntry> roots)

Method Summary

Modifier and Type	Method and Description
void	addCollisionRoot(com.jme3.scene.Spatial root, com.jme3.renderer.ViewPort viewPort)
void	addCollisionRoot(com.jme3.scene.Spatial root, com.jme3.renderer.ViewPort viewPort, java.lang.String layer)
void	addCollisionRoot(com.jme3.renderer.ViewPort viewPort)
void	addCollisionRoot(com.jme3.renderer.ViewPort viewPort, java.lang.String layer)
boolean	buttonEvent(int buttonIndex, int x, int y, boolean pressed)
void	clearHitTarget() Clears the current hit target that is used for entered/exited processing.
PickEventSession	clone() Creates a new PickEventSession with the same roots that his pick event session has at the time of cloning.
void	close() Clears the hit target and clears all internal data including collision roots.
boolean	cursorMoved(int x, int y) Called when the cursor has moved.
boolean	cursorMoved(int x, int y, int scroll) Called when the cursor has moved in an environment where there is also a separate scroll wheel or other scroll control.
protected com.jme3.scene.Spatial	findHitTarget(com.jme3.scene.Spatial hit) Finds a spatial in the specified spatial's hierarchy that is capable of recieving mouse events.
protected PickEventSession.RootEntry	findRootEntry(com.jme3.scene.Spatial s)
com.jme3.renderer.ViewPort	findViewPort(com.jme3.scene.Spatial s)
java.lang.String[]	getPickLayerOrder()
protected com.jme3.math.Ray	getPickRay(PickEventSession.RootEntry rootEntry, com.jme3.math.Vector2f cursor)
protected com.jme3.util.SafeArrayList<PickEventSession.RootEntry>	getRootList()
protected float[]	getZBounds(com.jme3.scene.Spatial s) Returns the min and max world z values for the specified spatial.
boolean	isDebugOn() Returns true if extra debug logging has been turned on.
protected boolean	isTraceEnabled()
void	removeCollisionRoot(com.jme3.scene.Spatial root)
void	removeCollisionRoot(com.jme3.renderer.ViewPort viewPort)
protected void	setCurrentHitTarget(com.jme3.renderer.ViewPort viewport, com.jme3.scene.Spatial s, com.jme3.math.Vector2f cursor, com.jme3.collision.CollisionResult cr)
void	setDebugOn(boolean f) Turns on extra debug logging.
void	setPickLayerOrder(java.lang.String... layers)
protected void	trace(java.lang.String msg)
protected boolean	viewContains(com.jme3.renderer.Camera cam, com.jme3.math.Vector2f cursor)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PickEventSession

public PickEventSession()

PickEventSession

protected PickEventSession(java.util.Map<com.jme3.collision.Collidable,PickEventSession.RootEntry> roots)

Method Detail

setDebugOn

public void setDebugOn(boolean f)

Turns on extra debug logging. This will cause all of the logging that would normally be at trace level for any instance to be at debug level just for _this_ instance.

isDebugOn

public boolean isDebugOn()

Returns true if extra debug logging has been turned on.

isTraceEnabled

protected boolean isTraceEnabled()

trace

protected void trace(java.lang.String msg)

clone

public PickEventSession clone()

Creates a new PickEventSession with the same roots that his pick event session has at the time of cloning.

Overrides:

clone in class java.lang.Object

findViewPort

public com.jme3.renderer.ViewPort findViewPort(com.jme3.scene.Spatial s)

findRootEntry

protected PickEventSession.RootEntry findRootEntry(com.jme3.scene.Spatial s)

addCollisionRoot

public void addCollisionRoot(com.jme3.renderer.ViewPort viewPort)

addCollisionRoot

public void addCollisionRoot(com.jme3.renderer.ViewPort viewPort,
                             java.lang.String layer)

addCollisionRoot

public void addCollisionRoot(com.jme3.scene.Spatial root,
                             com.jme3.renderer.ViewPort viewPort)

addCollisionRoot

public void addCollisionRoot(com.jme3.scene.Spatial root,
                             com.jme3.renderer.ViewPort viewPort,
                             java.lang.String layer)

removeCollisionRoot

public void removeCollisionRoot(com.jme3.renderer.ViewPort viewPort)

removeCollisionRoot

public void removeCollisionRoot(com.jme3.scene.Spatial root)

setPickLayerOrder

public void setPickLayerOrder(java.lang.String... layers)

getPickLayerOrder

public java.lang.String[] getPickLayerOrder()

clearHitTarget

public void clearHitTarget()

Clears the current hit target that is used for entered/exited processing. This will cause any currently 'entered' spatial to receive an 'exited' event. This is useful for when the thing that initiated this session is done (temporarily or otherwise) sending events to this session.

close

public void close()

Clears the hit target and clears all internal data including collision roots.

findHitTarget

protected com.jme3.scene.Spatial findHitTarget(com.jme3.scene.Spatial hit)

Finds a spatial in the specified spatial's hierarchy that is capable of recieving mouse events.

setCurrentHitTarget

protected void setCurrentHitTarget(com.jme3.renderer.ViewPort viewport,
                                   com.jme3.scene.Spatial s,
                                   com.jme3.math.Vector2f cursor,
                                   com.jme3.collision.CollisionResult cr)

getRootList

protected com.jme3.util.SafeArrayList<PickEventSession.RootEntry> getRootList()

viewContains

protected boolean viewContains(com.jme3.renderer.Camera cam,
                               com.jme3.math.Vector2f cursor)

getZBounds

protected float[] getZBounds(com.jme3.scene.Spatial s)

Returns the min and max world z values for the specified spatial.

getPickRay

protected com.jme3.math.Ray getPickRay(PickEventSession.RootEntry rootEntry,
                                       com.jme3.math.Vector2f cursor)

cursorMoved

public boolean cursorMoved(int x,
                           int y)

Called when the cursor has moved.

cursorMoved

public boolean cursorMoved(int x,
                           int y,
                           int scroll)

Called when the cursor has moved in an environment where there is also a separate scroll wheel or other scroll control.

buttonEvent

public boolean buttonEvent(int buttonIndex,
                           int x,
                           int y,
                           boolean pressed)