org.opensourcephysics.display3d.simple3d
Class VisualizationHints

java.lang.Object
  org.opensourcephysics.display3d.simple3d.VisualizationHints

All Implemented Interfaces:

VisualizationHints

public class VisualizationHints
extends java.lang.Object
implements VisualizationHints

Nested Class Summary

protected static class

VisualizationHints.VisualizationHintsLoader

Nested classes/interfaces inherited from interface org.opensourcephysics.display3d.core.VisualizationHints

VisualizationHints.Loader

Field Summary

Fields inherited from interface org.opensourcephysics.display3d.core.VisualizationHints

CURSOR_CROSSHAIR, CURSOR_CUBE, CURSOR_NONE, CURSOR_XYZ, DECORATION_AXES, DECORATION_CUBE, DECORATION_NONE

Method Summary

void	copyFrom(VisualizationHints hints) Copies its data from another set of hints
java.lang.String[]	getAxesLabels()
int	getCursorType()
int	getDecorationType()
static XML.ObjectLoader	getLoader()
int	getShowCoordinates()
java.lang.String	getXFormat()
java.lang.String	getYFormat()
java.lang.String	getZFormat()
boolean	isAllowQuickRedraw()
boolean	isRemoveHiddenLines()
boolean	isUseColorDepth()
void	setAllowQuickRedraw(boolean _value) Whether the panel can draw quickly when it is dragged for a new view point
void	setAxesLabels(java.lang.String[] labels) Sets the labels for the X, Y, and Z axes (when the axes are visible).
void	setCursorType(int _type) The cursor type when interacting with the panel.
void	setDecorationType(int _value) Types of decoration displayed.
void	setRemoveHiddenLines(boolean _value) Whether the panel should try to remove hidden lines
void	setShowCoordinates(int location) At which location should the panel display the coordinates when dragging a point The location must be one of the following: DrawingPanel3D.BOTTOM_LEFT DrawingPanel3D.BOTTOM_RIGHT DrawingPanel3D.TOP_RIGHT DrawingPanel3D.TOP_LEFT A negative value for the location means
void	setUseColorDepth(boolean _value) Whether the panel should display far objects darker
void	setXFormat(java.lang.String format) Sets the format to display the X coordinate when dragging a point
void	setYFormat(java.lang.String format) Sets the format to display the Y coordinate when dragging a point
void	setZFormat(java.lang.String format) Sets the format to display the Z coordinate when dragging a point

Methods inherited from class java.lang.Object

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

Method Detail

setCursorType

public void setCursorType(int _type)

Description copied from interface: VisualizationHints

The cursor type when interacting with the panel. One of the following

• CURSOR_NONE: No cursor lines are shown.
• CURSOR_XYZ: X,Y, and Z lines are displayed. The default.
• CURSOR_CUBE: A cube from the origing to the point is shown.
• CURSOR_CROSSHAIR: Lines parallel to the axes that cross at the given point are shown.

Specified by:

setCursorType in interface VisualizationHints

getCursorType

public final int getCursorType()

Specified by:

getCursorType in interface VisualizationHints

setDecorationType

public void setDecorationType(int _value)

Description copied from interface: VisualizationHints

Types of decoration displayed. One of the following

• DECORATION_NONE: No decoration
• DECORATION_AXES: Display labelled axes
• DECORATION_CUBE: Display the bounding box

Specified by:

setDecorationType in interface VisualizationHints

Parameters:

_value - the desired value

getDecorationType

public final int getDecorationType()

Specified by:

getDecorationType in interface VisualizationHints

setAxesLabels

public final void setAxesLabels(java.lang.String[] labels)

Description copied from interface: VisualizationHints

Sets the labels for the X, Y, and Z axes (when the axes are visible).

Specified by:

setAxesLabels in interface VisualizationHints

Parameters:

labels - a String[] array with at least three elements

getAxesLabels

public final java.lang.String[] getAxesLabels()

Specified by:

getAxesLabels in interface VisualizationHints

setRemoveHiddenLines

public void setRemoveHiddenLines(boolean _value)

Description copied from interface: VisualizationHints

Whether the panel should try to remove hidden lines

Specified by:

setRemoveHiddenLines in interface VisualizationHints

Parameters:

_value - the desired value

isRemoveHiddenLines

public final boolean isRemoveHiddenLines()

Specified by:

isRemoveHiddenLines in interface VisualizationHints

setAllowQuickRedraw

public void setAllowQuickRedraw(boolean _value)

Description copied from interface: VisualizationHints

Whether the panel can draw quickly when it is dragged for a new view point

Specified by:

setAllowQuickRedraw in interface VisualizationHints

Parameters:

_value - the desired value

isAllowQuickRedraw

public final boolean isAllowQuickRedraw()

Specified by:

isAllowQuickRedraw in interface VisualizationHints

setUseColorDepth

public void setUseColorDepth(boolean _value)

Description copied from interface: VisualizationHints

Whether the panel should display far objects darker

Specified by:

setUseColorDepth in interface VisualizationHints

Parameters:

_value - the desired value

isUseColorDepth

public final boolean isUseColorDepth()

Specified by:

isUseColorDepth in interface VisualizationHints

setShowCoordinates

public void setShowCoordinates(int location)

Description copied from interface: VisualizationHints

At which location should the panel display the coordinates when dragging a point The location must be one of the following:

• DrawingPanel3D.BOTTOM_LEFT
• DrawingPanel3D.BOTTOM_RIGHT
• DrawingPanel3D.TOP_RIGHT
• DrawingPanel3D.TOP_LEFT

A negative value for the location means

Specified by:

setShowCoordinates in interface VisualizationHints

getShowCoordinates

public int getShowCoordinates()

Specified by:

getShowCoordinates in interface VisualizationHints

setXFormat

public void setXFormat(java.lang.String format)

Description copied from interface: VisualizationHints

Sets the format to display the X coordinate when dragging a point

Specified by:

setXFormat in interface VisualizationHints

Parameters:

format - String parameter for a new java.text.DecimalFormat

getXFormat

public java.lang.String getXFormat()

Specified by:

getXFormat in interface VisualizationHints

setYFormat

public void setYFormat(java.lang.String format)

Description copied from interface: VisualizationHints

Sets the format to display the Y coordinate when dragging a point

Specified by:

setYFormat in interface VisualizationHints

Parameters:

format - String parameter for a new java.text.DecimalFormat

getYFormat

public java.lang.String getYFormat()

Specified by:

getYFormat in interface VisualizationHints

setZFormat

public void setZFormat(java.lang.String format)

Description copied from interface: VisualizationHints

Sets the format to display the Z coordinate when dragging a point

Specified by:

setZFormat in interface VisualizationHints

Parameters:

format - String parameter for a new java.text.DecimalFormat

getZFormat

public java.lang.String getZFormat()

Specified by:

getZFormat in interface VisualizationHints

copyFrom

public void copyFrom(VisualizationHints hints)

Description copied from interface: VisualizationHints

Copies its data from another set of hints

Specified by:

copyFrom in interface VisualizationHints

getLoader

public static XML.ObjectLoader getLoader()