Gui::SoFCColorLegend Class Reference

#include <SoFCColorLegend.h>

Public Member Functions
unsigned long countColors (void) const
bool customize ()
	Opens a dialog to customize the current settings of the color bar. More...
App::Color getColor (float fVal) const
	Returns the associated color to the value fVal. More...
const char * getColorBarName () const
	Returns the name of the color bar. More...
unsigned short getColorIndex (float fVal) const
float getMaxValue (void) const
	Returns the current maximum of the parameter range. More...
float getMinValue (void) const
	Returns the current minimum of the parameter range. More...
bool isVisible (float) const
	Returns always true if the color bar is in mode to show colors to arbitrary values of fVal, otherwise true is returned if fVal is within the specified parameter range, if not false is returned. More...
void setColorModel (App::ColorGradient::TColorModel tModel)
	Sets the color model of the underlying color ramp to tModel. More...
void setMarkerLabel (const SoMFString &label)
void setOutsideGrayed (bool bVal)
	Sets whether values outside the range should be in gray,. More...
void setRange (float fMin, float fMax, int prec=3)
	Sets the range of the colorbar from the maximum fMax to the minimum fMin. More...
SoFCColorLegend (void)
Public Member Functions inherited from Gui::SoFCColorBarBase
virtual void GLRenderBelowPath (SoGLRenderAction *action)

Static Public Member Functions
static void finish (void)
static void initClass (void)
Static Public Member Functions inherited from Gui::SoFCColorBarBase
static void finish (void)
static void initClass (void)

Protected Member Functions
void setViewportSize (const SbVec2s &size)
	Sets the current viewer size to recalculate the new position. More...
virtual ~SoFCColorLegend ()
Protected Member Functions inherited from Gui::SoFCColorBarBase
SoFCColorBarBase (void)
virtual ~SoFCColorBarBase ()
Protected Member Functions inherited from App::ValueFloatToRGB
ValueFloatToRGB (void)
virtual ~ValueFloatToRGB ()

Protected Attributes
SoCoordinate3 * coords
SoSeparator * labels

Constructor & Destructor Documentation

SoFCColorLegend()

SoFCColorLegend::SoFCColorLegend

(

void

)

Constructor.

References App::ColorGradient::FLOW, and App::ColorGradient::TRIA.

~SoFCColorLegend()

SoFCColorLegend::~SoFCColorLegend ( )

protectedvirtual

Destructor.

References labels.

Member Function Documentation

countColors()

unsigned long Gui::SoFCColorLegend::countColors

(

void

)

const

customize()

bool Gui::SoFCColorLegend::customize ( )

virtual

Opens a dialog to customize the current settings of the color bar.

Returns true if the settings have been changed, false otherwise.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

finish()

void SoFCColorLegend::finish ( void  )

static

Referenced by drafttaskpanels.task_polararray.TaskPanelPolarArray::accept(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray::accept(), drafttaskpanels.task_circulararray.TaskPanelCircularArray::accept(), draftguitools.gui_split.Split::action(), draftguitools.gui_splines.BSpline::action(), draftguitools.gui_beziers.BezCurve::action(), draftguitools.gui_lines.Line::action(), draftguitools.gui_polygons.Polygon::action(), draftguitools.gui_subelements.SubelementHighlight::action(), draftguitools.gui_rotate.Rotate::action(), draftguitools.gui_fillets.Fillet::action(), draftguitools.gui_move.Move::action(), draftguitools.gui_texts.Text::action(), draftguitools.gui_mirror.Mirror::action(), draftguitools.gui_stretch.Stretch::action(), draftguitools.gui_scale.Scale::action(), draftguitools.gui_arcs.Arc::action(), draftguitools.gui_offset.Offset::action(), draftguitools.gui_ellipses.Ellipse::action(), draftguitools.gui_rectangles.Rectangle::action(), draftguitools.gui_shapestrings.ShapeString::action(), draftguitools.gui_labels.Label::action(), draftguitools.gui_selectplane.Draft_SelectPlane::action(), draftguitools.gui_trimex.Trimex::action(), draftguitools.gui_beziers.CubicBezCurve::action(), draftguitools.gui_dimensions.Dimension::action(), draftguitools.gui_wire2spline.WireToBSpline::Activated(), draftguitools.gui_subelements.SubelementHighlight::Activated(), draftguitools.gui_dimensions.Dimension::Activated(), draftguitools.gui_edit.Edit::Activated(), draftguitools.gui_selectplane.Draft_SelectPlane::checkSelection(), DraftGui.DraftToolBar::checkSpecialChars(), draftguitools.gui_points.Point::click(), draftguitools.gui_labels.Label::create(), draftguitools.gui_ellipses.Ellipse::createObject(), draftguitools.gui_rectangles.Rectangle::createObject(), draftguitools.gui_texts.Text::createObject(), draftguitools.gui_shapestrings.ShapeString::createObject(), draftguitools.gui_stretch.Stretch::doStretch(), draftguitools.gui_arcs.Arc::drawArc(), draftguitools.gui_polygons.Polygon::drawPolygon(), DraftGui.DraftToolBar::escape(), Gui::SoFCDB::finish(), draftguitools.gui_edit.Edit::keyPressed(), draftguitools.gui_dimensions.Dimension::numericInput(), draftguitools.gui_fillets.Fillet::numericRadius(), draftguitools.gui_offset.Offset::numericRadius(), draftguitools.gui_rotate.Rotate::numericRadius(), draftguitools.gui_trimex.Trimex::numericRadius(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickAlign(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickAuto(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickCenter(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickFront(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickMove(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickPrevious(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickSide(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickTop(), draftguitools.gui_subelements.SubelementHighlight::proceed(), draftguitools.gui_facebinders.Facebinder::proceed(), draftguitools.gui_downgrade.Downgrade::proceed(), draftguitools.gui_draft2sketch.Draft2Sketch::proceed(), draftguitools.gui_upgrade.Upgrade::proceed(), draftguitools.gui_shape2dview.Shape2DView::proceed(), draftguitools.gui_join.Join::proceed(), draftguitools.gui_array_simple.Array::proceed(), draftguitools.gui_clone.Clone::proceed(), draftguitools.gui_split.Split::proceed(), draftguitools.gui_trimex.Trimex::proceed(), draftguitools.gui_pointarray.PointArray::proceed(), draftguitools.gui_patharray.PathArray::proceed(), draftguitools.gui_edit.Edit::proceed(), draftguitools.gui_selectplane.Draft_SelectPlane::reject(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray::reject(), drafttaskpanels.task_polararray.TaskPanelPolarArray::reject(), drafttaskpanels.task_circulararray.TaskPanelCircularArray::reject(), and draftguitools.gui_edit.Edit::setTrackers().

getColor()

App::Color Gui::SoFCColorLegend::getColor ( float  fVal ) const

virtual

Returns the associated color to the value fVal.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

getColorBarName()

const char* Gui::SoFCColorLegend::getColorBarName ( ) const

virtual

Returns the name of the color bar.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

getColorIndex()

unsigned short Gui::SoFCColorLegend::getColorIndex

(

float

fVal

)

const

getMaxValue()

float Gui::SoFCColorLegend::getMaxValue ( void  ) const

virtual

Returns the current maximum of the parameter range.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

getMinValue()

float Gui::SoFCColorLegend::getMinValue ( void  ) const

virtual

Returns the current minimum of the parameter range.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

initClass()

void SoFCColorLegend::initClass ( void  )

static

Referenced by Gui::SoFCDB::init().

isVisible()

bool Gui::SoFCColorLegend::isVisible ( float  fVal ) const

virtual

Returns always true if the color bar is in mode to show colors to arbitrary values of fVal, otherwise true is returned if fVal is within the specified parameter range, if not false is returned.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

Referenced by ArchVRM.Renderer::removeHidden().

setColorModel()

void SoFCColorLegend::setColorModel

(

App::ColorGradient::TColorModel

tModel

)

Sets the color model of the underlying color ramp to tModel.

tModel either can be TRIA, INVERSE_TRIA or GRAY

References App::Color::b, Gui::coinRemoveAllChildren(), App::Color::g, labels, and App::Color::r.

setMarkerLabel()

void SoFCColorLegend::setMarkerLabel

(

const SoMFString &

label

)

References Gui::coinRemoveAllChildren(), and labels.

Referenced by setRange().

setOutsideGrayed()

void Gui::SoFCColorLegend::setOutsideGrayed ( bool  bVal )

virtual

Sets whether values outside the range should be in gray,.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

setRange()

void SoFCColorLegend::setRange ( float  fMin, float  fMax, int  prec = 3  )

virtual

Sets the range of the colorbar from the maximum fMax to the minimum fMin.

prec indicates the post decimal positions, prec should be in between 0 and 6.

Implements Gui::SoFCColorBarBase.

References setMarkerLabel().

setViewportSize()

void SoFCColorLegend::setViewportSize ( const SbVec2s &  size )

protectedvirtual

Sets the current viewer size to recalculate the new position.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

References labels.

Member Data Documentation

coords

SoCoordinate3* Gui::SoFCColorLegend::coords

protected

Referenced by draftguitools.gui_trackers.snapTracker::addCoords(), ArchSite.Compass::buildCoordinates(), draftguitools.gui_trackers.dimTracker::calc(), draftguitools.gui_trackers.snapTracker::clear(), draftguitools.gui_trackers.editTracker::get(), draftguitools.gui_trackers.lineTracker::getLength(), draftguitools.gui_trackers.rectangleTracker::getSize(), draftviewproviders.view_wire.ViewProviderWire::onChanged(), ArchPanel.ViewProviderPanelCut::onChanged(), ArchPanel.ViewProviderPanelSheet::onChanged(), draftguitools.gui_trackers.lineTracker::p1(), draftguitools.gui_trackers.rectangleTracker::p1(), draftguitools.gui_trackers.lineTracker::p2(), draftguitools.gui_trackers.rectangleTracker::p2(), draftguitools.gui_trackers.rectangleTracker::p3(), draftguitools.gui_trackers.rectangleTracker::p4(), draftguitools.gui_trackers.editTracker::set(), draftguitools.gui_trackers.snapTracker::setCoords(), draftguitools.gui_trackers.rectangleTracker::setorigin(), draftguitools.gui_trackers.rectangleTracker::update(), draftguitools.gui_trackers.wireTracker::update(), draftviewproviders.view_wire.ViewProviderWire::updateData(), FeaturePython.ViewProviderCircleSet::updateData(), and draftguitools.gui_trackers.wireTracker::updateFromPointlist().

labels

SoSeparator* Gui::SoFCColorLegend::labels

protected

Referenced by ArchAxis.CommandArchGrid::IsActive(), draftguitools.gui_groups.AddToGroup::proceed(), draftguitools.gui_groups.SetAutoGroup::proceed(), setColorModel(), setMarkerLabel(), setViewportSize(), and ~SoFCColorLegend().

---

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

• src/Gui/SoFCColorLegend.h
• src/Gui/SoFCColorLegend.cpp