visad
Class GraphicsModeControl

java.lang.Object
  extended by visad.Control
      extended by visad.GraphicsModeControl
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
GraphicsModeControlJ2D, GraphicsModeControlJ3D

public abstract class GraphicsModeControl
extends Control
implements java.lang.Cloneable

GraphicsModeControl is the VisAD interface class for controlling various mode settings for rendering.

A GraphicsModeControl is not linked to any DisplayRealType or ScalarMap. It is linked to a DisplayImpl.

See Also:
Serialized Form

Field Summary
static int AVERAGE_COLOR_MODE
          color styles for merging color maps
static int DASH_DOT_STYLE
           
static int DASH_STYLE
           
static int DOT_STYLE
           
static int SOLID_STYLE
          line styles for Display.LineStyle mapping
static int SUM_COLOR_MODE
           
 
Constructor Summary
GraphicsModeControl(DisplayImpl d)
           
 
Method Summary
abstract  java.lang.Object clone()
          a method to copy any data object
abstract  int getColorMode()
           
abstract  int getCurvedSize()
           
abstract  int getLineStyle()
           
abstract  float getLineWidth()
           
abstract  boolean getMissingTransparent()
           
abstract  boolean getMode2D()
           
abstract  boolean getPointMode()
           
abstract  float getPointSize()
           
abstract  int getPolygonMode()
           
abstract  int getProjectionPolicy()
           
 java.lang.String getSaveString()
          get a string that can be used to reconstruct this control later
abstract  boolean getScaleEnable()
           
abstract  boolean getTextureEnable()
           
abstract  int getTransparencyMode()
           
abstract  void setColorMode(int mode)
          set the mode for merging color mappings The color modes are: GraphicsModeControl.AVERAGE_COLOR_MODE GraphicsModeControl.SUM_COLOR_MODE
abstract  void setCurvedSize(int curved_size)
           
abstract  void setLineStyle(int style)
          set the style of line rendering; this is over-ridden by ConstantMaps to Display.LineStyle The line styles are: GraphicsModeControl.SOLID_STYLE GraphicsModeControl.DASH_STYLE GraphicsModeControl.DOT_STYLE GraphicsModeControl.DASH_DOT_STYLE
abstract  void setLineStyle(int style, boolean dummy)
           
abstract  void setLineWidth(float width)
          set the width of line rendering; this is over-ridden by ConstantMaps to Display.LineWidth
abstract  void setLineWidth(float width, boolean dummy)
           
abstract  void setMissingTransparent(boolean missing)
           
abstract  void setPointMode(boolean mode)
          if mode is true this will cause some rendering as points rather than lines or surfaces
abstract  void setPointSize(float size)
          set the size for point rendering; this is over-ridden by ConstantMaps to Display.PointSize
abstract  void setPointSize(float size, boolean dummy)
           
abstract  void setPolygonMode(int mode)
           
abstract  void setProjectionPolicy(int policy)
          sets a graphics-API-specific projection policy (e.g., PARALLEL_PROJECTION, PERSPECTIVE_PROJECTION)
 void setSaveString(java.lang.String save)
          reconstruct this control using the specified save string
abstract  void setScaleEnable(boolean enable)
          if enable is true this will enable numerical scales along display spatial axes
abstract  void setTextureEnable(boolean enable)
          if enable is true this will enable use of texture mapping, where appropriate
abstract  void setTransparencyMode(int mode)
          sets a graphics-API-specific transparency mode (e.g., SCREEN_DOOR, BLENDED)
 
Methods inherited from class visad.Control
addControlListener, animation_string, changeControl, checkTicks, equals, getDisplay, getDisplayRenderer, getInstanceNumber, incTick, nullControl, peekTicks, removeControlListener, resetTicks, setTicks, subCheckTicks, subPeekTicks, subResetTicks, subSetTicks, syncControl, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SOLID_STYLE

public static final int SOLID_STYLE
line styles for Display.LineStyle mapping

See Also:
Constant Field Values

DASH_STYLE

public static final int DASH_STYLE
See Also:
Constant Field Values

DOT_STYLE

public static final int DOT_STYLE
See Also:
Constant Field Values

DASH_DOT_STYLE

public static final int DASH_DOT_STYLE
See Also:
Constant Field Values

AVERAGE_COLOR_MODE

public static final int AVERAGE_COLOR_MODE
color styles for merging color maps

See Also:
Constant Field Values

SUM_COLOR_MODE

public static final int SUM_COLOR_MODE
See Also:
Constant Field Values
Constructor Detail

GraphicsModeControl

public GraphicsModeControl(DisplayImpl d)
Method Detail

getMode2D

public abstract boolean getMode2D()

getLineWidth

public abstract float getLineWidth()

setLineWidth

public abstract void setLineWidth(float width)
                           throws VisADException,
                                  java.rmi.RemoteException
set the width of line rendering; this is over-ridden by ConstantMaps to Display.LineWidth

Throws:
VisADException
java.rmi.RemoteException

setLineWidth

public abstract void setLineWidth(float width,
                                  boolean dummy)

getPointSize

public abstract float getPointSize()

setPointSize

public abstract void setPointSize(float size)
                           throws VisADException,
                                  java.rmi.RemoteException
set the size for point rendering; this is over-ridden by ConstantMaps to Display.PointSize

Throws:
VisADException
java.rmi.RemoteException

setPointSize

public abstract void setPointSize(float size,
                                  boolean dummy)

getLineStyle

public abstract int getLineStyle()

setLineStyle

public abstract void setLineStyle(int style)
                           throws VisADException,
                                  java.rmi.RemoteException
set the style of line rendering; this is over-ridden by ConstantMaps to Display.LineStyle The line styles are:
  • GraphicsModeControl.SOLID_STYLE
  • GraphicsModeControl.DASH_STYLE
  • GraphicsModeControl.DOT_STYLE
  • GraphicsModeControl.DASH_DOT_STYLE

    Throws:
    VisADException
    java.rmi.RemoteException

  • setLineStyle

    public abstract void setLineStyle(int style,
                                      boolean dummy)

    getColorMode

    public abstract int getColorMode()

    setColorMode

    public abstract void setColorMode(int mode)
                               throws VisADException,
                                      java.rmi.RemoteException
    set the mode for merging color mappings The color modes are:
  • GraphicsModeControl.AVERAGE_COLOR_MODE
  • GraphicsModeControl.SUM_COLOR_MODE

    Throws:
    VisADException
    java.rmi.RemoteException

  • getPointMode

    public abstract boolean getPointMode()

    setPointMode

    public abstract void setPointMode(boolean mode)
                               throws VisADException,
                                      java.rmi.RemoteException
    if mode is true this will cause some rendering as points rather than lines or surfaces

    Throws:
    VisADException
    java.rmi.RemoteException

    getTextureEnable

    public abstract boolean getTextureEnable()

    setTextureEnable

    public abstract void setTextureEnable(boolean enable)
                                   throws VisADException,
                                          java.rmi.RemoteException
    if enable is true this will enable use of texture mapping, where appropriate

    Throws:
    VisADException
    java.rmi.RemoteException

    getScaleEnable

    public abstract boolean getScaleEnable()

    setScaleEnable

    public abstract void setScaleEnable(boolean enable)
                                 throws VisADException,
                                        java.rmi.RemoteException
    if enable is true this will enable numerical scales along display spatial axes

    Throws:
    VisADException
    java.rmi.RemoteException

    getTransparencyMode

    public abstract int getTransparencyMode()

    setTransparencyMode

    public abstract void setTransparencyMode(int mode)
                                      throws VisADException,
                                             java.rmi.RemoteException
    sets a graphics-API-specific transparency mode (e.g., SCREEN_DOOR, BLENDED)

    Throws:
    VisADException
    java.rmi.RemoteException

    setProjectionPolicy

    public abstract void setProjectionPolicy(int policy)
                                      throws VisADException,
                                             java.rmi.RemoteException
    sets a graphics-API-specific projection policy (e.g., PARALLEL_PROJECTION, PERSPECTIVE_PROJECTION)

    Throws:
    VisADException
    java.rmi.RemoteException

    getProjectionPolicy

    public abstract int getProjectionPolicy()

    setPolygonMode

    public abstract void setPolygonMode(int mode)
                                 throws VisADException,
                                        java.rmi.RemoteException
    Throws:
    VisADException
    java.rmi.RemoteException

    getPolygonMode

    public abstract int getPolygonMode()

    setMissingTransparent

    public abstract void setMissingTransparent(boolean missing)
                                        throws VisADException,
                                               java.rmi.RemoteException
    Throws:
    VisADException
    java.rmi.RemoteException

    getMissingTransparent

    public abstract boolean getMissingTransparent()

    setCurvedSize

    public abstract void setCurvedSize(int curved_size)

    getCurvedSize

    public abstract int getCurvedSize()

    getSaveString

    public java.lang.String getSaveString()
    get a string that can be used to reconstruct this control later

    Specified by:
    getSaveString in class Control

    setSaveString

    public void setSaveString(java.lang.String save)
                       throws VisADException,
                              java.rmi.RemoteException
    reconstruct this control using the specified save string

    Specified by:
    setSaveString in class Control
    Throws:
    VisADException
    java.rmi.RemoteException

    clone

    public abstract java.lang.Object clone()
    a method to copy any data object

    Overrides:
    clone in class Control