cee::plt::MarkerLine Class Reference

Settings for a marker line in an OverlayPlot object. More...

Public Member Functions

double value () const
 Returns the x-value for the marker line. More...
 
void setValue (double position)
 Sets the marker lines position on the x-axis. More...
 
bool drawLine () const
 Returns true if marker line is drawn. More...
 
void setDrawLine (bool drawMarkerLine)
 Draws the marker line if set to true. More...
 
Color3f color () const
 Returns the marker line color. More...
 
void setColor (const Color3f &color)
 Sets the color of the marker line. More...
 

Detailed Description

Settings for a marker line in an OverlayPlot object.

A marker line is a vertical line in the plot defined by a value on the x axis.

It can, for instance, be synchronized with state animation to show the matching position in the plot

Member Function Documentation

cee::Color3f cee::plt::MarkerLine::color ( ) const

Returns the marker line color.

bool cee::plt::MarkerLine::drawLine ( ) const

Returns true if marker line is drawn.

void cee::plt::MarkerLine::setColor ( const Color3f color)

Sets the color of the marker line.

void cee::plt::MarkerLine::setDrawLine ( bool  drawMarkerLine)

Draws the marker line if set to true.

void cee::plt::MarkerLine::setValue ( double  position)

Sets the marker lines position on the x-axis.

double cee::plt::MarkerLine::value ( ) const

Returns the x-value for the marker line.