Open CASCADE Technology 6.6.0
Public Member Functions | Static Public Member Functions | Protected Member Functions
Aspect_ColorScale Class Reference

#include <Aspect_ColorScale.hxx>

Inheritance diagram for Aspect_ColorScale:
Inheritance graph
[legend]

Public Member Functions

Standard_Boolean FindColor (const Standard_Real Value, Quantity_Color &Color) const
 Calculate color according passed value; returns true if value is in range or false, if isn't

Standard_Real GetMin () const
 Returns minimal value of color scale;

Standard_Real GetMax () const
 Returns maximal value of color scale;

void GetRange (Standard_Real &aMin, Standard_Real &aMax) const
 Returns minimal and maximal values of color scale;

Aspect_TypeOfColorScaleData GetLabelType () const
 Returns the type of labels;
Aspect_TOCSD_AUTO - labels as boundary values for intervals
Aspect_TOCSD_USER - user specified label is used

Aspect_TypeOfColorScaleData GetColorType () const
 Returns the type of colors;
Aspect_TOCSD_AUTO - value between Red and Blue
Aspect_TOCSD_USER - user specified color from color map

Standard_Integer GetNumberOfIntervals () const
 Returns the number of color scale intervals;

TCollection_ExtendedString GetTitle () const
 Returns the color scale title string;

TCollection_AsciiString GetFormat () const
 Returns the format for numbers.
The same like format for function printf().
Used if GetLabelType() is TOCSD_AUTO;

TCollection_ExtendedString GetLabel (const Standard_Integer anIndex) const
 Returns the user specified label with index <anIndex>.
Returns empty string if label not defined.

Quantity_Color GetColor (const Standard_Integer anIndex) const
 Returns the user specified color from color map with index <anIndex>.
Returns default color if index out of range in color map.

void GetLabels (TColStd_SequenceOfExtendedString &aLabels) const
 Returns the user specified labels.

void GetColors (Aspect_SequenceOfColor &aColors) const
 Returns the user specified colors.

Aspect_TypeOfColorScalePosition GetLabelPosition () const
 Returns the position of labels concerning color filled rectangles.

Aspect_TypeOfColorScalePosition GetTitlePosition () const
 Returns the position of color scale title.

Standard_Boolean IsReversed () const
 Returns true if the labels and colors used in reversed order.

Standard_Boolean IsLabelAtBorder () const
 Returns true if the labels placed at border of color filled rectangles.

void SetMin (const Standard_Real aMin)
 Sets the minimal value of color scale.

void SetMax (const Standard_Real aMax)
 Sets the maximal value of color scale.

void SetRange (const Standard_Real aMin, const Standard_Real aMax)
 Sets the minimal and maximal value of color scale.

void SetLabelType (const Aspect_TypeOfColorScaleData aType)
 Sets the type of labels.
Aspect_TOCSD_AUTO - labels as boundary values for intervals
Aspect_TOCSD_USER - user specified label is used

void SetColorType (const Aspect_TypeOfColorScaleData aType)
 Sets the type of colors.
Aspect_TOCSD_AUTO - value between Red and Blue
Aspect_TOCSD_USER - user specified color from color map

void SetNumberOfIntervals (const Standard_Integer aNum)
 Sets the number of color scale intervals.

void SetTitle (const TCollection_ExtendedString &aTitle)
 Sets the color scale title string.

void SetFormat (const TCollection_AsciiString &aFormat)
 Sets the color scale auto label format specification.

void SetLabel (const TCollection_ExtendedString &aLabel, const Standard_Integer anIndex=-1)
 Sets the color scale label at index. Index started from 1.

void SetColor (const Quantity_Color &aColor, const Standard_Integer anIndex=-1)
 Sets the color scale color at index. Index started from 1.

void SetLabels (const TColStd_SequenceOfExtendedString &aSeq)
 Sets the color scale labels.

void SetColors (const Handle< Aspect_ColorMap > &aMap)
 Sets the color scale colors.

void SetColors (const Aspect_SequenceOfColor &aSeq)
 Sets the color scale colors.

void SetLabelPosition (const Aspect_TypeOfColorScalePosition aPos)
 Sets the color scale labels position concerning color filled rectangles.

void SetTitlePosition (const Aspect_TypeOfColorScalePosition aPos)
 Sets the color scale title position.

void SetReversed (const Standard_Boolean aReverse)
 Sets true if the labels and colors used in reversed order.

void SetLabelAtBorder (const Standard_Boolean anOn)
 Sets true if the labels placed at border of color filled rectangles.

void GetSize (Standard_Real &aWidth, Standard_Real &aHeight) const
 Returns the size of color scale.

Standard_Real GetWidth () const
 Returns the width of color scale.

Standard_Real GetHeight () const
 Returns the height of color scale.

void SetSize (const Standard_Real aWidth, const Standard_Real aHeight)
 Sets the size of color scale.

void SetWidth (const Standard_Real aWidth)
 Sets the width of color scale.

void SetHeight (const Standard_Real aHeight)
 Sets the height of color scale.

void GetPosition (Standard_Real &aX, Standard_Real &aY) const
 Returns the position of color scale.

Standard_Real GetXPosition () const
 Returns the X position of color scale.

Standard_Real GetYPosition () const
 Returns the height of color scale.

void SetPosition (const Standard_Real aX, const Standard_Real aY)
 Sets the position of color scale.

void SetXPosition (const Standard_Real aX)
 Sets the X position of color scale.

void SetYPosition (const Standard_Real aY)
 Sets the Y position of color scale.

Standard_Integer GetTextHeight () const
void SetTextHeight (const Standard_Integer aHeigh)
virtual void PaintRect (const Standard_Integer X, const Standard_Integer Y, const Standard_Integer W, const Standard_Integer H, const Quantity_Color &aColor, const Standard_Boolean aFilled=Standard_False)=0
virtual void PaintText (const TCollection_ExtendedString &aText, const Standard_Integer X, const Standard_Integer Y, const Quantity_Color &aColor)=0
virtual Standard_Integer TextWidth (const TCollection_ExtendedString &aText) const =0
virtual Standard_Integer TextHeight (const TCollection_ExtendedString &aText) const =0

Static Public Member Functions

static Standard_Boolean FindColor (const Standard_Real Value, const Standard_Real Min, const Standard_Real Max, const Standard_Integer ColorsCount, Quantity_Color &Color)

Protected Member Functions

 Aspect_ColorScale ()
void SizeHint (Standard_Integer &aWidth, Standard_Integer &aHeight) const
virtual void UpdateColorScale ()
void DrawScale (const Quantity_Color &aBgColor, const Standard_Integer X, const Standard_Integer Y, const Standard_Integer W, const Standard_Integer H)
virtual Standard_Boolean BeginPaint ()
virtual Standard_Boolean EndPaint ()

Constructor & Destructor Documentation

Aspect_ColorScale::Aspect_ColorScale ( ) [protected]

Member Function Documentation

virtual Standard_Boolean Aspect_ColorScale::BeginPaint ( ) [protected, virtual]
void Aspect_ColorScale::DrawScale ( const Quantity_Color aBgColor,
const Standard_Integer  X,
const Standard_Integer  Y,
const Standard_Integer  W,
const Standard_Integer  H 
) [protected]
virtual Standard_Boolean Aspect_ColorScale::EndPaint ( ) [protected, virtual]
static Standard_Boolean Aspect_ColorScale::FindColor ( const Standard_Real  Value,
const Standard_Real  Min,
const Standard_Real  Max,
const Standard_Integer  ColorsCount,
Quantity_Color Color 
) [static]
Standard_Boolean Aspect_ColorScale::FindColor ( const Standard_Real  Value,
Quantity_Color Color 
) const
Quantity_Color Aspect_ColorScale::GetColor ( const Standard_Integer  anIndex) const
void Aspect_ColorScale::GetColors ( Aspect_SequenceOfColor aColors) const
Aspect_TypeOfColorScaleData Aspect_ColorScale::GetColorType ( ) const
TCollection_AsciiString Aspect_ColorScale::GetFormat ( ) const
Standard_Real Aspect_ColorScale::GetHeight ( ) const
TCollection_ExtendedString Aspect_ColorScale::GetLabel ( const Standard_Integer  anIndex) const
Aspect_TypeOfColorScalePosition Aspect_ColorScale::GetLabelPosition ( ) const
void Aspect_ColorScale::GetLabels ( TColStd_SequenceOfExtendedString aLabels) const
Aspect_TypeOfColorScaleData Aspect_ColorScale::GetLabelType ( ) const
Standard_Real Aspect_ColorScale::GetMax ( ) const
Standard_Real Aspect_ColorScale::GetMin ( ) const
Standard_Integer Aspect_ColorScale::GetNumberOfIntervals ( ) const
void Aspect_ColorScale::GetPosition ( Standard_Real aX,
Standard_Real aY 
) const
void Aspect_ColorScale::GetRange ( Standard_Real aMin,
Standard_Real aMax 
) const
void Aspect_ColorScale::GetSize ( Standard_Real aWidth,
Standard_Real aHeight 
) const
Standard_Integer Aspect_ColorScale::GetTextHeight ( ) const
TCollection_ExtendedString Aspect_ColorScale::GetTitle ( ) const
Aspect_TypeOfColorScalePosition Aspect_ColorScale::GetTitlePosition ( ) const
Standard_Real Aspect_ColorScale::GetWidth ( ) const
Standard_Real Aspect_ColorScale::GetXPosition ( ) const
Standard_Real Aspect_ColorScale::GetYPosition ( ) const
Standard_Boolean Aspect_ColorScale::IsLabelAtBorder ( ) const
Standard_Boolean Aspect_ColorScale::IsReversed ( ) const
virtual void Aspect_ColorScale::PaintRect ( const Standard_Integer  X,
const Standard_Integer  Y,
const Standard_Integer  W,
const Standard_Integer  H,
const Quantity_Color aColor,
const Standard_Boolean  aFilled = Standard_False 
) [pure virtual]

Implemented in V3d_ColorScale.

virtual void Aspect_ColorScale::PaintText ( const TCollection_ExtendedString aText,
const Standard_Integer  X,
const Standard_Integer  Y,
const Quantity_Color aColor 
) [pure virtual]

Implemented in V3d_ColorScale.

void Aspect_ColorScale::SetColor ( const Quantity_Color aColor,
const Standard_Integer  anIndex = -1 
)
void Aspect_ColorScale::SetColors ( const Handle< Aspect_ColorMap > &  aMap)
void Aspect_ColorScale::SetColors ( const Aspect_SequenceOfColor aSeq)
void Aspect_ColorScale::SetColorType ( const Aspect_TypeOfColorScaleData  aType)
void Aspect_ColorScale::SetFormat ( const TCollection_AsciiString aFormat)
void Aspect_ColorScale::SetHeight ( const Standard_Real  aHeight)
void Aspect_ColorScale::SetLabel ( const TCollection_ExtendedString aLabel,
const Standard_Integer  anIndex = -1 
)
void Aspect_ColorScale::SetLabelAtBorder ( const Standard_Boolean  anOn)
void Aspect_ColorScale::SetLabelPosition ( const Aspect_TypeOfColorScalePosition  aPos)
void Aspect_ColorScale::SetLabels ( const TColStd_SequenceOfExtendedString aSeq)
void Aspect_ColorScale::SetLabelType ( const Aspect_TypeOfColorScaleData  aType)
void Aspect_ColorScale::SetMax ( const Standard_Real  aMax)
void Aspect_ColorScale::SetMin ( const Standard_Real  aMin)
void Aspect_ColorScale::SetNumberOfIntervals ( const Standard_Integer  aNum)
void Aspect_ColorScale::SetPosition ( const Standard_Real  aX,
const Standard_Real  aY 
)
void Aspect_ColorScale::SetRange ( const Standard_Real  aMin,
const Standard_Real  aMax 
)
void Aspect_ColorScale::SetReversed ( const Standard_Boolean  aReverse)
void Aspect_ColorScale::SetSize ( const Standard_Real  aWidth,
const Standard_Real  aHeight 
)
void Aspect_ColorScale::SetTextHeight ( const Standard_Integer  aHeigh)
void Aspect_ColorScale::SetTitle ( const TCollection_ExtendedString aTitle)
void Aspect_ColorScale::SetTitlePosition ( const Aspect_TypeOfColorScalePosition  aPos)
void Aspect_ColorScale::SetWidth ( const Standard_Real  aWidth)
void Aspect_ColorScale::SetXPosition ( const Standard_Real  aX)
void Aspect_ColorScale::SetYPosition ( const Standard_Real  aY)
void Aspect_ColorScale::SizeHint ( Standard_Integer aWidth,
Standard_Integer aHeight 
) const [protected]
virtual Standard_Integer Aspect_ColorScale::TextHeight ( const TCollection_ExtendedString aText) const [pure virtual]

Implemented in V3d_ColorScale.

virtual Standard_Integer Aspect_ColorScale::TextWidth ( const TCollection_ExtendedString aText) const [pure virtual]

Implemented in V3d_ColorScale.

virtual void Aspect_ColorScale::UpdateColorScale ( ) [protected, virtual]

Reimplemented in V3d_ColorScale.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines