Overview     Modules     Class Hierarchy     Classes     Members  
tlp::GlNominativeAxis Class Reference

A class to render an axis graduated with string values. More...

#include <GlNominativeAxis.h>

Inheritance diagram for tlp::GlNominativeAxis:
Collaboration diagram for tlp::GlNominativeAxis:

List of all members.

Public Member Functions

 GlNominativeAxis (const std::string &axisName, const Coord &axisBaseCoord, const float axisLength, const AxisOrientation &axisOrientation, const Color &axisColor, const float axisWidth=10)
void setAxisGraduationsLabels (const std::vector< std::string > &axisGradsLabels, const LabelPosition &labelsPosition)
void updateAxis ()
Coord getAxisPointCoordForValue (std::string value)
std::string getValueAtAxisPoint (const Coord &axisPointCoord)
void translate (const Coord &c)
- Public Member Functions inherited from tlp::GlAxis
 GlAxis (const std::string &axisName, const Coord &axisBaseCoord, const float axisLength, const AxisOrientation &axisOrientation, const Color &axisColor, const float axisWidth=10)
virtual ~GlAxis ()
Coord getAxisBaseCoord () const
float getAxisLength () const
std::string getAxisName () const
AxisOrientation getAxisOrientation () const
float getAxisGradsWidth () const
float getSpaceBetweenAxisGrads () const
float getLabelHeight () const
float getMaxLabelWidth () const
Color getAxisColor () const
void setAxisName (const std::string &axisName)
void setAxisLength (const float axisLength)
void setAxisColor (const Color &axisColor)
void setAxisGradsWidth (const float axisGradsWidth)
void setMaxCaptionWidth (const float maxCaptionWidth)
void setAxisGraduations (const std::vector< std::string > &axisGradsLabels, const LabelPosition &axisGradsLabelsPosition=LEFT_OR_BELOW)
void setAxisGraduationsMaxLabelWidth (const float maxWidth)
void addCaption (const LabelPosition &captionPos, const float captionHeight, const bool captionFrame=false, const float maxCaptionWidth=0, const float captionOffset=0, const std::string caption="")
- Public Member Functions inherited from tlp::GlComposite
 GlComposite (bool deleteComponentsInDestructor=true)
 ~GlComposite ()
virtual void addLayerParent (GlLayer *layer)
virtual void removeLayerParent (GlLayer *layer)
void reset (bool deleteElems)
void addGlEntity (GlSimpleEntity *entity, const std::string &key)
void deleteGlEntity (const std::string &key, bool informTheEntity=true)
void deleteGlEntity (GlSimpleEntity *entity, bool informTheEntity=true)
std::string findKey (GlSimpleEntity *entity)
GlSimpleEntityfindGlEntity (const std::string &key)
std::map< std::string,
GlSimpleEntity * > * 
getDisplays ()
void notifyModified (GlSimpleEntity *entity)
virtual void draw (float, Camera *)
virtual void setStencil (int stencil)
virtual void acceptVisitor (GlSceneVisitor *visitor)
void setDeleteComponentsInDestructor (bool deleteComponentsInDestructor)
virtual void getXML (xmlNodePtr rootNode)
virtual void setWithXML (xmlNodePtr rootNode)
- Public Member Functions inherited from tlp::GlSimpleEntity
 GlSimpleEntity ()
virtual ~GlSimpleEntity ()
virtual void setVisible (bool visible)
bool isVisible ()
int getStencil ()
void setCheckByBoundingBoxVisitor (bool check)
bool isCheckByBoundingBoxVisitor ()
virtual BoundingBox getBoundingBox ()
void addParent (GlComposite *composite)
void removeParent (GlComposite *composite)
- Public Member Functions inherited from tlp::GlEntity
virtual ~GlEntity ()

Additional Inherited Members

- Public Types inherited from tlp::GlAxis
enum  AxisOrientation { HORIZONTAL_AXIS, VERTICAL_AXIS }
enum  LabelPosition { LEFT_OR_BELOW, RIGHT_OR_ABOVE }
- Protected Member Functions inherited from tlp::GlAxis
void computeBoundingBox ()
virtual Coord computeCaptionCenter ()
virtual void computeCaptionSize (float height)
void addAxisCaption (const Coord &captionLabelCenter, const bool captionFrame)
- Protected Attributes inherited from tlp::GlAxis
std::string axisName
Coord axisBaseCoord
float axisLength
AxisOrientation axisOrientation
Color axisColor
float axisGradsWidth
float spaceBetweenAxisGrads
float captionWidth
float captionHeight
bool captionFrame
std::string captionText
float labelHeight
float captionOffset
GlCompositeaxisLinesComposite
GlCompositecaptionComposite
GlCompositegradsComposite
bool captionSet
LabelPosition captionPosition
float maxCaptionWidth
float maxGraduationLabelWidth
float axisWidth
- Protected Attributes inherited from tlp::GlComposite
std::map< std::string,
GlSimpleEntity * > 
elements
std::list< GlSimpleEntity * > _sortedElements
std::vector< GlLayer * > layerParents
bool deleteComponentsInDestructor
- Protected Attributes inherited from tlp::GlSimpleEntity
bool visible
int stencil
bool checkByBoundingBoxVisitor
BoundingBox boundingBox
std::vector< GlComposite * > parents

Detailed Description

A class to render an axis graduated with string values.

This class allow to draw a nominative axis (i.e. an axis graduated with string values)


Constructor & Destructor Documentation

tlp::GlNominativeAxis::GlNominativeAxis ( const std::string &  axisName,
const Coord &  axisBaseCoord,
const float  axisLength,
const AxisOrientation axisOrientation,
const Color &  axisColor,
const float  axisWidth = 10 
)

GlNominativeAxis constructor. Build a nominative axis with no graduations (need to call setAxisGraduationsLabels to build them)

Parameters:
axisNamethe name of the axis the base coord of the axis (if the axis is horizontal, it is the the left end, if vertical it is the down end) the length of the axis the orientation of the axis, 2 possible values (HORIZONTAL_AXIS or VERTICAL_AXIS) the color of the axis

Member Function Documentation

Coord tlp::GlNominativeAxis::getAxisPointCoordForValue ( std::string  value)

Method to get the axis point coordinates associated to string value

Parameters:
valuethe string value we want to retrieve axis point coordinates
std::string tlp::GlNominativeAxis::getValueAtAxisPoint ( const Coord &  axisPointCoord)

Method to get the string value associated to an axis point. Return "" if there is not.

Parameters:
axisPointCoordthe axis point coordinates we want to retrieve the associated string value
void tlp::GlNominativeAxis::setAxisGraduationsLabels ( const std::vector< std::string > &  axisGradsLabels,
const LabelPosition labelsPosition 
)

Method to set the axis graduations labels. A call to updateAxis has to be done after calling this method to build or update the axis graduations. The labels will be placed on the axis in the same order as the vector passed as parameter (from bottom to top if the axis is vertical, from left to right if it is horizontal).

Parameters:
axisGradsLabelsa vector of string containing the graduations labels
labelsPositionthe relative position of the axis graduations label. Two possible values : LEFT_OR_BELOW (if the axis is vertical, labels will be on the left of the axis, otherwise below) or RIGHT_OR_ABOVE
void tlp::GlNominativeAxis::translate ( const Coord &  mouvement)
virtual

translate the composite with children

Reimplemented from tlp::GlAxis.

void tlp::GlNominativeAxis::updateAxis ( )
virtual

Method to update the axis drawing. It has to be called when one (or more) of the setters method above has been used. This method redraw the whole axis and the graduations.

Reimplemented from tlp::GlAxis.



Tulip Software by LaBRI Visualization Team    2001 - 2012