bridges::datastructure::ElementVisualizer Class Reference

#include <ElementVisualizer.h>

Detailed Description

This class maintains the visual properties of the a Bridges element.

This class is used to store the visualization elements for Bridges Visualiztions, including the color, shape, and size of the node. Defaults of green, circle, and 10.0 respectively.

Size values must range from [1.0,50.0].

BRIDGES supports the shapes listed in Shape ("circle", "square", "diamond", "cross", "wye", "triangle", "star").

Objects of this class are stored as properties of all Element subclasses.

Author

Kalpathi Subramanian

Date

6/11/15, 7/12/19

Public Member Functions
	ElementVisualizer (const Color &hue=DEFAULT_COLOR(), const double &sz=DEFAULT_SIZE(), const Shape &shp=DEFAULT_SHAPE())
void	setSize (const double &sz)
double	getSize () const
void	setColor (const Color &col)
	Set the color to "col". More...
void	setColor (const string &col)
	Set the color to a named color. More...
Color	getColor () const
void	setOpacity (double opacity)
double	getOpacity ()
	Get opacity of element. More...
void	setShape (const Shape &shp)
	Set the shape of the element. More...
Shape	getShape () const
	Return the shape of the element. More...
void	setLocation (const double &locX, const double &locY)
double	getLocationX () const
double	getLocationY () const

Static Public Member Functions
static const Color	DEFAULT_COLOR ()
static constexpr Shape	DEFAULT_SHAPE ()
static constexpr double	DEFAULT_SIZE ()

Constructor & Destructor Documentation

ElementVisualizer()

bridges::datastructure::ElementVisualizer::ElementVisualizer ( const Color &  hue = DEFAULT_COLOR(), const double &  sz = DEFAULT_SIZE(), const Shape &  shp = DEFAULT_SHAPE()  )

inline

Constructs an element with the provided Color, Size, and Shape. The defaults will be used if not provided.

Parameters

hue	The Color for display
sz	The Size for display
shp	The Shape for display

Member Function Documentation

DEFAULT_COLOR()

static const Color bridges::datastructure::ElementVisualizer::DEFAULT_COLOR ( )

inlinestatic

DEFAULT_SHAPE()

static constexpr Shape bridges::datastructure::ElementVisualizer::DEFAULT_SHAPE ( )

inlinestatic

DEFAULT_SIZE()

static constexpr double bridges::datastructure::ElementVisualizer::DEFAULT_SIZE ( )

inlinestatic

getColor()

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

inline

Return the element color

Returns

The color of the element

getLocationX()

double bridges::datastructure::ElementVisualizer::getLocationX ( ) const

inline

Returns

the X coordinate of the element's location attribute

getLocationY()

double bridges::datastructure::ElementVisualizer::getLocationY ( ) const

inline

Returns

the Y coordinate of the element's location attribute

getOpacity()

double bridges::datastructure::ElementVisualizer::getOpacity ( )

inline

Get opacity of element.

Returns

opacity

getShape()

Shape bridges::datastructure::ElementVisualizer::getShape ( ) const

inline

Return the shape of the element.

Returns

The shape of the element

getSize()

double bridges::datastructure::ElementVisualizer::getSize ( ) const

inline

Returns

The size in pixel weight of the element

setColor() [1/2]

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

inline

Set the color to "col".

Parameters

col	The color of the element

setColor() [2/2]

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

inline

Set the color to a named color.

Parameters

col	The color name. Check the Color class for supported values.

setLocation()

void bridges::datastructure::ElementVisualizer::setLocation ( const double &  locX, const double &  locY  )

inline

Set the location attributes of an element. Set location to INFINITY for bridges to chose the location.

Parameters

locX	X coordinate of the element location
locY	Y coordinate of the element location

setOpacity()

void bridges::datastructure::ElementVisualizer::setOpacity ( double  opacity )

inline

Set opacity of element - use the 4th color component

Parameters

opacity

setShape()

void bridges::datastructure::ElementVisualizer::setShape ( const Shape &  shp )

inline

Set the shape of the element.

Parameters

shp	is one of Shape.CIRCLE, Shape.SQUARE, Shape.DIAMOND, Shape.CROSS, Shape.TRIANGLE, Shape.WYE, Shape.STAR.

setSize()

void bridges::datastructure::ElementVisualizer::setSize ( const double &  sz )

inline

Sets size to "sz" Valid Range:[1,50]

Parameters

sz	The size in pixel weight of the element

Exceptions

string

If size is invalid

---

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

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