TreeMap Class Reference

The TreeMap is used to manage and render a TreeMap with a specified layout. More...

#include <TreeMap.h>

List of all members.

Public Member Functions

TreeMap ()

Default Constructor.

~TreeMap ()

Destructor.

void Prepare (void)

spacing between layout rectangles

void Destroy (void)

Destroy the TreeMap.

void SetLayoutSpacing (float spacing)

Set new layout spacing.

float GetLayoutSpacing (void) const

Get layout spacing.

void SetLayout (TreeMapLayout *_layout)

Sets a new layout for rendering the TreeMap.

void UpdateLayout (LayoutRectangle rc)

Update the current layout (called after Prepare()).

void Render (LayoutRectangle rc)

Render the TreeMap.

Public Attributes

TreeMapLayout * layout

Active layout algorithm.

TreeMapItem * root

Root node of the TreeMap.

float layoutSpacing

The layout spacing used to render the TreeMap . Spacing between different areas of the TreeMap. 0 means no spacing.

Detailed Description

The TreeMap is used to manage and render a TreeMap with a specified layout.

void TreeMap::Prepare ( void )

spacing between layout rectangles

Prepare data structures (must be called before UpdateLayout()).

void TreeMap::Render ( LayoutRectangle rc )

Render the TreeMap.

Parameters:

rc

Bounds of the layout.

void TreeMap::SetLayout ( TreeMapLayout * _layout )

Sets a new layout for rendering the TreeMap.

Parameters:

_layout

New layout.

void TreeMap::SetLayoutSpacing ( float spacing ) [inline]

Set new layout spacing.

Parameters:

spacing

New layout spacing.

void TreeMap::UpdateLayout ( LayoutRectangle rc )

Update the current layout (called after Prepare()).

Parameters:

rc

Bounds of the layout.

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


Public Member Functions
	TreeMap ()
	Default Constructor.
	~TreeMap ()
	Destructor.
void	Prepare (void)
	spacing between layout rectangles
void	Destroy (void)
	Destroy the TreeMap.
void	SetLayoutSpacing (float spacing)
	Set new layout spacing.
float	GetLayoutSpacing (void) const
	Get layout spacing.
void	SetLayout (TreeMapLayout *_layout)
	Sets a new layout for rendering the TreeMap.
void	UpdateLayout (LayoutRectangle rc)
	Update the current layout (called after Prepare()).
void	Render (LayoutRectangle rc)
	Render the TreeMap.
Public Attributes
TreeMapLayout *	layout
	Active layout algorithm.
TreeMapItem *	root
	Root node of the TreeMap.
float	layoutSpacing
	The layout spacing used to render the TreeMap . Spacing between different areas of the TreeMap. 0 means no spacing.