App::ColorGradient Class Reference

#include <ColorModel.h>

List of all members.

Public Types

enum  TColorModel { TRIA, INVERSE_TRIA, GRAY, INVERSE_GRAY }
enum  TStyle { FLOW, ZERO_BASED }

Public Member Functions

 ColorGradient (const ColorGradient &rclCR)
 ColorGradient (float fMin, float fMax, unsigned short usCtColors, TStyle tS, bool bOG=false)
 ColorGradient (void)
Color getColor (float fVal) const
unsigned short getColorIndex (float fVal) const
const ColorModel & getColorModel (void) const
TColorModel getColorModelType (void) const
unsigned short getCountColors (void) const
float getMaxValue (void) const
unsigned short getMinColors (void) const
float getMinValue (void) const
void getRange (float &rfMin, float &rfMax) const
TStyle getStyle (void) const
bool isOutsideGrayed (void) const
ColorGradient & operator= (const ColorGradient &rclCR)
void set (float fMin, float fMax, unsigned short usCt, TStyle tS, bool bOG)
void setColorModel (TColorModel tModel)
void setCountColors (unsigned short usCt)
void setOutsideGrayed (bool bGrayed)
void setRange (float fMin, float fMax)
void setStyle (TStyle tS)

Protected Member Functions

void rebuild (void)
void setColorModel (void)

Protected Attributes

bool _bOutsideGrayed
ColorModel _clBottom
ColorField _clColFld1
ColorField _clColFld2
ColorModel _clTop
ColorModel _clTotal
float _fMax
float _fMin
TColorModel _tColorModel
TStyle _tStyle
unsigned short _usCtColors

Detailed Description

Definition at line 271 of file ColorModel.h.

Member Enumeration Documentation

enum App::ColorGradient::TColorModel
Enumerator:
TRIA 
INVERSE_TRIA 
GRAY 
INVERSE_GRAY 

Definition at line 275 of file ColorModel.h.

enum App::ColorGradient::TStyle
Enumerator:
FLOW 
ZERO_BASED 

Definition at line 274 of file ColorModel.h.

Constructor & Destructor Documentation

ColorGradient::ColorGradient ( void   ) 

Definition at line 161 of file ColorModel.cpp.

References setColorModel(), and ZERO_BASED.

ColorGradient::ColorGradient ( float  fMin,
float  fMax,
unsigned short  usCtColors,
TStyle  tS,
bool  bOG = false 
)

Definition at line 172 of file ColorModel.cpp.

References setColorModel().

ColorGradient::ColorGradient ( const ColorGradient &  rclCR  ) 

Definition at line 183 of file ColorModel.cpp.

Member Function Documentation

Color App::ColorGradient::getColor ( float  fVal  )  const [inline]

Definition at line 410 of file ColorModel.h.

References _bOutsideGrayed, _clColFld1, _clColFld2, _fMax, _fMin, _tStyle, SketcherExample::f, FLOW, App::ColorField::getColor(), and ZERO_BASED.

unsigned short App::ColorGradient::getColorIndex ( float  fVal  )  const [inline]

Definition at line 440 of file ColorModel.h.

References _clColFld1, _clColFld2, _fMax, _fMin, _tStyle, SketcherExample::f, FLOW, App::ColorField::getColorIndex(), App::ColorField::getCountColors(), and ZERO_BASED.

const ColorModel & App::ColorGradient::getColorModel ( void   )  const [inline]

Definition at line 465 of file ColorModel.h.

References _clBottom, _clTop, _clTotal, _fMax, _fMin, _tStyle, SketcherExample::f, and ZERO_BASED.

Referenced by Gui::SoFCColorGradient::rebuildGradient(), and Gui::SoFCColorLegend::setColorModel().

TColorModel App::ColorGradient::getColorModelType ( void   )  const [inline]

Definition at line 294 of file ColorModel.h.

Referenced by Gui::SoFCColorGradient::customize().

unsigned short App::ColorGradient::getCountColors ( void   )  const [inline]

Definition at line 286 of file ColorModel.h.

Referenced by Gui::SoFCColorGradient::customize(), and Gui::SoFCColorGradient::setRange().

float App::ColorGradient::getMaxValue ( void   )  const [inline]

Definition at line 297 of file ColorModel.h.

unsigned short ColorGradient::getMinColors ( void   )  const

Definition at line 244 of file ColorModel.cpp.

References _clColFld1, _clColFld2, _fMax, _fMin, _tStyle, SketcherExample::f, FLOW, App::ColorField::getMinColors(), and ZERO_BASED.

Referenced by set().

float App::ColorGradient::getMinValue ( void   )  const [inline]

Definition at line 296 of file ColorModel.h.

void App::ColorGradient::getRange ( float &  rfMin,
float &  rfMax 
) const [inline]

Definition at line 285 of file ColorModel.h.

Referenced by Gui::SoFCColorGradient::customize(), and Gui::SoFCColorGradient::isVisible().

TStyle App::ColorGradient::getStyle ( void   )  const [inline]

Definition at line 290 of file ColorModel.h.

Referenced by Gui::SoFCColorGradient::customize(), and Gui::SoFCColorGradient::getMarkerValues().

bool App::ColorGradient::isOutsideGrayed ( void   )  const [inline]

Definition at line 292 of file ColorModel.h.

Referenced by Gui::SoFCColorGradient::customize().

ColorGradient & ColorGradient::operator= ( const ColorGradient &  rclCR  ) 

Definition at line 192 of file ColorModel.cpp.

References _bOutsideGrayed, _clBottom, _clColFld1, _clColFld2, _clTop, _clTotal, _fMax, _fMin, _tColorModel, _tStyle, and _usCtColors.

void ColorGradient::rebuild ( void   )  [protected]

Definition at line 219 of file ColorModel.cpp.

References _clBottom, _clColFld1, _clColFld2, _clTop, _clTotal, _fMax, _fMin, _tStyle, _usCtColors, SketcherExample::f, FLOW, App::ColorField::set(), and ZERO_BASED.

Referenced by set(), and setColorModel().

void ColorGradient::set ( float  fMin,
float  fMax,
unsigned short  usCt,
TStyle  tS,
bool  bOG 
)

Definition at line 209 of file ColorModel.cpp.

References _bOutsideGrayed, _fMax, _fMin, _tStyle, _usCtColors, CCR_EPS, getMinColors(), and rebuild().

void ColorGradient::setColorModel ( void   )  [protected]

Definition at line 268 of file ColorModel.cpp.

References _clBottom, _clColFld1, _clColFld2, _clTop, _clTotal, _tColorModel, _tStyle, FLOW, GRAY, INVERSE_GRAY, INVERSE_TRIA, App::ColorField::setColorModel(), and ZERO_BASED.

Referenced by ColorGradient(), and setColorModel().

void ColorGradient::setColorModel ( TColorModel  tModel  ) 

Definition at line 261 of file ColorModel.cpp.

References _tColorModel, rebuild(), and setColorModel().

Referenced by Gui::SoFCColorGradient::customize(), Gui::SoFCColorLegend::setColorModel(), and Gui::SoFCColorGradient::setColorModel().

void App::ColorGradient::setCountColors ( unsigned short  usCt  )  [inline]

Definition at line 287 of file ColorModel.h.

Referenced by Gui::SoFCColorGradient::customize().

void App::ColorGradient::setOutsideGrayed ( bool  bGrayed  )  [inline]

Definition at line 291 of file ColorModel.h.

Referenced by Gui::SoFCColorGradient::customize().

void App::ColorGradient::setRange ( float  fMin,
float  fMax 
) [inline]

Definition at line 284 of file ColorModel.h.

Referenced by Gui::SoFCColorLegend::setRange(), and Gui::SoFCColorGradient::setRange().

void App::ColorGradient::setStyle ( TStyle  tS  )  [inline]

Definition at line 288 of file ColorModel.h.

Referenced by Gui::SoFCColorGradient::customize(), Gui::SoFCColorGradient::setColorStyle(), Gui::SoFCColorGradient::SoFCColorGradient(), and Gui::SoFCColorLegend::SoFCColorLegend().

Member Data Documentation

bool App::ColorGradient::_bOutsideGrayed [protected]

Definition at line 308 of file ColorModel.h.

Referenced by getColor(), operator=(), and set().

ColorModel App::ColorGradient::_clBottom [protected]

Definition at line 309 of file ColorModel.h.

Referenced by getColorModel(), operator=(), rebuild(), and setColorModel().

ColorField App::ColorGradient::_clColFld1 [protected]

Definition at line 303 of file ColorModel.h.

Referenced by getColor(), getColorIndex(), getMinColors(), operator=(), rebuild(), and setColorModel().

ColorField App::ColorGradient::_clColFld2 [protected]

Definition at line 303 of file ColorModel.h.

Referenced by getColor(), getColorIndex(), getMinColors(), operator=(), rebuild(), and setColorModel().

ColorModel App::ColorGradient::_clTop [protected]

Definition at line 309 of file ColorModel.h.

Referenced by getColorModel(), operator=(), rebuild(), and setColorModel().

ColorModel App::ColorGradient::_clTotal [protected]

Definition at line 309 of file ColorModel.h.

Referenced by getColorModel(), operator=(), rebuild(), and setColorModel().

float App::ColorGradient::_fMax [protected]

Definition at line 306 of file ColorModel.h.

Referenced by getColor(), getColorIndex(), getColorModel(), getMinColors(), operator=(), rebuild(), and set().

float App::ColorGradient::_fMin [protected]

Definition at line 306 of file ColorModel.h.

Referenced by getColor(), getColorIndex(), getColorModel(), getMinColors(), operator=(), rebuild(), and set().

TColorModel App::ColorGradient::_tColorModel [protected]

Definition at line 304 of file ColorModel.h.

Referenced by operator=(), and setColorModel().

TStyle App::ColorGradient::_tStyle [protected]

Definition at line 305 of file ColorModel.h.

Referenced by getColor(), getColorIndex(), getColorModel(), getMinColors(), operator=(), rebuild(), set(), and setColorModel().

unsigned short App::ColorGradient::_usCtColors [protected]

Definition at line 307 of file ColorModel.h.

Referenced by operator=(), rebuild(), and set().

The documentation for this class was generated from the following files:
Generated on Wed Nov 23 19:01:42 2011 for FreeCAD by  doxygen 1.6.1