org.opensourcephysics.display3d.core
Interface VisualizationHints

All Known Implementing Classes:

VisualizationHints

public interface VisualizationHints

Title: VisualizationHints

Description: Hints to a DrawingPanel3D about how it should look. Hints can be ignored by the panel, depending on the implementation.

Nested Class Summary

static class

VisualizationHints.Loader

Field Summary

static int	CURSOR_CROSSHAIR
static int	CURSOR_CUBE
static int	CURSOR_NONE
static int	CURSOR_XYZ
static int	DECORATION_AXES
static int	DECORATION_CUBE
static int	DECORATION_NONE

Method Summary

int	getCursorType()
int	getDecorationType()
int	getShowCoordinates()
java.lang.String	getXFormat()
java.lang.String	getYFormat()
java.lang.String	getZFormat()
boolean	isAllowQuickRedraw()
boolean	isRemoveHiddenLines()
boolean	isUseColorDepth()
void	setAllowQuickRedraw(boolean allow) Whether the panel can draw quickly when it is dragged for a new view point
void	setCursorType(int type) The cursor type when interacting with the panel.
void	setDecorationType(int type) Types of decoration displayed.
void	setRemoveHiddenLines(boolean remove) 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 useIt) 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

Field Detail

DECORATION_NONE

public static final int DECORATION_NONE

See Also:

Constant Field Values

DECORATION_AXES

public static final int DECORATION_AXES

See Also:

Constant Field Values

DECORATION_CUBE

public static final int DECORATION_CUBE

See Also:

Constant Field Values

CURSOR_NONE

public static final int CURSOR_NONE

See Also:

Constant Field Values

CURSOR_XYZ

public static final int CURSOR_XYZ

See Also:

Constant Field Values

CURSOR_CUBE

public static final int CURSOR_CUBE

See Also:

Constant Field Values

CURSOR_CROSSHAIR

public static final int CURSOR_CROSSHAIR

See Also:

Constant Field Values

Method Detail

setDecorationType

public void setDecorationType(int type)

Types of decoration displayed. One of the following

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

Parameters:

type - the desired value

getDecorationType

public int getDecorationType()

setCursorType

public void setCursorType(int type)

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.

getCursorType

public int getCursorType()

setRemoveHiddenLines

public void setRemoveHiddenLines(boolean remove)

Whether the panel should try to remove hidden lines

Parameters:

remove - the desired value

isRemoveHiddenLines

public boolean isRemoveHiddenLines()

setAllowQuickRedraw

public void setAllowQuickRedraw(boolean allow)

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

Parameters:

allow - the desired value

isAllowQuickRedraw

public boolean isAllowQuickRedraw()

setUseColorDepth

public void setUseColorDepth(boolean useIt)

Whether the panel should display far objects darker

Parameters:

useIt - the desired value

isUseColorDepth

public boolean isUseColorDepth()

setShowCoordinates

public 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

getShowCoordinates

public int getShowCoordinates()

setXFormat

public void setXFormat(java.lang.String format)

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

Parameters:

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

getXFormat

public java.lang.String getXFormat()

setYFormat

public void setYFormat(java.lang.String format)

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

Parameters:

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

getYFormat

public java.lang.String getYFormat()

setZFormat

public void setZFormat(java.lang.String format)

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

Parameters:

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

getZFormat

public java.lang.String getZFormat()