org.jzy3d.plot3d.primitives

Class AbstractDrawable

java.lang.Object

org.jzy3d.plot3d.primitives.AbstractDrawable

All Implemented Interfaces:

IGLRenderer, ISortableDraw

Direct Known Subclasses:

AbstractDrawableGraph2d, AbstractWireframeable, DrawableTexture, DrawableTextWrapper, DrawableVBO, Point, Scatter, ScatterMultiColor, ScatterMultiColorList, ScatterPoint

public abstract class AbstractDrawable
extends Object
implements IGLRenderer, ISortableDraw

A AbstractDrawable defines objects that may be rendered into an OpenGL context provided by a ICanvas.
A AbstractDrawable must basically provide a rendering function called draw() that receives a reference to a GL2 and a GLU context. It may also use a reference to a Camera in order to implement specific behaviors according to the Camera position.
A AbstractDrawable provides services for setting the transformation factor that is used inside the draw function, as well as a getter of the object's BoundingBox3d. Note that the BoundingBox must be set by a concrete descendant of a AbstractDrawable.
A good practice is to define a setData function for initializing a AbstractDrawable and building its polygons. Since each class may have its own inputs, setData is not part of the interface but should be used as a convention. When not defining a setData function, a AbstractDrawable may have its data loaded by an add(Drawable) function.

Note: A AbstractDrawable may last provide the information whether it is displayed or not, according to a rendering into the FeedBack buffer. This is currently supported specifically for the AxeBox object but could be extended with some few more algorithm for referencing all GL2 polygons.

Author:

Martin Pernollet

Field Summary

Fields

Modifier and Type	Field and Description
protected BoundingBox3d	bbox
protected Color	boundingBoxColor
protected boolean	boundingBoxDisplayed
protected boolean	displayed
protected boolean	hasListeners
protected ILegend	legend
protected boolean	legendDisplayed
protected List<IDrawableListener>	listeners
protected SpaceTransformer	spaceTransformer
protected Transform	transform
protected Transform	transformBefore

Constructor Summary

Constructors

Constructor and Description
AbstractDrawable()

Method Summary

Modifier and Type	Method and Description
void	addDrawableListener(IDrawableListener listener)
abstract void	applyGeometryTransform(Transform transform)
protected void	call(com.jogamp.opengl.GL gl, Color c)
protected void	call(com.jogamp.opengl.GL gl, Color c, float alpha)
protected void	callWithAlphaFactor(com.jogamp.opengl.GL gl, Color c, float alpha)
protected void	colorGL2(com.jogamp.opengl.GL gl, Color c) A helper to call glColor4f on the input color.
protected void	colorGLES2(Color c) A helper to call glColor4f on the input color.
void	dispose() Performs all required operation to cleanup the Drawable.
protected void	doDrawBounds(com.jogamp.opengl.GL gl, com.jogamp.opengl.glu.GLU glu, Camera cam)
void	doTransform(com.jogamp.opengl.GL gl, com.jogamp.opengl.glu.GLU glu, Camera cam)
abstract void	draw(com.jogamp.opengl.GL gl, com.jogamp.opengl.glu.GLU glu, Camera cam) Call OpenGL2 routines for rendering the object.
protected void	fireDrawableChanged(DrawableChangedEvent e)
protected void	fireDrawableChanged(int eventType)
Coord3d	getBarycentre() Return the barycentre of this object, which is computed as the center of its bounding box.
Color	getBoundingBoxColor()
BoundingBox3d	getBounds() Return the BoundingBox of this object.
double	getDistance(Camera camera) Return the distance of the object center to the Camera's eye.
ILegend	getLegend()
double	getLongestDistance(Camera camera)
double	getShortestDistance(Camera camera)
SpaceTransformer	getSpaceTransformer()
Transform	getTransform() Get object's transformation that is applied at the beginning of a call to draw(GL,GLU,Camera).
Transform	getTransformBefore()
boolean	hasLegend()
boolean	isBoundingBoxDisplayed()
boolean	isDisplayed() Return the display status of this object.
boolean	isLegendDisplayed()
protected void	negative(Color c)
void	removeDrawableListener(IDrawableListener listener)
void	setBoundingBoxColor(Color boundingBoxColor)
void	setBoundingBoxDisplayed(boolean boundingBoxDisplayed)
void	setDisplayed(boolean status) Set to true or false the displayed status of this object.
void	setLegend(ILegend face)
void	setLegendDisplayed(boolean status)
void	setSpaceTransformer(SpaceTransformer spaceTransformer)
void	setTransform(Transform transform) Set object's transformation that is applied at the beginning of a call to draw(GL,GLU,Camera).
void	setTransformBefore(Transform transformBefore)
String	toString()
String	toString(int depth)
abstract void	updateBounds()
protected void	vertexGL2(com.jogamp.opengl.GL gl, Coord3d c) A helper to call glVerted3f on the input coordinate.
protected void	vertexGLES2(Coord3d c) A helper to call glVerted3f on the input coordinate.

Methods inherited from class java.lang.Object

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

Field Detail

transform

protected Transform transform

transformBefore

protected Transform transformBefore

bbox

protected BoundingBox3d bbox

legend

protected ILegend legend

listeners

protected List<IDrawableListener> listeners

hasListeners

protected boolean hasListeners

displayed

protected boolean displayed

legendDisplayed

protected boolean legendDisplayed

boundingBoxDisplayed

protected boolean boundingBoxDisplayed

boundingBoxColor

protected Color boundingBoxColor

spaceTransformer

protected SpaceTransformer spaceTransformer

Constructor Detail

AbstractDrawable

public AbstractDrawable()

Method Detail

dispose

public void dispose()

Performs all required operation to cleanup the Drawable.

draw

public abstract void draw(com.jogamp.opengl.GL gl,
                          com.jogamp.opengl.glu.GLU glu,
                          Camera cam)

Call OpenGL2 routines for rendering the object.

Specified by:

draw in interface IGLRenderer

Parameters:

gl - GL2 context

glu - GLU context

cam - a reference to a shooting Camera.

applyGeometryTransform

public abstract void applyGeometryTransform(Transform transform)

updateBounds

public abstract void updateBounds()

doTransform

public void doTransform(com.jogamp.opengl.GL gl,
                        com.jogamp.opengl.glu.GLU glu,
                        Camera cam)

doDrawBounds

protected void doDrawBounds(com.jogamp.opengl.GL gl,
                            com.jogamp.opengl.glu.GLU glu,
                            Camera cam)

vertexGL2

protected void vertexGL2(com.jogamp.opengl.GL gl,
                         Coord3d c)

A helper to call glVerted3f on the input coordinate. For GL2 profile only. If logTransform is non null, then each dimension transform is processed before calling glVertex3d.

vertexGLES2

protected void vertexGLES2(Coord3d c)

A helper to call glVerted3f on the input coordinate. For GLES2 profile only. If logTransform is non null, then each dimension transform is processed before calling glVertex3d.

colorGL2

protected void colorGL2(com.jogamp.opengl.GL gl,
                        Color c)

A helper to call glColor4f on the input color. For GL2 profile only.

colorGLES2

protected void colorGLES2(Color c)

A helper to call glColor4f on the input color. For GLES2 profile only.

call

protected void call(com.jogamp.opengl.GL gl,
                    Color c)

call

protected void call(com.jogamp.opengl.GL gl,
                    Color c,
                    float alpha)

callWithAlphaFactor

protected void callWithAlphaFactor(com.jogamp.opengl.GL gl,
                                   Color c,
                                   float alpha)

negative

protected void negative(Color c)

setTransform

public void setTransform(Transform transform)

Set object's transformation that is applied at the beginning of a call to draw(GL,GLU,Camera).

Parameters:

transform -

getTransform

public Transform getTransform()

Get object's transformation that is applied at the beginning of a call to draw(GL,GLU,Camera).

Returns:

transform

getTransformBefore

public Transform getTransformBefore()

setTransformBefore

public void setTransformBefore(Transform transformBefore)

getBounds

public BoundingBox3d getBounds()

Return the BoundingBox of this object.

Returns:

a bounding box

getBarycentre

public Coord3d getBarycentre()

Return the barycentre of this object, which is computed as the center of its bounding box. If the bounding box is not available, the returned value is Coord3d.INVALID

Returns:

the center of the bounding box, or Coord3d.INVALID.

setDisplayed

public void setDisplayed(boolean status)

Set to true or false the displayed status of this object.

Parameters:

status -

isDisplayed

public boolean isDisplayed()

Return the display status of this object.

getDistance

public double getDistance(Camera camera)

Return the distance of the object center to the Camera's eye.

Specified by:

getDistance in interface ISortableDraw

getShortestDistance

public double getShortestDistance(Camera camera)

Specified by:

getShortestDistance in interface ISortableDraw

getLongestDistance

public double getLongestDistance(Camera camera)

Specified by:

getLongestDistance in interface ISortableDraw

setLegend

public void setLegend(ILegend face)

getLegend

public ILegend getLegend()

hasLegend

public boolean hasLegend()

setLegendDisplayed

public void setLegendDisplayed(boolean status)

isLegendDisplayed

public boolean isLegendDisplayed()

isBoundingBoxDisplayed

public boolean isBoundingBoxDisplayed()

setBoundingBoxDisplayed

public void setBoundingBoxDisplayed(boolean boundingBoxDisplayed)

getBoundingBoxColor

public Color getBoundingBoxColor()

setBoundingBoxColor

public void setBoundingBoxColor(Color boundingBoxColor)

getSpaceTransformer

public SpaceTransformer getSpaceTransformer()

setSpaceTransformer

public void setSpaceTransformer(SpaceTransformer spaceTransformer)

addDrawableListener

public void addDrawableListener(IDrawableListener listener)

removeDrawableListener

public void removeDrawableListener(IDrawableListener listener)

fireDrawableChanged

protected void fireDrawableChanged(int eventType)

fireDrawableChanged

protected void fireDrawableChanged(DrawableChangedEvent e)

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(int depth)