org.openimaj.vis.general

Class AxisRenderer<Q>

java.lang.Object

org.openimaj.vis.general.AxisRenderer<Q>

Type Parameters:

Q - The pixel colour representation

Direct Known Subclasses:

AxisRenderer2D, AxisRenderer3D

public abstract class AxisRenderer<Q>
extends Object

A general axis renderer that can be used for rendering an axis into a visualisation.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

9 Jul 2013

Field Summary

Fields

Modifier and Type	Field and Description
protected AxisConfig<Q>	config The axis configuration

Constructor Summary

Constructors

Constructor and Description
AxisRenderer()

Method Summary

Modifier and Type	Method and Description
abstract void	drawAxis(AxisConfig<Q> config) Draw the major axis
abstract void	drawAxisLabel(AxisConfig<Q> config) Draw the axis label
abstract void	drawMajorTick(double location, AxisConfig<Q> config) Draw a tick on the axis at the given location
abstract void	drawMajorTickGridline(double location, AxisConfig<Q> config) Draw a major grid line on the vis
abstract void	drawMinorTick(double location, AxisConfig<Q> config) Draw a minor tick on the axis
abstract void	drawMinorTickGridline(double location, AxisConfig<Q> config) Draw a minor grid on the vis
AxisConfig<Q>	getConfig()
double	nearestHigherMajorTick(double value) Find the nearest higher major tick mark to the given value.
double	nearestLowerMajorTick(double value) Find the nearest lower major tick mark to the given value.
void	precalc() Perform any precalculations that will allow the axes to be drawn faster, or to allow the data transformer to work.
void	renderAxis()
void	setConfig(AxisConfig<Q> config)

Methods inherited from class java.lang.Object

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

Field Detail

config

protected AxisConfig<Q> config

The axis configuration

Constructor Detail

AxisRenderer

public AxisRenderer()

Method Detail

drawAxis

public abstract void drawAxis(AxisConfig<Q> config)

Draw the major axis

Parameters:

config - The axis configuration

drawAxisLabel

public abstract void drawAxisLabel(AxisConfig<Q> config)

Draw the axis label

Parameters:

config - The axis configuration

drawMajorTick

public abstract void drawMajorTick(double location,
                                   AxisConfig<Q> config)

Draw a tick on the axis at the given location

Parameters:

location - The location (in data units)

config - The config

drawMajorTickGridline

public abstract void drawMajorTickGridline(double location,
                                           AxisConfig<Q> config)

Draw a major grid line on the vis

Parameters:

location - The location (in data units)

config - The config

drawMinorTick

public abstract void drawMinorTick(double location,
                                   AxisConfig<Q> config)

Draw a minor tick on the axis

Parameters:

location - The location (in data units)

config - The configuration

drawMinorTickGridline

public abstract void drawMinorTickGridline(double location,
                                           AxisConfig<Q> config)

Draw a minor grid on the vis

Parameters:

location - The location (in data units)

config - The axis configuration

nearestLowerMajorTick

public double nearestLowerMajorTick(double value)

Find the nearest lower major tick mark to the given value.

Parameters:

value - The given value

Returns:

The nearest lower major tick mark

nearestHigherMajorTick

public double nearestHigherMajorTick(double value)

Find the nearest higher major tick mark to the given value.

Parameters:

value - The given value

Returns:

The nearest higher major tick mark

precalc

public void precalc()

Perform any precalculations that will allow the axes to be drawn faster, or to allow the data transformer to work.

renderAxis

public void renderAxis()

getConfig

public AxisConfig<Q> getConfig()

Returns:

the config

setConfig

public void setConfig(AxisConfig<Q> config)

Parameters:

config - the config to set