org.vizzini.ui.graphics
Interface IViewer

All Known Subinterfaces:
IViewerSwing
All Known Implementing Classes:
AbstractViewerSwing, ObjectViewerAWT, ObjectViewerJava3D, ObjectViewerSwing

public interface IViewer

Defines methods required by a 3D viewer. The coordinate system is screen based (+Z into the screen).

         ^ +Z
        /
       /
      +-----> +X
      |
      |
      V +Y
 

Since:
v0.2
Version:
v0.3
Author:
Jeffrey M. Thompson

Field Summary
static double MAGNIFICATION_FACTOR
          Magnification factor.
 
Method Summary
 void add(IShape shape)
          Add the given shape.
 double getMagnify()
          Return the magnification.
 double getPerspectiveConstant()
          Return the perspective constant.
 boolean isViewPointLightUsed()
           
 void remove(IShape shape)
          Remove the given shape.
 void setCanvasBackground(Color color)
          Set the canvas background color.
 void setMagnify(double magnify)
          Set the magnification.
 void setMagnifyPanelVisible(boolean isVisible)
          Set the visibility of the magnification panel.
 void setPerspectiveConstant(double d)
          Set the perspective constant.
 void setViewPointLightUsed(boolean isViewPointLightUsed)
           
 void setXScrollBarBlockIncrement(int increment)
          Set the block increment on the X scroll bar.
 void setXScrollBarUnitIncrement(int increment)
          Set the unit increment on the X scroll bar.
 void setXScrollBarValues(int value, int visible, int minimum, int maximum)
          Set the values on the X scroll bar.
 void setXScrollBarVisible(boolean isVisible)
          Set the visibility of the X scroll bar.
 void setYScrollBarBlockIncrement(int increment)
          Set the block increment on the Y scroll bar.
 void setYScrollBarUnitIncrement(int increment)
          Set the unit increment on the Y scroll bar.
 void setYScrollBarValues(int value, int visible, int minimum, int maximum)
          Set the values on the Y scroll bar.
 void setYScrollBarVisible(boolean isVisible)
          Set the visibility of the Y scroll bar.
 void setZScrollBarBlockIncrement(int increment)
          Set the block increment on the Z scroll bar.
 void setZScrollBarUnitIncrement(int increment)
          Set the unit increment on the Z scroll bar.
 void setZScrollBarValues(int value, int visible, int minimum, int maximum)
          Set the values on the Z scroll bar.
 void setZScrollBarVisible(boolean isVisible)
          Set the visibility of the Z scroll bar.
 void update()
          Update the shapes in this viewer.
 

Field Detail

MAGNIFICATION_FACTOR

static final double MAGNIFICATION_FACTOR
Magnification factor.

See Also:
Constant Field Values
Method Detail

add

void add(IShape shape)
Add the given shape.

Since:
v0.2

getMagnify

double getMagnify()
Return the magnification.

Since:
v0.2

getPerspectiveConstant

double getPerspectiveConstant()
Return the perspective constant.

Since:
v0.2

isViewPointLightUsed

boolean isViewPointLightUsed()
Returns:
Return isViewPointLightUsed.
Since:
v0.3

remove

void remove(IShape shape)
Remove the given shape.

Since:
v0.2

setCanvasBackground

void setCanvasBackground(Color color)
Set the canvas background color.

Since:
v0.2

setMagnify

void setMagnify(double magnify)
Set the magnification.

Since:
v0.2

setMagnifyPanelVisible

void setMagnifyPanelVisible(boolean isVisible)
Set the visibility of the magnification panel.

Since:
v0.2

setPerspectiveConstant

void setPerspectiveConstant(double d)
Set the perspective constant.

Since:
v0.2

setViewPointLightUsed

void setViewPointLightUsed(boolean isViewPointLightUsed)
Parameters:
isViewPointLightUsed - the isViewPointLightUsed to set
Since:
v0.3

setXScrollBarBlockIncrement

void setXScrollBarBlockIncrement(int increment)
Set the block increment on the X scroll bar.

Parameters:
increment - The amount by which to increment or decrement the scroll bar's value.
Since:
v0.2

setXScrollBarUnitIncrement

void setXScrollBarUnitIncrement(int increment)
Set the unit increment on the X scroll bar.

Parameters:
increment - The amount by which to increment or decrement the scroll bar's value.
Since:
v0.2

setXScrollBarValues

void setXScrollBarValues(int value,
                         int visible,
                         int minimum,
                         int maximum)
Set the values on the X scroll bar.

Parameters:
value - The position in the current window.
visible - The amount visible per page.
minimum - The minimum value of the scroll bar.
maximum - The maximum value of the scroll bar.
Since:
v0.2

setXScrollBarVisible

void setXScrollBarVisible(boolean isVisible)
Set the visibility of the X scroll bar.

Parameters:
isVisible - Flag indicating if the scroll bar is visible.
Since:
v0.2

setYScrollBarBlockIncrement

void setYScrollBarBlockIncrement(int increment)
Set the block increment on the Y scroll bar.

Parameters:
increment - The amount by which to increment or decrement the scroll bar's value.
Since:
v0.2

setYScrollBarUnitIncrement

void setYScrollBarUnitIncrement(int increment)
Set the unit increment on the Y scroll bar.

Parameters:
increment - The amount by which to increment or decrement the scroll bar's value.
Since:
v0.2

setYScrollBarValues

void setYScrollBarValues(int value,
                         int visible,
                         int minimum,
                         int maximum)
Set the values on the Y scroll bar.

Parameters:
value - The position in the current window.
visible - The amount visible per page.
minimum - The minimum value of the scroll bar.
maximum - The maximum value of the scroll bar.
Since:
v0.2

setYScrollBarVisible

void setYScrollBarVisible(boolean isVisible)
Set the visibility of the Y scroll bar.

Parameters:
isVisible - Flag indicating if the scroll bar is visible.
Since:
v0.2

setZScrollBarBlockIncrement

void setZScrollBarBlockIncrement(int increment)
Set the block increment on the Z scroll bar.

Parameters:
increment - The amount by which to increment or decrement the scroll bar's value.
Since:
v0.2

setZScrollBarUnitIncrement

void setZScrollBarUnitIncrement(int increment)
Set the unit increment on the Z scroll bar.

Parameters:
increment - The amount by which to increment or decrement the scroll bar's value.
Since:
v0.2

setZScrollBarValues

void setZScrollBarValues(int value,
                         int visible,
                         int minimum,
                         int maximum)
Set the values on the Z scroll bar.

Parameters:
value - The position in the current window.
visible - The amount visible per page.
minimum - The minimum value of the scroll bar.
maximum - The maximum value of the scroll bar.
Since:
v0.2

setZScrollBarVisible

void setZScrollBarVisible(boolean isVisible)
Set the visibility of the Z scroll bar.

Parameters:
isVisible - Flag indicating if the scroll bar is visible.
Since:
v0.2

update

void update()
Update the shapes in this viewer.

Since:
v0.3


Copyright 2007 Vizzini.org. All Rights Reserved. 2007.12.25.03.00.02