org.jzy3d.plot3d.rendering.view

Class AbstractViewportManager

java.lang.Object

org.jzy3d.plot3d.rendering.view.AbstractViewportManager

Direct Known Subclasses:

AWTImageViewport, Camera

public abstract class AbstractViewportManager
extends Object

An AbstractViewportManager describes an element that occupies the whole rendering ICanvas or only a vertical slice of it. The AbstractViewportManager also provides a utility function for debugging the slices, that is the ability to display a 10*10 grid for checking the space occupied by the actual viewport definition.

Author:

Martin Pernollet

Field Summary

Fields

Modifier and Type	Field and Description
protected ViewportConfiguration	lastViewPort
protected ViewportMode	mode
protected float	ratioHeight
protected float	ratioWidth
protected int	screenBottom
protected boolean	screenGridDisplayed
protected int	screenHeight
protected int	screenLeft
protected int	screenSquaredDim
protected int	screenWidth
protected int	screenXOffset
protected int	screenYOffset

Constructor Summary

Constructors

Constructor and Description
AbstractViewportManager()

Method Summary

Modifier and Type	Method and Description
protected ViewportConfiguration	applyViewport(com.jogamp.opengl.GL gl, com.jogamp.opengl.glu.GLU glu) Build and return a ViewportConfiguration.
ViewportConfiguration	getLastViewPort()
ViewportMode	getMode()
Rectangle	getRectangle() Returns the (x,y) offset that was applied to make this AbstractViewportManager stand in the appropriate canvas part. and the actual width and height of the viewport.
protected void	renderSubScreenGrid(com.jogamp.opengl.GL gl, com.jogamp.opengl.glu.GLU glu) Renders a grid on the defined sub screen.
void	setScreenGridDisplayed(boolean status) Set the status of the screen grid.
void	setViewPort(int width, int height) Set the view port (size of the renderer).
void	setViewPort(int width, int height, float left, float right) Set the view port (size of the renderer).
void	setViewPort(ViewportConfiguration viewport)
void	setViewportMode(ViewportMode mode)

Methods inherited from class java.lang.Object

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

Field Detail

lastViewPort

protected ViewportConfiguration lastViewPort

screenLeft

protected int screenLeft

screenBottom

protected int screenBottom

screenXOffset

protected int screenXOffset

screenYOffset

protected int screenYOffset

screenWidth

protected int screenWidth

screenHeight

protected int screenHeight

screenSquaredDim

protected int screenSquaredDim

screenGridDisplayed

protected boolean screenGridDisplayed

mode

protected ViewportMode mode

ratioWidth

protected float ratioWidth

ratioHeight

protected float ratioHeight

Constructor Detail

AbstractViewportManager

public AbstractViewportManager()

Method Detail

setViewPort

public void setViewPort(int width,
                        int height)

Set the view port (size of the renderer).

Parameters:

width - the width of the target window.

height - the height of the target window.

getMode

public ViewportMode getMode()

setViewportMode

public void setViewportMode(ViewportMode mode)

setViewPort

public void setViewPort(int width,
                        int height,
                        float left,
                        float right)

Set the view port (size of the renderer).

Parameters:

width - the width of the target window.

height - the height of the target window.

left - the width's ratio where this subscreen starts in the target window.

right - the width's ratio where this subscreen stops in the target window.

Throws:

an - IllegalArgumentException if right is not greater than left.

setViewPort

public void setViewPort(ViewportConfiguration viewport)

getLastViewPort

public ViewportConfiguration getLastViewPort()

applyViewport

protected ViewportConfiguration applyViewport(com.jogamp.opengl.GL gl,
                                              com.jogamp.opengl.glu.GLU glu)

Build and return a ViewportConfiguration. Uses gl to

• apply viewport
• optionnaly to render the viewport debug grid

Parameters:

gl -

glu -

getRectangle

public Rectangle getRectangle()

Returns the (x,y) offset that was applied to make this AbstractViewportManager stand in the appropriate canvas part. and the actual width and height of the viewport. Only relevant after a call to applyViewPort.

setScreenGridDisplayed

public void setScreenGridDisplayed(boolean status)

Set the status of the screen grid.

Parameters:

status - the grid is displayed if status is set to true

renderSubScreenGrid

protected void renderSubScreenGrid(com.jogamp.opengl.GL gl,
                                   com.jogamp.opengl.glu.GLU glu)

Renders a grid on the defined sub screen.