Open CASCADE Technology  6.9.0
Public Member Functions | Protected Member Functions

V3d_ColorScale Class Reference

A colorscale class. More...

#include <V3d_ColorScale.hxx>

Inheritance diagram for V3d_ColorScale:
Inheritance graph
[legend]

Public Member Functions

 V3d_ColorScale (const Handle< V3d_LayerMgr > &theMgr)
 Returns returns ColorScale from V3d. Returns View from V3d. More...
 
void Display ()
 
void Erase ()
 
Standard_Boolean IsDisplayed () const
 
virtual void PaintRect (const Standard_Integer theX, const Standard_Integer theY, const Standard_Integer theWidth, const Standard_Integer theHeight, const Quantity_Color &theColor, const Standard_Boolean theFilled=Standard_False)
 Draws a rectangle. More...
 
virtual void PaintText (const TCollection_ExtendedString &theText, const Standard_Integer theX, const Standard_Integer theY, const Quantity_Color &theColor)
 Draws a text. More...
 
virtual Standard_Integer TextWidth (const TCollection_ExtendedString &theText) const
 Returns the width of text. More...
 
virtual Standard_Integer TextHeight (const TCollection_ExtendedString &theText) const
 Returns the height of text. More...
 
void TextSize (const TCollection_ExtendedString &theText, const Standard_Integer theHeight, Standard_Integer &theWidth, Standard_Integer &theAscent, Standard_Integer &theDescent) const
 
void DrawScale ()
 
- Public Member Functions inherited from Aspect_ColorScale
Standard_Boolean FindColor (const Standard_Real theValue, Quantity_Color &theColor) const
 Calculate color according passed value; returns true if value is in range or false, if isn't. More...
 
Standard_Real GetMin () const
 Returns minimal value of color scale;. More...
 
Standard_Real GetMax () const
 Returns maximal value of color scale;. More...
 
void GetRange (Standard_Real &theMin, Standard_Real &theMax) const
 Returns minimal and maximal values of color scale;. More...
 
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. More...
 
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. More...
 
Standard_Integer GetNumberOfIntervals () const
 Returns the number of color scale intervals;. More...
 
TCollection_ExtendedString GetTitle () const
 Returns the color scale title string;. More...
 
TCollection_AsciiString GetFormat () const
 Returns the format for numbers. The same like format for function printf(). Used if GetLabelType() is TOCSD_AUTO;. More...
 
TCollection_ExtendedString GetLabel (const Standard_Integer theIndex) const
 Returns the user specified label with index <anIndex>. Returns empty string if label not defined. More...
 
Quantity_Color GetColor (const Standard_Integer theIndex) const
 Returns the user specified color from color map with index <anIndex>. Returns default color if index out of range in color map. More...
 
void GetLabels (TColStd_SequenceOfExtendedString &theLabels) const
 Returns the user specified labels. More...
 
void GetColors (Aspect_SequenceOfColor &theColors) const
 Returns the user specified colors. More...
 
Aspect_TypeOfColorScalePosition GetLabelPosition () const
 Returns the position of labels concerning color filled rectangles. More...
 
Aspect_TypeOfColorScalePosition GetTitlePosition () const
 Returns the position of color scale title. More...
 
Standard_Boolean IsReversed () const
 Returns true if the labels and colors used in reversed order. More...
 
Standard_Boolean IsLabelAtBorder () const
 Returns true if the labels placed at border of color filled rectangles. More...
 
void SetMin (const Standard_Real theMin)
 Sets the minimal value of color scale. More...
 
void SetMax (const Standard_Real theMax)
 Sets the maximal value of color scale. More...
 
void SetRange (const Standard_Real theMin, const Standard_Real theMax)
 Sets the minimal and maximal value of color scale. More...
 
void SetLabelType (const Aspect_TypeOfColorScaleData theType)
 Sets the type of labels. Aspect_TOCSD_AUTO - labels as boundary values for intervals Aspect_TOCSD_USER - user specified label is used. More...
 
void SetColorType (const Aspect_TypeOfColorScaleData theType)
 Sets the type of colors. Aspect_TOCSD_AUTO - value between Red and Blue Aspect_TOCSD_USER - user specified color from color map. More...
 
void SetNumberOfIntervals (const Standard_Integer theNum)
 Sets the number of color scale intervals. More...
 
void SetTitle (const TCollection_ExtendedString &theTitle)
 Sets the color scale title string. More...
 
void SetFormat (const TCollection_AsciiString &theFormat)
 Sets the color scale auto label format specification. More...
 
void SetLabel (const TCollection_ExtendedString &theLabel, const Standard_Integer anIndex=-1)
 Sets the color scale label at index. Index started from 1. More...
 
void SetColor (const Quantity_Color &theColor, const Standard_Integer theIndex=-1)
 Sets the color scale color at index. Index started from 1. More...
 
void SetLabels (const TColStd_SequenceOfExtendedString &theSeq)
 Sets the color scale labels. More...
 
void SetColors (const Aspect_SequenceOfColor &theSeq)
 Sets the color scale colors. More...
 
void SetLabelPosition (const Aspect_TypeOfColorScalePosition thePos)
 Sets the color scale labels position concerning color filled rectangles. More...
 
void SetTitlePosition (const Aspect_TypeOfColorScalePosition thePos)
 Sets the color scale title position. More...
 
void SetReversed (const Standard_Boolean theReverse)
 Sets true if the labels and colors used in reversed order. More...
 
void SetLabelAtBorder (const Standard_Boolean theOn)
 Sets true if the labels placed at border of color filled rectangles. More...
 
void GetSize (Standard_Real &theWidth, Standard_Real &theHeight) const
 Returns the size of color scale. More...
 
Standard_Real GetWidth () const
 Returns the width of color scale. More...
 
Standard_Real GetHeight () const
 Returns the height of color scale. More...
 
void SetSize (const Standard_Real theWidth, const Standard_Real theHeight)
 Sets the size of color scale. More...
 
void SetWidth (const Standard_Real theWidth)
 Sets the width of color scale. More...
 
void SetHeight (const Standard_Real theHeight)
 Sets the height of color scale. More...
 
void GetPosition (Standard_Real &theX, Standard_Real &theY) const
 Returns the position of color scale. More...
 
Standard_Real GetXPosition () const
 Returns the X position of color scale. More...
 
Standard_Real GetYPosition () const
 Returns the height of color scale. More...
 
void SetPosition (const Standard_Real theX, const Standard_Real theY)
 Sets the position of color scale. More...
 
void SetXPosition (const Standard_Real theX)
 Sets the X position of color scale. More...
 
void SetYPosition (const Standard_Real theY)
 Sets the Y position of color scale. More...
 
Standard_Integer GetTextHeight () const
 Returns the height of text of color scale. More...
 
void SetTextHeight (const Standard_Integer theHeight)
 Sets the height of text of color scale. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const Handle_Standard_Type &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Protected Member Functions

virtual void UpdateColorScale ()
 updates color scale parameters. More...
 
- Protected Member Functions inherited from Aspect_ColorScale
 Aspect_ColorScale ()
 Default constructor. More...
 
void SizeHint (Standard_Integer &theWidth, Standard_Integer &theHeight) const
 Returns the size of color scale. More...
 
void DrawScale (const Quantity_Color &theBgColor, const Standard_Integer theX, const Standard_Integer theY, const Standard_Integer theWidth, const Standard_Integer theHeight)
 Draws color scale. More...
 
virtual Standard_Boolean BeginPaint ()
 
virtual Standard_Boolean EndPaint ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Aspect_ColorScale
static Standard_Boolean FindColor (const Standard_Real theValue, const Standard_Real theMin, const Standard_Real theMax, const Standard_Integer theColorsCount, Quantity_Color &theColor)
 

Detailed Description

A colorscale class.

Constructor & Destructor Documentation

V3d_ColorScale::V3d_ColorScale ( const Handle< V3d_LayerMgr > &  theMgr)

Returns returns ColorScale from V3d. Returns View from V3d.

Member Function Documentation

void V3d_ColorScale::Display ( )
void V3d_ColorScale::DrawScale ( )
void V3d_ColorScale::Erase ( )
Standard_Boolean V3d_ColorScale::IsDisplayed ( ) const
virtual void V3d_ColorScale::PaintRect ( const Standard_Integer  theX,
const Standard_Integer  theY,
const Standard_Integer  theWidth,
const Standard_Integer  theHeight,
const Quantity_Color theColor,
const Standard_Boolean  theFilled = Standard_False 
)
virtual

Draws a rectangle.

Parameters
theX[in] the X coordinate of rectangle position.
theY[in] the Y coordinate of rectangle position.
theWidth[in] the width of rectangle.
theHeight[in] the height of rectangle.
theColor[in] the color of rectangle.
theFilled[in] defines if rectangle must be filled.

Implements Aspect_ColorScale.

virtual void V3d_ColorScale::PaintText ( const TCollection_ExtendedString theText,
const Standard_Integer  theX,
const Standard_Integer  theY,
const Quantity_Color theColor 
)
virtual

Draws a text.

Parameters
theText[in] the text to draw.
theX[in] the X coordinate of text position.
theY[in] the Y coordinate of text position.
theColor[in] the color of text.

Implements Aspect_ColorScale.

virtual Standard_Integer V3d_ColorScale::TextHeight ( const TCollection_ExtendedString theText) const
virtual

Returns the height of text.

Parameters
theText[in] the text of which to calculate height.

Implements Aspect_ColorScale.

void V3d_ColorScale::TextSize ( const TCollection_ExtendedString theText,
const Standard_Integer  theHeight,
Standard_Integer theWidth,
Standard_Integer theAscent,
Standard_Integer theDescent 
) const
virtual Standard_Integer V3d_ColorScale::TextWidth ( const TCollection_ExtendedString theText) const
virtual

Returns the width of text.

Parameters
theText[in] the text of which to calculate width.

Implements Aspect_ColorScale.

virtual void V3d_ColorScale::UpdateColorScale ( )
protectedvirtual

updates color scale parameters.

Reimplemented from Aspect_ColorScale.


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