jv.loader
Class PvDisplayOption

java.lang.Object
  jv.vecmath.P_Vector
      jv.loader.PvDisplayOption

All Implemented Interfaces:

java.io.Serializable

public final class PvDisplayOption

extends P_Vector

Store settings of a JavaView display. This class may be initialized by reading display settings from a file and initialize a display, or by extracting the information of a current display.

See Also:

PvDisplayLoader, Serialized Form

Field Summary

static int	SHOW_3DLOOK Enable 3D look of lines and points.
static int	SHOW_ADAPTIVE_SIZE Enable adaptive size of lines and points.
static int	SHOW_ANTIALIAS Enable antialiasing of display.
static int	SHOW_AUTOCENTER Enable auto rotation in display.
static int	SHOW_AUTOFIT Enable auto rotation in display.
static int	SHOW_AUTOROTATE Enable auto rotation in display.
static int	SHOW_AXES Enable drawing of a coordinate axes around scene in the display.
static int	SHOW_AXES_AUTO_BOUNDS Flag specifies whether axes is in auto-bounds mode.
static int	SHOW_AXES_AUTO_CONFIGURE Deprecated. since JavaView 3.62.001, use SHOW_AXES_AUTO_HASHING.
static int	SHOW_AXES_AUTO_HASHING Flag specifies whether axes is in auto-hashing mode.
static int	SHOW_AXES_AUTO_LAYOUT Flag specifies whether axes is in auto-layout mode.
static int	SHOW_AXES_LABEL Deprecated. used SHOW_AXES_NUMBERS
static int	SHOW_AXES_NAME Enable drawing of name of coordinate axes.
static int	SHOW_AXES_NUMBERS Enable drawing of numbers of coordinate axes.
static int	SHOW_AXES_TITLE Deprecated. use SHOW_AXES_NAME
static int	SHOW_BACKGROUND_IMAGE Enable drawing of image in the background.
static int	SHOW_BORDER Enable drawing of sunk border around display canvas.
static int	SHOW_BOUNDING_BOX Enable drawing of bounding box around scene.
static int	SHOW_BOX_RATIO Enable usage of different scaling of axis.
static int	SHOW_CENTER Enable drawing of center of geometries.
static int	SHOW_CLEAR_SCREEN Enable reduction of number of edge drawings, each face edge is drawn only once.
static int	SHOW_CLIP_AUTO_BOUNDS Flag specifies whether clipRange is in auto-bounds mode.
static int	SHOW_CLIP_BOUNDS Enable clipping of coordinate axes.
static int	SHOW_COPYRIGHT Enable drawing of copyright information.
static int	SHOW_CROSS Enable drawing of cross at current cursor position.
static int	SHOW_DEPTHCUE Enable drawing of sunk border around display canvas.
static int	SHOW_DIRECT_SELECT Enable selection of geometries by simple pick with mouse.
static int	SHOW_DOUBLEBUFFER Enable drawing of a double buffered image in display canvas, default enabled.
static int	SHOW_DRAWING Enable drawing in display canvas, default enabled.
static int	SHOW_EDGE_AURA Enable drawing of aura in background color around each edge.
static int	SHOW_EDGES_ONCE Enable reduction of number of edge drawings, each face edge is drawn only once.
static int	SHOW_FILL_DISPLAY Determines if filling of display is enabled.
static int	SHOW_FOREGROUND_IMAGE Enable drawing of image in the foreground.
static int	SHOW_FRAME Enable drawing of a small coordinate frame in the lower left corner of the display.
static int	SHOW_INFO Enable drawing of additional information close to cursor in overlay window.
static int	SHOW_INTEGER_PICK Enable picking constraint to an integer grid.
static int	SHOW_LIGHTING Enable drawing of sunk border around display canvas.
static int	SHOW_LOCAL_TRANSFORM Use local coordinate system of geometry to calculate transformations.
static int	SHOW_MAGNET Attach cursor to vertices of nearby.
static int	SHOW_SINGLE Restrict drawing to a single geometry at the same time.
static int	SHOW_SORTING Enable sorting of geometry items according to Painter's algorithm.
static int	SHOW_TITLE Enable showing of title of display north in the display.
static int	SHOW_VISIBLE Enable visibility of display.
static int	SHOW_XY_GRID Enable drawing of coordinate grid in xy plane.
static int	SHOW_XZ_GRID Enable drawing of coordinate grid in xz plane.
static int	SHOW_YZ_GRID Enable drawing of coordinate grid in yz plane.
static int	SHOW_ZBUFFER Enable drawing in z-buffer mode.

Constructor Summary

PvDisplayOption()
Constructor sets all values to defaults.

Method Summary

void	configure(PvDisplayIf disp) Configure the given display with data from this option class.
java.lang.String	getAbstract()
java.awt.Color	getAmbientLight()
int	getArrayPosition() Get position of display within an array of displays.
java.awt.Dimension	getArraySize() Get dimensionof array of displays.
PsAuthorInfo	getAuthorInfo()
PgAxes	getAxes()
int	getAxesCoordSystem() Get coordinate system in which axes are shown.
PiVector	getAxesEdge() Currently unused except in PgMathLoader.
boolean[]	getAxesHash()
java.lang.String[]	getAxesLabel()
int	getAxesType() Get type of coordinate axes, see PgAxes.AXES_xxx.
java.awt.Color	getBackgroundColor() Get color of background of display.
java.awt.Image	getBackgroundImage() Get background image of display canvas.
java.lang.String	getBackgroundImageFile() Get background image filename of display canvas.
int	getBackgroundImageFit() Get the mode determining how a background image is scaled w.r.t. the display canvas.
java.awt.Color	getBndBoxColor() Get color of bounding box.
double	getBndBoxSize() Get thickness of edges of bounding box.
PdVector	getBoxRatio() Get scaling factors of edges of the bounding box.
double	getCameraAngle(int ind) deprecated use getCameraFieldOfView(int)
double	getCameraFarClip(int ind)
double	getCameraFieldOfView(int ind) Get opening angle of camera in degrees in [0,180].
PdVector	getCameraInterest(int ind)
PdMatrix	getCameraMatrix(int ind) Get the 4*4 camera transformation matrix.
java.lang.String	getCameraName(int ind)
double	getCameraNearClip(int ind)
PdVector	getCameraPosition(int ind)
int	getCameraProjection(int ind)
double	getCameraRoll(int ind)
double[]	getClipBounds(int ind) Get minimum and maximum in one dimension of the clipping box.
int	getClipBoundsType() Get index of axis which is selected when scene clip bounds is active or becomes active.
int	getCurrentCamera()
int	getDimAxes()
java.awt.Color	getForegroundColor() Get foreground color.
java.awt.Image	getForegroundImage() Get foreground image of display canvas.
java.lang.String	getForegroundImageFile() Get foreground image filename of display canvas.
int	getForegroundImageFit() Get the mode determining how a foreground image is scaled w.r.t. the display canvas.
double	getLightAngle(int ind)
java.awt.Color	getLightColor(int ind)
double	getLightCorona(int ind)
double	getLightExponent(int ind)
double	getLightFalloff(int ind)
int	getLightingModel()
java.lang.String	getLightingModelAsString()
double	getLightIntensity(int ind)
PdVector	getLightInterest(int ind)
java.lang.String	getLightName(int ind)
PdVector	getLightPosition(int ind)
int	getLightReference(int ind)
int	getLightShading(int ind)
int	getLightType(int ind)
int	getMajorMode() Get major transformation mode of display used with left-mouse.
int	getNumCameras()
int	getNumLights() Get number of available lights.
int	getNumRulers()
boolean	getOption(int flag) Check whether either of the bits in parameter has been set.
java.awt.Color	getRulerColor(int ind) Get polygon color of axis with given index.
double	getRulerMajorHashUnit(int ind) Get distance between two adjacent major hashings, used in PgRuler.HASH_FIXED mode.
double	getRulerMaxValue(int ind) Get maximum ruler value.
double	getRulerMinorHashUnit(int ind) Get distance between two adjacent minor hashings, used in PgRuler.HASH_FIXED mode.
double	getRulerMinValue(int ind) Get minimum ruler value.
int	getRulerMode(int ind)
java.lang.String	getRulerName(int ind)
int	getRulerNumMajorHashings(int ind) Get number of major hashings, used in PgRuler.HASH_PARTITIONED mode..
int	getRulerNumMinorHashings(int ind) Get number of minor hashings, used in PgRuler.HASH_PARTITIONED mode..
double	getRulerSize(int ind) Get polygon size of axis with given index.
java.lang.String[]	getSearchPaths() Get image search paths.
int	getSelectedLight()
java.lang.String	getTitle()
int	getTransformMode() Get transformation of display, i.e. if scene, model or ambient transformation is active.
java.lang.String	getVersion()
java.lang.String	getVersionType()
java.awt.Point	getWindowPosition() Get upper left corner of frame containing the display.
java.awt.Dimension	getWindowSize() Get size of display within its frame.
boolean	isEnabledCameraClip(int ind)
boolean	isEnabledCameraSceneRatio(int ind)
boolean	isLightHighlight(int ind)
boolean	isLightSwitchedOn(int ind)
boolean	isLightVisible(int ind)
boolean	isShowingRuler(int ind)
boolean	isShowingRulerArrow(int ind) Check if arrow at positive end of ruler is shown.
boolean	isShowingRulerHashingsNormal(int ind)
boolean	isShowingRulerHashingsUp(int ind)
boolean	isShowingRulerName(int ind) Check if name of ruler is shown at positive end of ruler.
boolean	isShowingRulerNumbers(int ind)
boolean	isShowingRulerTicksMajor(int ind)
boolean	isShowingRulerTicksMinor(int ind)
void	setAbstract(java.lang.String abstr)
void	setAmbientLight(java.awt.Color ambient)
void	setArrayPosition(int pos) Set position of display within an array of displays.
void	setArraySize(java.awt.Dimension dim) Set dimensionof array of displays.
void	setAuthorInfo(PsAuthorInfo authors)
void	setAxes(PgAxes axes)
void	setAxesCoordSystem(int coordSystem) Set coordinate system in which axes are shown.
void	setAxesEdge(PiVector edges) Currently unused except in PgMathLoader.
void	setAxesHash(boolean[] flag)
void	setAxesLabel(java.lang.String[] labels)
void	setAxesType(int type) Set type of coordinate axes, see PgAxes.AXES_xxx.
void	setBackgroundColor(java.awt.Color color) Set color of background of display.
void	setBackgroundImage(java.awt.Image image) Set background image of display canvas.
void	setBackgroundImageFile(java.lang.String fileName) Set filename of background image of display canvas.
void	setBackgroundImageFit(int repeat) Set the mode determining how a background image is scaled w.r.t. the display canvas.
void	setBndBoxColor(java.awt.Color col) Set color of bounding box.
void	setBndBoxSize(double size) Set thickness of edges of bounding box.
void	setBoxRatio(PdVector ratio) Set scaling factors of edges of the bounding box.
void	setCameraAngle(int ind, double angle) deprecated use setCameraFieldOfView(int, double)
void	setCameraFarClip(int ind, double dist)
void	setCameraFieldOfView(int ind, double angle) Set opening angle of camera in degrees in [0,180].
void	setCameraInterest(int ind, PdVector interest)
void	setCameraMatrix(int ind, PdMatrix trans) Set the 4*4 camera transformation matrix.
void	setCameraName(int ind, java.lang.String name)
void	setCameraNearClip(int ind, double dist)
void	setCameraPosition(int ind, PdVector position)
void	setCameraProjection(int ind, int projection)
void	setCameraRoll(int ind, double roll)
void	setClipBounds(int ind, double[] range) Set minimum and maximum in one dimension of the clipping box.
void	setClipBoundsType(int type) Set index of axis which is selected when scene clip bounds is active of becomes active.
void	setCurrentCamera(int type)
void	setEnabledCameraClip(int ind, boolean v)
void	setEnabledCameraSceneRatio(int ind, boolean v)
void	setForegroundColor(java.awt.Color color) Set foreground color.
void	setForegroundImage(java.awt.Image image) Set foreground image of display canvas.
void	setForegroundImageFile(java.lang.String fileName) Set foreground image of display canvas.
void	setForegroundImageFit(int repeat) Set the mode determining how a background image is scaled w.r.t. the display canvas.
void	setLightAngle(int ind, double angle)
void	setLightColor(int ind, java.awt.Color color)
void	setLightCorona(int ind, double corona)
void	setLightExponent(int ind, double exp)
void	setLightFalloff(int ind, double falloff)
void	setLightHighlight(int ind, boolean flag)
void	setLightingModel(int ind)
void	setLightingModelAsString(java.lang.String model)
void	setLightIntensity(int ind, double intensity)
void	setLightInterest(int ind, PdVector direction)
void	setLightName(int ind, java.lang.String name)
void	setLightPosition(int ind, PdVector position)
void	setLightReference(int ind, int reference)
void	setLightShading(int ind, int shading)
void	setLightSwitchedOn(int ind, boolean flag)
void	setLightType(int ind, int type)
void	setLightVisible(int ind, boolean flag)
void	setMajorMode(int mode) Set major transformation mode of display used with left-mouse.
void	setNumCameras(int num)
void	setNumLights(int num) Allocate given number of lights.
void	setNumRulers(int num)
void	setOption(int flag, boolean val) Set all bits which are set in parameter.
void	setOptions(PvDisplayIf disp) Initialize this option class with data extracted from the given display.
void	setRulerColor(int ind, java.awt.Color col) Set polygon color of axis with given index.
void	setRulerMajorHashUnit(int ind, double size) Set distance between two adjacent major hashings, used in PgRuler.HASH_FIXED mode.
void	setRulerMaxValue(int ind, double size) Set maximum ruler value.
void	setRulerMinorHashUnit(int ind, double size) Set distance between two adjacent minor hashings, used in PgRuler.HASH_FIXED mode.
void	setRulerMinValue(int ind, double size) Set minimum ruler value.
void	setRulerMode(int ind, int mode)
void	setRulerName(int ind, java.lang.String name)
void	setRulerNumMajorHashings(int ind, int num) Set number of major hashings, used in PgRuler.HASH_PARTITIONED mode..
void	setRulerNumMinorHashings(int ind, int num) Set number of minor hashings, used in PgRuler.HASH_PARTITIONED mode..
void	setRulerSize(int ind, double size) Set polygon size of axis with given index.
void	setSearchPaths(java.lang.String[] searchPath) Set image search paths.
void	setSelectedLight(int ind)
void	setTitle(java.lang.String title)
void	setTransformMode(int mode) Set transformation of display, i.e. if scene, model or ambient transformation is active.
void	setVersion(java.lang.String version)
void	setVersionType(java.lang.String versionType)
void	setWindowPosition(int x, int y) deprecated use setWindowPosition(Point)
void	setWindowPosition(java.awt.Point pos) Set upper left corner of frame containing the display.
void	setWindowSize(java.awt.Dimension dim) Set size of display within its frame.
void	setWindowSize(int x, int y) deprecated use setWindowSize(Dimension)
void	showRuler(int ind, boolean flag)
void	showRulerArrow(int ind, boolean flag) Determine if arrow at positive end of ruler is shown.
void	showRulerHashingsNormal(int ind, boolean flag)
void	showRulerHashingsUp(int ind, boolean flag)
void	showRulerName(int ind, boolean flag) Determine if name of ruler is shown at positive end of ruler.
void	showRulerNumbers(int ind, boolean flag)
void	showRulerTicksMajor(int ind, boolean flag)
void	showRulerTicksMinor(int ind, boolean flag)

Methods inherited from class jv.vecmath.P_Vector

clearTag, clone, clone, copy, getBits, getDetail, getName, getURL, hasTag, invert, setDetail, setName, setTag, setURL, toString

Methods inherited from class java.lang.Object

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

Field Detail

SHOW_ANTIALIAS

public static final int SHOW_ANTIALIAS

Enable antialiasing of display. Currently not supported.

See Also:

Constant Field Values

SHOW_AUTOCENTER

public static final int SHOW_AUTOCENTER

Enable auto rotation in display.

See Also:

Constant Field Values

SHOW_AUTOFIT

public static final int SHOW_AUTOFIT

Enable auto rotation in display.

See Also:

Constant Field Values

SHOW_AUTOROTATE

public static final int SHOW_AUTOROTATE

Enable auto rotation in display.

See Also:

Constant Field Values

SHOW_AXES

public static final int SHOW_AXES

Enable drawing of a coordinate axes around scene in the display.

See Also:

Constant Field Values

SHOW_AXES_AUTO_BOUNDS

public static final int SHOW_AXES_AUTO_BOUNDS

Flag specifies whether axes is in auto-bounds mode.

See Also:

Constant Field Values

SHOW_AXES_AUTO_CONFIGURE

public static final int SHOW_AXES_AUTO_CONFIGURE

Deprecated. since JavaView 3.62.001, use SHOW_AXES_AUTO_HASHING.

Flag specifies whether axes is in auto-configure mode.

See Also:

Constant Field Values

SHOW_AXES_AUTO_HASHING

public static final int SHOW_AXES_AUTO_HASHING

Flag specifies whether axes is in auto-hashing mode.

See Also:

Constant Field Values

SHOW_AXES_AUTO_LAYOUT

public static final int SHOW_AXES_AUTO_LAYOUT

Flag specifies whether axes is in auto-layout mode.

See Also:

Constant Field Values

SHOW_AXES_NAME

public static final int SHOW_AXES_NAME

Enable drawing of name of coordinate axes.

See Also:

Constant Field Values

SHOW_AXES_NUMBERS

public static final int SHOW_AXES_NUMBERS

Enable drawing of numbers of coordinate axes.

See Also:

Constant Field Values

SHOW_AXES_LABEL

public static final int SHOW_AXES_LABEL

Deprecated. used SHOW_AXES_NUMBERS

Enable drawing of numbers of coordinate axes.

See Also:

Constant Field Values

SHOW_AXES_TITLE

public static final int SHOW_AXES_TITLE

Deprecated. use SHOW_AXES_NAME

Enable drawing of title respectively name of coordinate axes.

See Also:

Constant Field Values

SHOW_BACKGROUND_IMAGE

public static final int SHOW_BACKGROUND_IMAGE

Enable drawing of image in the background. If disabled background color is used.

See Also:

Constant Field Values

SHOW_BORDER

public static final int SHOW_BORDER

Enable drawing of sunk border around display canvas.

See Also:

Constant Field Values

SHOW_BOUNDING_BOX

public static final int SHOW_BOUNDING_BOX

Enable drawing of bounding box around scene.

See Also:

Constant Field Values

SHOW_CENTER

public static final int SHOW_CENTER

Enable drawing of center of geometries.

See Also:

Constant Field Values

SHOW_CROSS

public static final int SHOW_CROSS

Enable drawing of cross at current cursor position.

See Also:

Constant Field Values

SHOW_DEPTHCUE

public static final int SHOW_DEPTHCUE

Enable drawing of sunk border around display canvas.

See Also:

Constant Field Values

SHOW_DOUBLEBUFFER

public static final int SHOW_DOUBLEBUFFER

Enable drawing of a double buffered image in display canvas, default enabled.

See Also:

Constant Field Values

SHOW_DRAWING

public static final int SHOW_DRAWING

Enable drawing in display canvas, default enabled.

See Also:

Constant Field Values

SHOW_EDGE_AURA

public static final int SHOW_EDGE_AURA

Enable drawing of aura in background color around each edge.

See Also:

Constant Field Values

SHOW_FOREGROUND_IMAGE

public static final int SHOW_FOREGROUND_IMAGE

Enable drawing of image in the foreground. If disabled foreground color is used.

See Also:

Constant Field Values

SHOW_FRAME

public static final int SHOW_FRAME

Enable drawing of a small coordinate frame in the lower left corner of the display.

See Also:

Constant Field Values

SHOW_INFO

public static final int SHOW_INFO

Enable drawing of additional information close to cursor in overlay window.

See Also:

Constant Field Values

SHOW_LIGHTING

public static final int SHOW_LIGHTING

Enable drawing of sunk border around display canvas.

See Also:

Constant Field Values

SHOW_MAGNET

public static final int SHOW_MAGNET

Attach cursor to vertices of nearby.

See Also:

Constant Field Values

SHOW_SINGLE

public static final int SHOW_SINGLE

Restrict drawing to a single geometry at the same time. Unsetting the flag allows multiple geometries to be visible at the same time, which is the default.

This flag only determines the number of visible geometries. Independent of this flag there may only be a single geometry active.

See Also:

Constant Field Values

SHOW_SORTING

public static final int SHOW_SORTING

Enable sorting of geometry items according to Painter's algorithm.

See Also:

Constant Field Values

SHOW_VISIBLE

public static final int SHOW_VISIBLE

Enable visibility of display.

See Also:

Constant Field Values

SHOW_XY_GRID

public static final int SHOW_XY_GRID

Enable drawing of coordinate grid in xy plane.

See Also:

Constant Field Values

SHOW_XZ_GRID

public static final int SHOW_XZ_GRID

Enable drawing of coordinate grid in xz plane.

See Also:

Constant Field Values

SHOW_YZ_GRID

public static final int SHOW_YZ_GRID

Enable drawing of coordinate grid in yz plane.

See Also:

Constant Field Values

SHOW_ZBUFFER

public static final int SHOW_ZBUFFER

Enable drawing in z-buffer mode.

See Also:

Constant Field Values

SHOW_LOCAL_TRANSFORM

public static final int SHOW_LOCAL_TRANSFORM

Use local coordinate system of geometry to calculate transformations.

See Also:

Constant Field Values

SHOW_DIRECT_SELECT

public static final int SHOW_DIRECT_SELECT

Enable selection of geometries by simple pick with mouse.

See Also:

Constant Field Values

SHOW_TITLE

public static final int SHOW_TITLE

Enable showing of title of display north in the display.

See Also:

Constant Field Values

SHOW_COPYRIGHT

public static final int SHOW_COPYRIGHT

Enable drawing of copyright information.

See Also:

Constant Field Values

SHOW_BOX_RATIO

public static final int SHOW_BOX_RATIO

Enable usage of different scaling of axis.

See Also:

Constant Field Values

SHOW_FILL_DISPLAY

public static final int SHOW_FILL_DISPLAY

Determines if filling of display is enabled.

See Also:

Constant Field Values

SHOW_CLIP_BOUNDS

public static final int SHOW_CLIP_BOUNDS

Enable clipping of coordinate axes.

See Also:

Constant Field Values

SHOW_CLIP_AUTO_BOUNDS

public static final int SHOW_CLIP_AUTO_BOUNDS

Flag specifies whether clipRange is in auto-bounds mode.

See Also:

Constant Field Values

SHOW_3DLOOK

public static final int SHOW_3DLOOK

Enable 3D look of lines and points.

See Also:

Constant Field Values

SHOW_ADAPTIVE_SIZE

public static final int SHOW_ADAPTIVE_SIZE

Enable adaptive size of lines and points.

See Also:

Constant Field Values

SHOW_INTEGER_PICK

public static final int SHOW_INTEGER_PICK

Enable picking constraint to an integer grid.

See Also:

Constant Field Values

SHOW_EDGES_ONCE

public static final int SHOW_EDGES_ONCE

Enable reduction of number of edge drawings, each face edge is drawn only once.

See Also:

Constant Field Values

SHOW_CLEAR_SCREEN

public static final int SHOW_CLEAR_SCREEN

Enable reduction of number of edge drawings, each face edge is drawn only once.

See Also:

Constant Field Values

Constructor Detail

PvDisplayOption

public PvDisplayOption()

Constructor sets all values to defaults.

Method Detail

getOption

public boolean getOption(int flag)

Check whether either of the bits in parameter has been set.

See Also:

setOption(int, boolean)

setOption

public void setOption(int flag,
                      boolean val)

Set all bits which are set in parameter. See jv.project.PvDisplayIf for a list of possible flags.

See Also:

getOption(int), PvDisplayIf

getVersion

public java.lang.String getVersion()

getVersionType

public java.lang.String getVersionType()

getTitle

public java.lang.String getTitle()

getAbstract

public java.lang.String getAbstract()

getAuthorInfo

public PsAuthorInfo getAuthorInfo()

setVersion

public void setVersion(java.lang.String version)

setVersionType

public void setVersionType(java.lang.String versionType)

setTitle

public void setTitle(java.lang.String title)

setAbstract

public void setAbstract(java.lang.String abstr)

setAuthorInfo

public void setAuthorInfo(PsAuthorInfo authors)

getMajorMode

public int getMajorMode()

Get major transformation mode of display used with left-mouse.

setMajorMode

public void setMajorMode(int mode)

Set major transformation mode of display used with left-mouse.

See Also:

PvDisplayIf.MODE_ORBIT, PvDisplayIf.MODE_SCALE

getTransformMode

public int getTransformMode()

Get transformation of display, i.e. if scene, model or ambient transformation is active.

setTransformMode

public void setTransformMode(int mode)

Set transformation of display, i.e. if scene, model or ambient transformation is active.

See Also:

PvDisplayIf.TRANSFORM_CAMERA, PvDisplayIf.TRANSFORM_MODEL, PvDisplayIf.TRANSFORM_AMBIENT

getDimAxes

public int getDimAxes()

getAxes

public PgAxes getAxes()

setAxes

public void setAxes(PgAxes axes)

getAxesHash

public boolean[] getAxesHash()

setAxesHash

public void setAxesHash(boolean[] flag)

getAxesLabel

public java.lang.String[] getAxesLabel()

setAxesLabel

public void setAxesLabel(java.lang.String[] labels)

getAxesType

public int getAxesType()

Get type of coordinate axes, see PgAxes.AXES_xxx.

setAxesType

public void setAxesType(int type)

Set type of coordinate axes, see PgAxes.AXES_xxx.

getAxesEdge

public PiVector getAxesEdge()

Currently unused except in PgMathLoader.

setAxesEdge

public void setAxesEdge(PiVector edges)

Currently unused except in PgMathLoader.

getAxesCoordSystem

public int getAxesCoordSystem()

Get coordinate system in which axes are shown.

setAxesCoordSystem

public void setAxesCoordSystem(int coordSystem)

Set coordinate system in which axes are shown.

getNumRulers

public int getNumRulers()

setNumRulers

public void setNumRulers(int num)

getRulerMode

public int getRulerMode(int ind)

setRulerMode

public void setRulerMode(int ind,
                         int mode)

getRulerName

public java.lang.String getRulerName(int ind)

setRulerName

public void setRulerName(int ind,
                         java.lang.String name)

isShowingRulerName

public boolean isShowingRulerName(int ind)

Check if name of ruler is shown at positive end of ruler.

showRulerName

public void showRulerName(int ind,
                          boolean flag)

Determine if name of ruler is shown at positive end of ruler.

isShowingRulerArrow

public boolean isShowingRulerArrow(int ind)

Check if arrow at positive end of ruler is shown.

showRulerArrow

public void showRulerArrow(int ind,
                           boolean flag)

Determine if arrow at positive end of ruler is shown.

isShowingRulerNumbers

public boolean isShowingRulerNumbers(int ind)

showRulerNumbers

public void showRulerNumbers(int ind,
                             boolean flag)

isShowingRulerHashingsNormal

public boolean isShowingRulerHashingsNormal(int ind)

showRulerHashingsNormal

public void showRulerHashingsNormal(int ind,
                                    boolean flag)

isShowingRulerHashingsUp

public boolean isShowingRulerHashingsUp(int ind)

showRulerHashingsUp

public void showRulerHashingsUp(int ind,
                                boolean flag)

isShowingRulerTicksMajor

public boolean isShowingRulerTicksMajor(int ind)

showRulerTicksMajor

public void showRulerTicksMajor(int ind,
                                boolean flag)

isShowingRulerTicksMinor

public boolean isShowingRulerTicksMinor(int ind)

showRulerTicksMinor

public void showRulerTicksMinor(int ind,
                                boolean flag)

isShowingRuler

public boolean isShowingRuler(int ind)

showRuler

public void showRuler(int ind,
                      boolean flag)

getRulerColor

public java.awt.Color getRulerColor(int ind)

Get polygon color of axis with given index.

setRulerColor

public void setRulerColor(int ind,
                          java.awt.Color col)

Set polygon color of axis with given index.

getRulerSize

public double getRulerSize(int ind)

Get polygon size of axis with given index.

setRulerSize

public void setRulerSize(int ind,
                         double size)

Set polygon size of axis with given index.

getRulerMinValue

public double getRulerMinValue(int ind)

Get minimum ruler value.

setRulerMinValue

public void setRulerMinValue(int ind,
                             double size)

Set minimum ruler value.

getRulerMaxValue

public double getRulerMaxValue(int ind)

Get maximum ruler value.

setRulerMaxValue

public void setRulerMaxValue(int ind,
                             double size)

Set maximum ruler value.

getRulerMinorHashUnit

public double getRulerMinorHashUnit(int ind)

Get distance between two adjacent minor hashings, used in PgRuler.HASH_FIXED mode.

setRulerMinorHashUnit

public void setRulerMinorHashUnit(int ind,
                                  double size)

Set distance between two adjacent minor hashings, used in PgRuler.HASH_FIXED mode.

getRulerMajorHashUnit

public double getRulerMajorHashUnit(int ind)

Get distance between two adjacent major hashings, used in PgRuler.HASH_FIXED mode.

setRulerMajorHashUnit

public void setRulerMajorHashUnit(int ind,
                                  double size)

Set distance between two adjacent major hashings, used in PgRuler.HASH_FIXED mode.

getRulerNumMinorHashings

public int getRulerNumMinorHashings(int ind)

Get number of minor hashings, used in PgRuler.HASH_PARTITIONED mode..

setRulerNumMinorHashings

public void setRulerNumMinorHashings(int ind,
                                     int num)

Set number of minor hashings, used in PgRuler.HASH_PARTITIONED mode..

getRulerNumMajorHashings

public int getRulerNumMajorHashings(int ind)

Get number of major hashings, used in PgRuler.HASH_PARTITIONED mode..

setRulerNumMajorHashings

public void setRulerNumMajorHashings(int ind,
                                     int num)

Set number of major hashings, used in PgRuler.HASH_PARTITIONED mode..

getClipBoundsType

public int getClipBoundsType()

Get index of axis which is selected when scene clip bounds is active or becomes active.

Since:

JavaView 2.99.012

setClipBoundsType

public void setClipBoundsType(int type)

Set index of axis which is selected when scene clip bounds is active of becomes active.

Since:

JavaView 2.99.012

getClipBounds

public double[] getClipBounds(int ind)

Get minimum and maximum in one dimension of the clipping box.

Parameters:

ind - index of ruler of axes in which direction is clipped

Returns:

range minimum and maximum of visible range in axis direction

Since:

JavaView 2.49.005

setClipBounds

public void setClipBounds(int ind,
                          double[] range)

Set minimum and maximum in one dimension of the clipping box. If clipBound vectors are allocated then they are initialized with Double.NEGATIVE_INFINITY and Double.MAX_VALUE respectively.

Parameters:

ind - index of ruler of axes in which direction is clipped

range - minimum and maximum of visible range in axis direction

Since:

JavaView 2.49.005

getCurrentCamera

public int getCurrentCamera()

setCurrentCamera

public void setCurrentCamera(int type)

getCameraName

public java.lang.String getCameraName(int ind)

setCameraName

public void setCameraName(int ind,
                          java.lang.String name)

getCameraProjection

public int getCameraProjection(int ind)

setCameraProjection

public void setCameraProjection(int ind,
                                int projection)

getCameraMatrix

public PdMatrix getCameraMatrix(int ind)

Get the 4*4 camera transformation matrix. This is a convenient method to get several camera parameters at once.

Parameters:

ind - index of camera

Returns:

PdMatrix transformation matrix of this camera

setCameraMatrix

public void setCameraMatrix(int ind,
                            PdMatrix trans)

Set the 4*4 camera transformation matrix. This is a convenient method to set several camera parameters at once.

Parameters:

ind - index of camera

trans - transformation matrix of this camera

getCameraPosition

public PdVector getCameraPosition(int ind)

setCameraPosition

public void setCameraPosition(int ind,
                              PdVector position)

getCameraInterest

public PdVector getCameraInterest(int ind)

setCameraInterest

public void setCameraInterest(int ind,
                              PdVector interest)

getCameraFieldOfView

public double getCameraFieldOfView(int ind)

Get opening angle of camera in degrees in [0,180].

Parameters:

ind - index of camera

Returns:

opening angle of camera in degrees in [0,180]

setCameraFieldOfView

public void setCameraFieldOfView(int ind,
                                 double angle)

Set opening angle of camera in degrees in [0,180].

Parameters:

ind - index of camera

angle - angle of camera in degrees in [0,180]

getCameraAngle

public double getCameraAngle(int ind)

deprecated use getCameraFieldOfView(int)

setCameraAngle

public void setCameraAngle(int ind,
                           double angle)

deprecated use setCameraFieldOfView(int, double)

getCameraRoll

public double getCameraRoll(int ind)

setCameraRoll

public void setCameraRoll(int ind,
                          double roll)

isEnabledCameraClip

public boolean isEnabledCameraClip(int ind)

setEnabledCameraClip

public void setEnabledCameraClip(int ind,
                                 boolean v)

getCameraNearClip

public double getCameraNearClip(int ind)

setCameraNearClip

public void setCameraNearClip(int ind,
                              double dist)

getCameraFarClip

public double getCameraFarClip(int ind)

setCameraFarClip

public void setCameraFarClip(int ind,
                             double dist)

isEnabledCameraSceneRatio

public boolean isEnabledCameraSceneRatio(int ind)

setEnabledCameraSceneRatio

public void setEnabledCameraSceneRatio(int ind,
                                       boolean v)

getNumCameras

public int getNumCameras()

setNumCameras

public void setNumCameras(int num)

getLightingModel

public int getLightingModel()

setLightingModel

public void setLightingModel(int ind)

getLightingModelAsString

public java.lang.String getLightingModelAsString()

setLightingModelAsString

public void setLightingModelAsString(java.lang.String model)

getSelectedLight

public int getSelectedLight()

setSelectedLight

public void setSelectedLight(int ind)

getAmbientLight

public java.awt.Color getAmbientLight()

setAmbientLight

public void setAmbientLight(java.awt.Color ambient)

getLightName

public java.lang.String getLightName(int ind)

setLightName

public void setLightName(int ind,
                         java.lang.String name)

getLightReference

public int getLightReference(int ind)

setLightReference

public void setLightReference(int ind,
                              int reference)

getLightType

public int getLightType(int ind)

setLightType

public void setLightType(int ind,
                         int type)

getLightPosition

public PdVector getLightPosition(int ind)

setLightPosition

public void setLightPosition(int ind,
                             PdVector position)

getLightInterest

public PdVector getLightInterest(int ind)

setLightInterest

public void setLightInterest(int ind,
                             PdVector direction)

getLightColor

public java.awt.Color getLightColor(int ind)

setLightColor

public void setLightColor(int ind,
                          java.awt.Color color)

isLightSwitchedOn

public boolean isLightSwitchedOn(int ind)

setLightSwitchedOn

public void setLightSwitchedOn(int ind,
                               boolean flag)

getLightShading

public int getLightShading(int ind)

setLightShading

public void setLightShading(int ind,
                            int shading)

isLightVisible

public boolean isLightVisible(int ind)

setLightVisible

public void setLightVisible(int ind,
                            boolean flag)

getLightIntensity

public double getLightIntensity(int ind)

setLightIntensity

public void setLightIntensity(int ind,
                              double intensity)

isLightHighlight

public boolean isLightHighlight(int ind)

setLightHighlight

public void setLightHighlight(int ind,
                              boolean flag)

getLightAngle

public double getLightAngle(int ind)

setLightAngle

public void setLightAngle(int ind,
                          double angle)

getLightCorona

public double getLightCorona(int ind)

setLightCorona

public void setLightCorona(int ind,
                           double corona)

getLightExponent

public double getLightExponent(int ind)

setLightExponent

public void setLightExponent(int ind,
                             double exp)

getLightFalloff

public double getLightFalloff(int ind)

setLightFalloff

public void setLightFalloff(int ind,
                            double falloff)

getNumLights

public int getNumLights()

Get number of available lights.

setNumLights

public void setNumLights(int num)

Allocate given number of lights. If new number is different from existing number of lights, then the existing lights are reused as long as it makes sense.

Parameters:

num - total number of lights

getBackgroundColor

public java.awt.Color getBackgroundColor()

Get color of background of display. If background image is set, then color is visible in transparent regions of the image.

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

Set color of background of display. If background image is set, then color is visible in transparent regions of the image.

getBackgroundImageFit

public int getBackgroundImageFit()

Get the mode determining how a background image is scaled w.r.t. the display canvas.

Since:

JavaView 2.36

setBackgroundImageFit

public void setBackgroundImageFit(int repeat)

Set the mode determining how a background image is scaled w.r.t. the display canvas.

Since:

JavaView 2.36

getBackgroundImage

public java.awt.Image getBackgroundImage()

Get background image of display canvas.

setBackgroundImage

public void setBackgroundImage(java.awt.Image image)

Set background image of display canvas.

getBackgroundImageFile

public java.lang.String getBackgroundImageFile()

Get background image filename of display canvas.

Returns:

file name of background image

Since:

JavaView 2.31

setBackgroundImageFile

public void setBackgroundImageFile(java.lang.String fileName)

Set filename of background image of display canvas. Method tries to load file immediately.

Parameters:

fileName - relative file name of image.

Since:

JavaView 2.31

getSearchPaths

public java.lang.String[] getSearchPaths()

Get image search paths.

Returns:

array of search paths

Since:

JavaView 3.61.003

setSearchPaths

public void setSearchPaths(java.lang.String[] searchPath)

Set image search paths.

Parameters:

searchPath - array of search paths

Since:

JavaView 3.61.003

getForegroundColor

public java.awt.Color getForegroundColor()

Get foreground color. Currently neither defined nor used.

setForegroundColor

public void setForegroundColor(java.awt.Color color)

Set foreground color. Currently neither defined nor used.

getForegroundImageFit

public int getForegroundImageFit()

Get the mode determining how a foreground image is scaled w.r.t. the display canvas.

Since:

JavaView 2.36

setForegroundImageFit

public void setForegroundImageFit(int repeat)

Set the mode determining how a background image is scaled w.r.t. the display canvas.

Since:

JavaView 2.36

getForegroundImage

public java.awt.Image getForegroundImage()

Get foreground image of display canvas.

Since:

JavaView 2.31

setForegroundImage

public void setForegroundImage(java.awt.Image image)

Set foreground image of display canvas.

Since:

JavaView 2.31

getForegroundImageFile

public java.lang.String getForegroundImageFile()

Get foreground image filename of display canvas.

Returns:

file name of foreground image

Since:

JavaView 2.31

setForegroundImageFile

public void setForegroundImageFile(java.lang.String fileName)

Set foreground image of display canvas.

Parameters:

fileName - relative file name of image.

Since:

JavaView 2.31

getBndBoxColor

public java.awt.Color getBndBoxColor()

Get color of bounding box.

Returns:

color of bounding box

Since:

JavaView 2.49.005

setBndBoxColor

public void setBndBoxColor(java.awt.Color col)

Set color of bounding box.

Parameters:

col - color of bounding box

Since:

JavaView 2.49.005

getBndBoxSize

public double getBndBoxSize()

Get thickness of edges of bounding box.

Returns:

thickness of edges bounding box

Since:

JavaView 2.49.005

setBndBoxSize

public void setBndBoxSize(double size)

Set thickness of edges of bounding box.

Parameters:

size - thickness of edges bounding box

Since:

JavaView 2.49.005

getBoxRatio

public PdVector getBoxRatio()

Get scaling factors of edges of the bounding box.

Returns:

scaling factors of edges bounding box

Since:

JavaView 2.60.002

setBoxRatio

public void setBoxRatio(PdVector ratio)

Set scaling factors of edges of the bounding box.

Parameters:

ratio - scaling factors of edges bounding box

Since:

JavaView 2.60.002

getWindowPosition

public java.awt.Point getWindowPosition()

Get upper left corner of frame containing the display. If the position is null then positioning of frame is not done during configuration of display.

See Also:

configure(PvDisplayIf)

setWindowPosition

public void setWindowPosition(java.awt.Point pos)

Set upper left corner of frame containing the display. If the position is null then positioning of frame is not done during configuration of display.

See Also:

configure(PvDisplayIf)

setWindowPosition

public void setWindowPosition(int x,
                              int y)

deprecated use setWindowPosition(Point)

getWindowSize

public java.awt.Dimension getWindowSize()

Get size of display within its frame. If the dimension is null then resizing of the frame is not done during configuration of display.

See Also:

configure(PvDisplayIf)

setWindowSize

public void setWindowSize(java.awt.Dimension dim)

Set size of display within its frame. If the dimension is null then resizing of the frame is not done during configuration of display.

See Also:

configure(PvDisplayIf)

setWindowSize

public void setWindowSize(int x,
                          int y)

deprecated use setWindowSize(Dimension)

setArrayPosition

public void setArrayPosition(int pos)

Set position of display within an array of displays. The position is an integer running through all rows of the array.

getArrayPosition

public int getArrayPosition()

Get position of display within an array of displays. The position is an integer running through all rows of the array.

setArraySize

public void setArraySize(java.awt.Dimension dim)

Set dimensionof array of displays.

getArraySize

public java.awt.Dimension getArraySize()

Get dimensionof array of displays.

configure

public void configure(PvDisplayIf disp)

Configure the given display with data from this option class. This method does not repaint or update the display.

setOptions

public void setOptions(PvDisplayIf disp)

Initialize this option class with data extracted from the given display.