com.simsilica.lemur.event

Class BasePickState

java.lang.Object

com.jme3.app.state.BaseAppState

com.simsilica.lemur.event.BasePickState

All Implemented Interfaces:

com.jme3.app.state.AppState, PickState

Direct Known Subclasses:

MouseAppState, TouchAppState

public abstract class BasePickState
extends com.jme3.app.state.BaseAppState
implements PickState

Consolidates the PickEventSession management for doing scene picking. This is the base class for the MouseAppState and the TouchAppState.

Field Summary

Fields inherited from interface com.simsilica.lemur.event.PickState

PICK_LAYER_GUI, PICK_LAYER_SCENE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasePickState()

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)
protected void	cleanup(com.jme3.app.Application app)
protected abstract void	dispatchMotion()
com.jme3.renderer.ViewPort	findViewPort(com.jme3.scene.Spatial s) Deprecated.
boolean	getIncludeDefaultCollisionRoots()
java.lang.String[]	getPickLayerOrder()
protected PickEventSession	getSession()
boolean	hasRequestedEnabled(java.lang.Object owner) Returns true if the specified owner has an active request for picking to be enabled.
protected void	initialize(com.jme3.app.Application app)
protected void	onDisable()
protected void	onEnable()
boolean	releaseEnabled(java.lang.Object owner) Signifies that the specified owner no longer needs the pick state to be enabled.
void	removeCollisionRoot(com.jme3.scene.Spatial root)
void	removeCollisionRoot(com.jme3.renderer.ViewPort viewPort)
void	requestEnabled(java.lang.Object owner) Signifies that the specified owner needs the pick state to be enabled.
boolean	resetEnabled() Refreshes the enabled/disabled state based on the current request count.
void	setIncludeDefaultCollisionRoots(boolean b)
void	setPickLayerOrder(java.lang.String... layers) Sets the order in which the pick layers will be checked for collisions.
void	update(float tpf)

Methods inherited from class com.jme3.app.state.BaseAppState

cleanup, getApplication, getState, getStateManager, initialize, isEnabled, isInitialized, postRender, render, setEnabled, stateAttached, stateDetached

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jme3.app.state.AppState

cleanup, initialize, isEnabled, isInitialized, postRender, render, setEnabled, stateAttached, stateDetached

Constructor Detail

BasePickState

protected BasePickState()

Method Detail

getSession

protected final PickEventSession getSession()

requestEnabled

public void requestEnabled(java.lang.Object owner)

Signifies that the specified owner needs the pick state to be enabled.

Specified by:

requestEnabled in interface PickState

releaseEnabled

public boolean releaseEnabled(java.lang.Object owner)

Signifies that the specified owner no longer needs the pick state to be enabled. Will return true if the state is still enabled (because of other requests) or false if the state is now disabled.

Specified by:

releaseEnabled in interface PickState

hasRequestedEnabled

public boolean hasRequestedEnabled(java.lang.Object owner)

Description copied from interface: PickState

Returns true if the specified owner has an active request for picking to be enabled.

Specified by:

hasRequestedEnabled in interface PickState

resetEnabled

public boolean resetEnabled()

Description copied from interface: PickState

Refreshes the enabled/disabled state based on the current request count. This is useful to reset the 'stack' if a forced enable/disable was previously done.

Specified by:

resetEnabled in interface PickState

setIncludeDefaultCollisionRoots

public void setIncludeDefaultCollisionRoots(boolean b)

Specified by:

setIncludeDefaultCollisionRoots in interface PickState

getIncludeDefaultCollisionRoots

public boolean getIncludeDefaultCollisionRoots()

Specified by:

getIncludeDefaultCollisionRoots in interface PickState

findViewPort

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

Deprecated.

addCollisionRoot

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

Specified by:

addCollisionRoot in interface PickState

addCollisionRoot

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

Specified by:

addCollisionRoot in interface PickState

addCollisionRoot

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

Specified by:

addCollisionRoot in interface PickState

addCollisionRoot

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

Specified by:

addCollisionRoot in interface PickState

removeCollisionRoot

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

Specified by:

removeCollisionRoot in interface PickState

removeCollisionRoot

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

Specified by:

removeCollisionRoot in interface PickState

setPickLayerOrder

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

Sets the order in which the pick layers will be checked for collisions. The default ordering is PICK_LAYER_GUI then PICK_LAYER_SCENE.

Specified by:

setPickLayerOrder in interface PickState

getPickLayerOrder

public java.lang.String[] getPickLayerOrder()

Specified by:

getPickLayerOrder in interface PickState

initialize

protected void initialize(com.jme3.app.Application app)

Specified by:

initialize in class com.jme3.app.state.BaseAppState

cleanup

protected void cleanup(com.jme3.app.Application app)

Specified by:

cleanup in class com.jme3.app.state.BaseAppState

onEnable

protected void onEnable()

Specified by:

onEnable in class com.jme3.app.state.BaseAppState

onDisable

protected void onDisable()

Specified by:

onDisable in class com.jme3.app.state.BaseAppState

update

public void update(float tpf)

Specified by:

update in interface com.jme3.app.state.AppState

Overrides:

update in class com.jme3.app.state.BaseAppState

dispatchMotion

protected abstract void dispatchMotion()