pgplot::ColourBar Class Reference

Colour bar (wedge) manager. More...

#include <ColourBar.h>

Inheritance diagram for pgplot::ColourBar:

Public Member Functions
void	set_label (std::string _label)
	Set the colour map name.
std::string	get_label () const
void	set_side (char _side)
	Set the side.
char	get_side () const
void	set_width (float _width)
	Set the total width of the wedge including annotation, in units of the character height.
float	get_width () const
void	set_displacement (float _displacement)
	Set displacement of the wedge from the specified edge of the viewport.
float	get_displacement () const
void	plot (float foreground, float background, bool pgimag=true)
	Plot the colour bar using the current attributes.
Public Member Functions inherited from Reference::Able
	Able (const Able &)
Able &	operator= (const Able &)
unsigned	get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)
HeapTracked &	operator= (const HeapTracked &)
bool	__is_on_heap () const

Additional Inherited Members
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()
Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)
static void	operator delete (void *location, void *ptr)
static void	operator delete (void *location)
static size_t	get_heap_queue_size ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Colour bar (wedge) manager.

Member Function Documentation

set_displacement()

void pgplot::ColourBar::set_displacement ( float _displacement )

inline

Set displacement of the wedge from the specified edge of the viewport.

Displacement is measured outwards from the viewport in units of the character height. Use a negative value to write inside the viewport, a positive value to write outside.

---

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

• ColourBar.h
• ColourBar.C