com.bonzaiengine.opengl.helper

Class Picker

java.lang.Object

com.bonzaiengine.opengl.helper.Picker

public abstract class Picker
extends java.lang.Object

Picking mechanism using OpenGL back color buffer.
No extension are required and is compatible with all OpenGL and OpenGL Es version with all color buffer configuration.

Constructor Summary

Constructors

Constructor and Description
Picker()

Method Summary

Modifier and Type	Method and Description
int	getColorId(java.lang.Object object)
int	getPickAccuracy()
abstract boolean	pickEvent(IGLApi glApi, PickingEvent event, Area area) Triggered when a picking event is running, return true to process it
abstract void	pickMissed(IGLApi glApi, PickingEvent event, Area area) Call when no object was picked.
abstract void	processPicked(IGLApi glApi, PickingEvent event, Area area, java.lang.Object pickedSingle, java.util.HashSet<java.lang.Object> picked) Called when at least one object has been successfully picked
void	processPicking(IGLApi glApi, SceneView sceneView, PickingEvent mode, Area area)
abstract void	renderObjects(IGLApi glApi, SceneView sceneView) Render 3D objects to be picked.
void	setPickAccuracy(int pickAccuracy)

Methods inherited from class java.lang.Object

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

Constructor Detail

Picker

public Picker()

Method Detail

setPickAccuracy

public final void setPickAccuracy(int pickAccuracy)

Parameters:

pickAccuracy - picking accuracy in pixels. Default value: 1

getPickAccuracy

public final int getPickAccuracy()

pickEvent

public abstract boolean pickEvent(IGLApi glApi,
                                  PickingEvent event,
                                  Area area)

Triggered when a picking event is running, return true to process it

Parameters:

event - picking event

area - picking area

Returns:

true if the event should be processed

renderObjects

public abstract void renderObjects(IGLApi glApi,
                                   SceneView sceneView)

Render 3D objects to be picked.

processPicked

public abstract void processPicked(IGLApi glApi,
                                   PickingEvent event,
                                   Area area,
                                   java.lang.Object pickedSingle,
                                   java.util.HashSet<java.lang.Object> picked)

Called when at least one object has been successfully picked

Parameters:

event - picking event

area - picking area

pickedSingle - the object picked (or one object from the HashSet if area picking)

picked - the set of object picked, including pickedSingle

pickMissed

public abstract void pickMissed(IGLApi glApi,
                                PickingEvent event,
                                Area area)

Call when no object was picked.

Parameters:

event - picking event

area - picking area

getColorId

public final int getColorId(java.lang.Object object)

Parameters:

object - an object that could be picked

Returns:

the unique identifier for the object which is suitable for writting in color buffer

processPicking

public final void processPicking(IGLApi glApi,
                                 SceneView sceneView,
                                 PickingEvent mode,
                                 Area area)