AxisStyle Class Reference

#include <AxisStyle.hpp>

List of all members.

---

Detailed Description

This class is used to describe an Axis's style.

This includes information about ticks and labels for the Axis.

Examples:

example13.cpp.

Definition at line 72 of file AxisStyle.hpp.

Public Member Functions
	AxisStyle ()
	~AxisStyle ()
Public Attributes
bool	logarithmic
	Is this logarithmic?
int	tick_position
	This is where it appears on the line or through it, which side.
vdraw::StrokeStyle	tick_style
	This is the line style for ticks, if null use line_style.
double	major_tick_length
	Max tick length.
bool	tight_bounds
	Tight bounds (don't make them any bigger than the settings say In other words: Force min and max to be at top and bottom.
bool	start_ticks_on_zero
	Start labelling ticks from zero?
double	tick_depth_multiplier
	Ratio for each successive depth of tick marks. Like .8 or .5.
int	tick_recursion_depth
	Recursive depth to create tick marks.
int	subticks_per_tick
	Number of subticks for every tick.
bool	draw_labels
	Draw labels.
vdraw::TextStyle	label_style
	The style of the label text.
int	label_position
	The position of the label. Valid positions are ABOVE and BELOW.
std::string	label_format
	Format string for the label.
vdraw::StrokeStyle	line_style
	The style of the line.
Static Public Attributes
const int	ABOVE = -1
	Based on the axis's direction, these describe where the ticks are drawn.
const int	CENTER = 0
const int	BELOW = 1

---

Constructor & Destructor Documentation

AxisStyle (   )  [inline]

Definition at line 165 of file AxisStyle.hpp.

~AxisStyle (   )  [inline]

Definition at line 183 of file AxisStyle.hpp.

---

Member Data Documentation

const int ABOVE = -1 [static]

Based on the axis's direction, these describe where the ticks are drawn. * | | * Axis: ------+------|------+------ (end) * | | * ABOVE CENTER BELOW Definition at line 84 of file AxisStyle.hpp.

const int BELOW = 1 [static]

Definition at line 86 of file AxisStyle.hpp.

const int CENTER = 0 [static]

Definition at line 85 of file AxisStyle.hpp.

bool draw_labels

Draw labels. Examples: example13.cpp. Definition at line 126 of file AxisStyle.hpp.

std::string label_format

Format string for the label. The idea is that this will be "" by default (allowing Axis to figure it out. Otherwise set it to a format string taking a single double such as "%0.4f" or "%3g" or whatever you wish. Definition at line 152 of file AxisStyle.hpp.

int label_position

The position of the label. Valid positions are ABOVE and BELOW. Definition at line 144 of file AxisStyle.hpp.

vdraw::TextStyle label_style

The style of the label text. Definition at line 137 of file AxisStyle.hpp.

vdraw::StrokeStyle line_style

The style of the line. Examples: example13.cpp. Definition at line 159 of file AxisStyle.hpp.

bool logarithmic

Is this logarithmic? Definition at line 93 of file AxisStyle.hpp.

double major_tick_length

Max tick length. Definition at line 102 of file AxisStyle.hpp. Referenced by Axis::axisTick().

bool start_ticks_on_zero

Start labelling ticks from zero? Definition at line 110 of file AxisStyle.hpp.

int subticks_per_tick

Number of subticks for every tick. Definition at line 119 of file AxisStyle.hpp.

double tick_depth_multiplier

Ratio for each successive depth of tick marks. Like .8 or .5. Definition at line 113 of file AxisStyle.hpp.

int tick_position

This is where it appears on the line or through it, which side. Definition at line 96 of file AxisStyle.hpp.

int tick_recursion_depth

Recursive depth to create tick marks. Definition at line 116 of file AxisStyle.hpp. Referenced by Axis::axisTick().

vdraw::StrokeStyle tick_style

This is the line style for ticks, if null use line_style. Examples: example13.cpp. Definition at line 99 of file AxisStyle.hpp.

bool tight_bounds

Tight bounds (don't make them any bigger than the settings say In other words: Force min and max to be at top and bottom. Definition at line 106 of file AxisStyle.hpp.

---

The documentation for this class was generated from the following file:

• AxisStyle.hpp

---