net.sf.oriented.pseudoline

Class ImageOptions

java.lang.Object

net.sf.oriented.pseudoline.ImageOptions

public class ImageOptions
extends Object

Settings for drawing pseudoline diagrams. Many of the settings are public fields, this should just be set to the desired values. Some of the settings are hidden and should be set with the public methods. To construct a new settings object use either defaultColor() or defaultBlackAndWhite() and then modify. Most of the numeric fields will scale with the width and the height, and do not need to be independently modified.

Author:

jeremycarroll

Field Summary

Fields

Modifier and Type	Field and Description
Color	background The color of the background to the rectangle, outside the picture
double	border The width of the border in which line labels are shown.
Color	fill The color of the faces inside the picture
double	fontSizeRatio Any scaling that should be applied to the font size.
Color	foreground The foregound color that is used for text, vertices, and the origin.
int	height The width and height of the intended image.
int	labelBorder An additional border around labels.
double	labelPosition The position of the labels within the border.
float	lineWidth The width of lines in the diagram.
int	originArrowLength The length of the arrow used to show the origin.
int	originArrowSize The size of the arrowhead used to show the origin.
boolean	showOrigin Whether to show the origin or not.
boolean	showVertices Whether to high light vertices with a circle around them
int	vertexSize The size of the vertex circle if shown.
int	width The width and height of the intended image.

Method Summary

Methods

Modifier and Type	Method and Description
static ImageOptions	defaultBlackAndWhite() Get image options that generate a black and white image.
static ImageOptions	defaultColor() Get image options that generate a color image.
void	setColor(Label lbl, Color c) Provides the color for a line.
void	setColorOfInfinity(Color c) Provides the color for the line at infinity, if null then the color is chosen like any other line.
void	setShowLabels(boolean val) Either show labels or not.
void	setStroke(Label lbl, float... dashes) Provides the dash array for a line.
void	setStrokeOfInfinity(float... dashes) Provides the dashes for the line at infinity, if null then the dashes are chosen like any other line.

Methods inherited from class java.lang.Object

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

Field Detail

showOrigin

public boolean showOrigin

Whether to show the origin or not.

showVertices

public boolean showVertices

Whether to high light vertices with a circle around them

height

public int height

The width and height of the intended image. Values of around 1000 are suggested.

width

public int width

The width and height of the intended image. Values of around 1000 are suggested.

border

public double border

The width of the border in which line labels are shown. Note this may be modified as a side effect of setShowLabels(boolean)

labelPosition

public double labelPosition

The position of the labels within the border. This value should be less than, and approxiamtely half of, border

fontSizeRatio

public double fontSizeRatio

Any scaling that should be applied to the font size.

vertexSize

public int vertexSize

The size of the vertex circle if shown.

background

public Color background

The color of the background to the rectangle, outside the picture

fill

public Color fill

The color of the faces inside the picture

foreground

public Color foreground

The foregound color that is used for text, vertices, and the origin.

originArrowLength

public int originArrowLength

The length of the arrow used to show the origin.

originArrowSize

public int originArrowSize

The size of the arrowhead used to show the origin.

labelBorder

public int labelBorder

An additional border around labels.

lineWidth

public float lineWidth

The width of lines in the diagram.

Method Detail

setColorOfInfinity

public void setColorOfInfinity(Color c)

Provides the color for the line at infinity, if null then the color is chosen like any other line.

Parameters:

c - The color or null.

setStrokeOfInfinity

public void setStrokeOfInfinity(float... dashes)

Provides the dashes for the line at infinity, if null then the dashes are chosen like any other line.

Parameters:

dashes - The dashes or null.

See Also:

BasicStroke.getDashArray()

setColor

public void setColor(Label lbl,
            Color c)

Provides the color for a line. This has no effect for black and white images. For color images there are 18 default colors which are used.

Parameters:

lbl - The line label

c - A color, non-null.

setStroke

public void setStroke(Label lbl,
             float... dashes)

Provides the dash array for a line.

Parameters:

lbl - The line label

dashes - The dash array, non-null.

See Also:

BasicStroke.getDashArray()

defaultBlackAndWhite

public static ImageOptions defaultBlackAndWhite()

Get image options that generate a black and white image.

Returns:

A fresh instance of suggested image options

defaultColor

public static ImageOptions defaultColor()

Get image options that generate a color image.

Returns:

A fresh instance of suggested image options

setShowLabels

public void setShowLabels(boolean val)

Either show labels or not.

Parameters:

val - true for showing labels,