#include <SoFCColorGradient.h>

Public Member Functions

bool customize ()
 Opens a dialog to customize the current settings of the color gradient 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...
 
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 fVal) const
 Returns always true if the gradient 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 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...
 
 SoFCColorGradient (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

std::vector< float > getMarkerValues (float fMin, float fMax, int count) const
 Returns a list of count labels within the ranhe [fMin, fMax]. More...
 
void rebuildGradient ()
 Rebuild the gradient bar. More...
 
void setColorModel (App::ColorGradient::TColorModel tModel)
 Sets the color model of the underlying color gradient to tModel. More...
 
void setColorStyle (App::ColorGradient::TStyle tStyle)
 Sets the color style of the underlying color gradient to tStyle. More...
 
void setViewportSize (const SbVec2s &size)
 Sets the current viewer size this color gradient is embedded into, to recalculate its new position. More...
 
virtual ~SoFCColorGradient ()
 
- Protected Member Functions inherited from Gui::SoFCColorBarBase
 SoFCColorBarBase (void)
 
virtual ~SoFCColorBarBase ()
 
- Protected Member Functions inherited from App::ValueFloatToRGB
 ValueFloatToRGB (void)
 
virtual ~ValueFloatToRGB ()
 

Constructor & Destructor Documentation

◆ SoFCColorGradient()

SoFCColorGradient::SoFCColorGradient ( void  )

Constructor.

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

◆ ~SoFCColorGradient()

SoFCColorGradient::~SoFCColorGradient ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ customize()

◆ finish()

void SoFCColorGradient::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::SoFCColorGradient::getColor ( float  fVal) const
virtual

Returns the associated color to the value fVal.

Implements Gui::SoFCColorBarBase.

◆ getColorBarName()

const char* Gui::SoFCColorGradient::getColorBarName ( ) const
virtual

Returns the name of the color bar.

Implements Gui::SoFCColorBarBase.

◆ getMarkerValues()

std::vector< float > SoFCColorGradient::getMarkerValues ( float  fMin,
float  fMax,
int  count 
) const
protected

Returns a list of count labels within the ranhe [fMin, fMax].


References App::ColorGradient::ZERO_BASED.

Referenced by setRange().

◆ getMaxValue()

float Gui::SoFCColorGradient::getMaxValue ( void  ) const
virtual

Returns the current maximum of the parameter range.

Implements Gui::SoFCColorBarBase.

◆ getMinValue()

float Gui::SoFCColorGradient::getMinValue ( void  ) const
virtual

Returns the current minimum of the parameter range.

Implements Gui::SoFCColorBarBase.

◆ initClass()

void SoFCColorGradient::initClass ( void  )
static

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

◆ isVisible()

bool SoFCColorGradient::isVisible ( float  fVal) const
virtual

Returns always true if the gradient 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.

Implements Gui::SoFCColorBarBase.

Referenced by ArchVRM.Renderer::removeHidden().

◆ rebuildGradient()

void SoFCColorGradient::rebuildGradient ( )
protected

Rebuild the gradient bar.

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

Referenced by customize(), setColorModel(), and setColorStyle().

◆ setColorModel()

void SoFCColorGradient::setColorModel ( App::ColorGradient::TColorModel  tModel)
protected

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

tModel either can be TRIA, INVERSE_TRIA, GRAY or INVERSE_GRAY

References rebuildGradient().

◆ setColorStyle()

void SoFCColorGradient::setColorStyle ( App::ColorGradient::TStyle  tStyle)
protected

Sets the color style of the underlying color gradient to tStyle.

tStyle either can be FLOW or ZERO_BASED

References rebuildGradient().

◆ setOutsideGrayed()

void Gui::SoFCColorGradient::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 SoFCColorGradient::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 getMarkerValues().

Referenced by customize().

◆ setViewportSize()

void SoFCColorGradient::setViewportSize ( const SbVec2s &  size)
protectedvirtual

Sets the current viewer size this color gradient is embedded into, to recalculate its new position.

Implements Gui::SoFCColorBarBase.


The documentation for this class was generated from the following files:
  • src/Gui/SoFCColorGradient.h
  • src/Gui/SoFCColorGradient.cpp