bridges::datastructure::LinkVisualizer Class Reference

#include <LinkVisualizer.h>

Detailed Description

This class maintains the visual properties of links within data structures.

This class is used to keep the visual properties of links that are part of data structures such as linked lists, pointer based trees, link based graph representations, etc. Relevant attributes include color and thickness

Objects of this class are stored as properties of Elements. A user may manipulate the LinkVisualizer returned from the Element's getLinkVisualizer() method.

BRIDGES supports color of any legal named CSS or "#hexadecimal" value. Check Color for details. Default: opaque black.

Thickness values must range from [1.0,10.0]. Default: 1.0

Author

Kalpathi Subramanian, Dakota Carmer

Date

6/29/15, 6/10/16, 7/12/19

Public Member Functions
	LinkVisualizer (Color col=DEFAULT_COLOR(), double th=DEFAULT_THICKNESS())
	Constructs a LinkVisualizer with the specified color and thickness. The defaults will be used if not provided (black,1) More...
string	getLabel () const
	Return the link label. More...
void	setLabel (const string &lab)
	Sets label of the link. More...
void	setThickness (const double &th)
double	getThickness () const
	Get the link thickness. More...
void	setColor (const Color &col)
	Set the link color. More...
void	setColor (const string &col)
	Set the color by name. More...
Color	getColor () const
	Return the link color. More...

Static Public Member Functions
static constexpr double	DEFAULT_THICKNESS ()
static Color	DEFAULT_COLOR ()

Constructor & Destructor Documentation

LinkVisualizer()

bridges::datastructure::LinkVisualizer::LinkVisualizer ( Color  col = DEFAULT_COLOR(), double  th = DEFAULT_THICKNESS()  )

inline

Constructs a LinkVisualizer with the specified color and thickness. The defaults will be used if not provided (black,1)

Parameters

col	Link color
th	Link thickness

Member Function Documentation

DEFAULT_COLOR()

static Color bridges::datastructure::LinkVisualizer::DEFAULT_COLOR ( )

inlinestatic

DEFAULT_THICKNESS()

static constexpr double bridges::datastructure::LinkVisualizer::DEFAULT_THICKNESS ( )

inlinestatic

getColor()

Color bridges::datastructure::LinkVisualizer::getColor ( ) const

inline

Return the link color.

Returns

The color of the link

getLabel()

string bridges::datastructure::LinkVisualizer::getLabel ( ) const

inline

Return the link label.

Returns

The label of the link

getThickness()

double bridges::datastructure::LinkVisualizer::getThickness ( ) const

inline

Get the link thickness.

Returns

Size in pixels of the link's line thickness

setColor() [1/2]

void bridges::datastructure::LinkVisualizer::setColor ( const Color &  col )

inline

Set the link color.

Parameters

col	The color of the element

setColor() [2/2]

void bridges::datastructure::LinkVisualizer::setColor ( const string &  col )

inline

Set the color by name.

Parameters

col	The color name. See Color for supported names.

setLabel()

void bridges::datastructure::LinkVisualizer::setLabel ( const string &  lab )

inline

Sets label of the link.

Parameters

lab	The label of the link

setThickness()

void bridges::datastructure::LinkVisualizer::setThickness ( const double &  th )

inline

Set the link thickness Valid Range:[1,10] Default: 1

Parameters

th	The size in pixels of the link's line weight

Exceptions

string

If invalid thickness

---

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

• /home/erik/work/bridges/bridges-cxx/src/LinkVisualizer.h