Open CASCADE Technology  7.3.1.dev
Public Member Functions | Static Public Member Functions
AIS_ColorScale Class Reference

Class for drawing a custom color scale. More...

#include <AIS_ColorScale.hxx>

Inheritance diagram for AIS_ColorScale:
Inheritance graph
[legend]

Public Member Functions

 AIS_ColorScale ()
 Default constructor. More...
 
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, 0.0 by default. More...
 
void SetMin (const Standard_Real theMin)
 Sets the minimal value of color scale. More...
 
Standard_Real GetMax () const
 Returns maximal value of color scale, 1.0 by default. More...
 
void SetMax (const Standard_Real theMax)
 Sets the maximal value of color scale. More...
 
void GetRange (Standard_Real &theMin, Standard_Real &theMax) const
 Returns minimal and maximal values of color scale, 0.0 to 1.0 by default. More...
 
void SetRange (const Standard_Real theMin, const Standard_Real theMax)
 Sets the minimal and maximal value of color scale. Note that values order will be ignored - the minimum and maximum values will be swapped if needed. ::SetReversed() should be called to swap displaying order. More...
 
Standard_Real HueMin () const
 Returns the hue angle corresponding to minimum value, 230 by default (blue). More...
 
Standard_Real HueMax () const
 Returns the hue angle corresponding to maximum value, 0 by default (red). More...
 
void HueRange (Standard_Real &theMinAngle, Standard_Real &theMaxAngle) const
 Returns the hue angle range corresponding to minimum and maximum values, 230 to 0 by default (blue to red). More...
 
void SetHueRange (const Standard_Real theMinAngle, const Standard_Real theMaxAngle)
 Sets hue angle range corresponding to minimum and maximum values. The valid angle range is [0, 360], see Quantity_Color and Quantity_TOC_HLS for more details. More...
 
void ColorRange (Quantity_Color &theMinColor, Quantity_Color &theMaxColor) const
 Returns color range corresponding to minimum and maximum values, blue to red by default. More...
 
void SetColorRange (const Quantity_Color &theMinColor, const Quantity_Color &theMaxColor)
 Sets color range corresponding to minimum and maximum values. More...
 
Aspect_TypeOfColorScaleData GetLabelType () const
 Returns the type of labels, Aspect_TOCSD_AUTO by default. Aspect_TOCSD_AUTO - labels as boundary values for intervals Aspect_TOCSD_USER - user specified label is used. 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...
 
Aspect_TypeOfColorScaleData GetColorType () const
 Returns the type of colors, Aspect_TOCSD_AUTO by default. Aspect_TOCSD_AUTO - value between Red and Blue Aspect_TOCSD_USER - user specified color from color map. 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...
 
Standard_Integer GetNumberOfIntervals () const
 Returns the number of color scale intervals, 10 by default. More...
 
void SetNumberOfIntervals (const Standard_Integer theNum)
 Sets the number of color scale intervals. More...
 
const TCollection_ExtendedStringGetTitle () const
 Returns the color scale title string, empty string by default. More...
 
void SetTitle (const TCollection_ExtendedString &theTitle)
 Sets the color scale title string. More...
 
const TCollection_AsciiStringGetFormat () const
 Returns the format for numbers, "%.4g" by default. The same like format for function printf(). Used if GetLabelType() is TOCSD_AUTO;. More...
 
const TCollection_AsciiStringFormat () const
 Returns the format of text. More...
 
void SetFormat (const TCollection_AsciiString &theFormat)
 Sets the color scale auto label format specification. More...
 
TCollection_ExtendedString GetLabel (const Standard_Integer theIndex) const
 Returns the user specified label with index theIndex. Index is in range from 1 to GetNumberOfIntervals() or to GetNumberOfIntervals() + 1 if IsLabelAtBorder() is true. Returns empty string if label not defined. More...
 
Quantity_Color GetIntervalColor (const Standard_Integer theIndex) const
 Returns the user specified color from color map with index (starts at 1). Returns default color if index is out of range in color map. More...
 
void SetIntervalColor (const Quantity_Color &theColor, const Standard_Integer theIndex)
 Sets the color of the specified interval. Note that list is automatically resized to include specified index. More...
 
void GetLabels (TColStd_SequenceOfExtendedString &theLabels) const
 Returns the user specified labels. More...
 
const TColStd_SequenceOfExtendedStringLabels () const
 Returns the user specified labels. More...
 
void SetLabels (const TColStd_SequenceOfExtendedString &theSeq)
 Sets the color scale labels. The length of the sequence should be equal to GetNumberOfIntervals() or to GetNumberOfIntervals() + 1 if IsLabelAtBorder() is true. If length of the sequence does not much the number of intervals, then these labels will be considered as "free" and will be located at the virtual intervals corresponding to the number of labels (with flag IsLabelAtBorder() having the same effect as in normal case). More...
 
void GetColors (Aspect_SequenceOfColor &theColors) const
 Returns the user specified colors. More...
 
const Aspect_SequenceOfColorGetColors () const
 Returns the user specified colors. More...
 
void SetColors (const Aspect_SequenceOfColor &theSeq)
 Sets the color scale colors. The length of the sequence should be equal to GetNumberOfIntervals(). More...
 
Aspect_TypeOfColorScalePosition GetLabelPosition () const
 Returns the position of labels concerning color filled rectangles, Aspect_TOCSP_RIGHT by default. More...
 
void SetLabelPosition (const Aspect_TypeOfColorScalePosition thePos)
 Sets the color scale labels position relative to color bar. More...
 
Aspect_TypeOfColorScalePosition GetTitlePosition () const
 Returns the position of color scale title, Aspect_TOCSP_LEFT by default. More...
 
void SetTitlePosition (const Aspect_TypeOfColorScalePosition thePos)
 Sets the color scale title position. More...
 
Standard_Boolean IsReversed () const
 Returns TRUE if the labels and colors used in reversed order, FALSE by default. More...
 
void SetReversed (const Standard_Boolean theReverse)
 Sets true if the labels and colors used in reversed order. More...
 
Standard_Boolean IsSmoothTransition () const
 Return TRUE if color transition between neighbor intervals should be linearly interpolated, FALSE by default. More...
 
void SetSmoothTransition (const Standard_Boolean theIsSmooth)
 Setup smooth color transition. More...
 
Standard_Boolean IsLabelAtBorder () const
 Returns TRUE if the labels are placed at border of color intervals, TRUE by default. The automatically generated label will show value exactly on the current position: More...
 
void SetLabelAtBorder (const Standard_Boolean theOn)
 Sets true if the labels are placed at border of color intervals (TRUE by default). If set to False, labels will be drawn at color intervals rather than at borders. More...
 
Standard_Boolean IsLogarithmic () const
 Returns TRUE if the color scale has logarithmic intervals, FALSE by default. More...
 
void SetLogarithmic (const Standard_Boolean isLogarithmic)
 Sets true if the color scale has logarithmic intervals. More...
 
void SetLabel (const TCollection_ExtendedString &theLabel, const Standard_Integer theIndex)
 Sets the color scale label at index. Note that list is automatically resized to include specified index. More...
 
void GetSize (Standard_Integer &theBreadth, Standard_Integer &theHeight) const
 Returns the size of color bar, 0 and 0 by default (e.g. should be set by user explicitly before displaying). More...
 
void SetSize (const Standard_Integer theBreadth, const Standard_Integer theHeight)
 Sets the size of color bar. More...
 
Standard_Integer GetBreadth () const
 Returns the breadth of color bar, 0 by default (e.g. should be set by user explicitly before displaying). More...
 
void SetBreadth (const Standard_Integer theBreadth)
 Sets the width of color bar. More...
 
Standard_Integer GetHeight () const
 Returns the height of color bar, 0 by default (e.g. should be set by user explicitly before displaying). More...
 
void SetHeight (const Standard_Integer theHeight)
 Sets the height of color bar. More...
 
void GetPosition (Standard_Real &theX, Standard_Real &theY) const
 Returns the bottom-left position of color scale, 0x0 by default. More...
 
void SetPosition (const Standard_Integer theX, const Standard_Integer theY)
 Sets the position of color scale. More...
 
Standard_Integer GetXPosition () const
 Returns the left position of color scale, 0 by default. More...
 
void SetXPosition (const Standard_Integer theX)
 Sets the left position of color scale. More...
 
Standard_Integer GetYPosition () const
 Returns the bottom position of color scale, 0 by default. More...
 
void SetYPosition (const Standard_Integer theY)
 Sets the bottom position of color scale. More...
 
Standard_Integer GetTextHeight () const
 Returns the font height of text labels, 20 by default. More...
 
void SetTextHeight (const Standard_Integer theHeight)
 Sets the height of text of color scale. More...
 
Standard_Integer TextWidth (const TCollection_ExtendedString &theText) const
 Returns the width of text. More...
 
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
 
virtual Standard_Boolean AcceptDisplayMode (const Standard_Integer theMode) const override
 Return true if specified display mode is supported. More...
 
virtual void Compute (const Handle< PrsMgr_PresentationManager3d > &thePresentationManager, const Handle< Prs3d_Presentation > &thePresentation, const Standard_Integer theMode) override
 Compute presentation. More...
 
virtual void ComputeSelection (const Handle< SelectMgr_Selection > &, const Standard_Integer) override
 Compute selection - not implemented for color scale. More...
 
- Public Member Functions inherited from AIS_InteractiveObject
virtual AIS_KindOfInteractive Type () const
 Returns the kind of Interactive Object; AIS_KOI_None by default. More...
 
virtual Standard_Integer Signature () const
 Specifies additional characteristics of Interactive Object of Type(); -1 by default. Among the datums, this signature is attributed to the shape. The remaining datums have the following default signatures: More...
 
void Redisplay (const Standard_Boolean AllModes=Standard_False)
 Updates the active presentation; if <AllModes> = Standard_True all the presentations inside are recomputed. IMPORTANT: It is preferable to call Redisplay method of corresponding AIS_InteractiveContext instance for cases when it is accessible. This method just redirects call to myCTXPtr, so this class field must be up to date for proper result. More...
 
Standard_Boolean HasInteractiveContext () const
 Indicates whether the Interactive Object has a pointer to an interactive context. More...
 
AIS_InteractiveContextInteractiveContext () const
 Returns the context pointer to the interactive context. More...
 
virtual void SetContext (const Handle< AIS_InteractiveContext > &aCtx)
 Sets the interactive context aCtx and provides a link to the default drawing tool or "Drawer" if there is none. More...
 
Standard_Boolean HasOwner () const
 Returns true if the object has an owner attributed to it. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient. More...
 
const Handle< Standard_Transient > & GetOwner () const
 Returns the owner of the Interactive Object. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient. There are two types of owners: More...
 
void SetOwner (const Handle< Standard_Transient > &theApplicativeEntity)
 Allows you to attribute the owner theApplicativeEntity to an Interactive Object. This can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of. The owner takes the form of a transient. More...
 
void ClearOwner ()
 Each Interactive Object has methods which allow us to attribute an Owner to it in the form of a Transient. This method removes the owner from the graphic entity. More...
 
Handle< AIS_InteractiveContextGetContext () const
 Returns the context pointer to the interactive context. More...
 
Standard_Boolean HasPresentation () const
 Returns TRUE when this object has a presentation in the current DisplayMode() More...
 
Handle< Prs3d_PresentationPresentation () const
 Returns the current presentation of this object according to the current DisplayMode() More...
 
void SetAspect (const Handle< Prs3d_BasicAspect > &anAspect)
 Sets the graphic basic aspect to the current presentation. More...
 
- Public Member Functions inherited from SelectMgr_SelectableObject
virtual ~SelectMgr_SelectableObject ()
 Clears all selections of the object. More...
 
virtual Standard_Boolean AcceptShapeDecomposition () const
 Informs the graphic context that the interactive Object may be decomposed into sub-shapes for dynamic selection. The most used Interactive Object is AIS_Shape. More...
 
void RecomputePrimitives ()
 Re-computes the sensitive primitives for all modes. IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! This method does not take into account necessary BVH updates, but may invalidate the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection. More...
 
void RecomputePrimitives (const Standard_Integer theMode)
 Re-computes the sensitive primitives which correspond to the <theMode>th selection mode. IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! selection manager! This method does not take into account necessary BVH updates, but may invalidate the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection. More...
 
void AddSelection (const Handle< SelectMgr_Selection > &aSelection, const Standard_Integer aMode)
 Adds the selection aSelection with the selection mode index aMode to this framework. More...
 
void ClearSelections (const Standard_Boolean update=Standard_False)
 Empties all the selections in the SelectableObject <update> parameter defines whether all object's selections should be flagged for further update or not. This improved method can be used to recompute an object's selection (without redisplaying the object completely) when some selection mode is activated not for the first time. More...
 
const Handle< SelectMgr_Selection > & Selection (const Standard_Integer theMode) const
 Returns the selection having specified selection mode or NULL. More...
 
Standard_Boolean HasSelection (const Standard_Integer theMode) const
 Returns true if a selection corresponding to the selection mode theMode was computed for this object. More...
 
const SelectMgr_SequenceOfSelectionSelections () const
 Return the sequence of selections. More...
 
void ResetTransformation () override
 resets local transformation to identity. More...
 
virtual void UpdateTransformation () override
 Recomputes the location of the selection aSelection. More...
 
virtual void UpdateTransformations (const Handle< SelectMgr_Selection > &aSelection)
 Updates locations in all sensitive entities from <aSelection> and in corresponding entity owners. More...
 
virtual void HilightSelected (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const SelectMgr_SequenceOfOwner &theSeq)
 Method which draws selected owners ( for fast presentation draw ) More...
 
virtual void ClearSelected ()
 Method which clear all selected owners belonging to this selectable object ( for fast presentation draw ) More...
 
virtual void ClearDynamicHighlight (const Handle< PrsMgr_PresentationManager > &theMgr)
 Method that needs to be implemented when the object manages selection and dynamic highlighting on its own. Clears or invalidates dynamic highlight presentation. By default it clears immediate draw of given presentation manager. More...
 
virtual void HilightOwnerWithColor (const Handle< PrsMgr_PresentationManager > &thePM, const Handle< Prs3d_Drawer > &theStyle, const Handle< SelectMgr_EntityOwner > &theOwner)
 Method which hilight an owner belonging to this selectable object ( for fast presentation draw ) More...
 
virtual Standard_Boolean IsAutoHilight () const
 If returns True, the old mechanism for highlighting selected objects is used (HilightSelected Method may be empty). If returns False, the HilightSelected method will be fully responsible for highlighting selected entity owners belonging to this selectable object. More...
 
virtual void SetAutoHilight (const Standard_Boolean theAutoHilight)
 Set AutoHilight property to true or false. More...
 
Handle< Prs3d_PresentationGetHilightPresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr)
 Creates or returns existing presentation for highlighting detected object. More...
 
Handle< Prs3d_PresentationGetSelectPresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr)
 Creates or returns existing presentation for highlighting selected object. More...
 
virtual void ErasePresentations (Standard_Boolean theToRemove)
 Removes presentations returned by GetHilightPresentation() and GetSelectPresentation(). More...
 
virtual void SetZLayer (const Graphic3d_ZLayerId theLayerId) override
 Set Z layer ID and update all presentations of the selectable object. The layers mechanism allows drawing objects in higher layers in overlay of objects in lower layers. More...
 
void UpdateSelection (const Standard_Integer theMode=-1)
 Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection from outer classes to prevent BVH structures from being outdated. More...
 
void SetAssemblyOwner (const Handle< SelectMgr_EntityOwner > &theOwner, const Standard_Integer theMode=-1)
 Sets common entity owner for assembly sensitive object entities. More...
 
Bnd_Box BndBoxOfSelected (const Handle< SelectMgr_IndexedMapOfOwner > &theOwners)
 Returns a bounding box of sensitive entities with the owners given if they are a part of activated selection. More...
 
Standard_Integer GlobalSelectionMode () const
 Returns the mode for selection of object as a whole; 0 by default. More...
 
virtual Handle< SelectMgr_EntityOwnerGlobalSelOwner () const
 Returns the owner of mode for selection of object as a whole. More...
 
virtual const Handle< SelectMgr_EntityOwner > & GetAssemblyOwner () const
 Returns common entity owner if the object is an assembly. More...
 
void Init ()
 Begins the iteration scanning for sensitive primitives. More...
 
Standard_Boolean More () const
 Continues the iteration scanning for sensitive primitives. More...
 
void Next ()
 Continues the iteration scanning for sensitive primitives. More...
 
const Handle< SelectMgr_Selection > & CurrentSelection () const
 Returns the current selection in this framework. More...
 
- Public Member Functions inherited from PrsMgr_PresentableObject
PrsMgr_PresentationsPresentations ()
 Return presentations. More...
 
Graphic3d_ZLayerId ZLayer () const
 Get ID of Z layer for main presentation. More...
 
Standard_Boolean IsMutable () const
 Returns true if object has mutable nature (content or location are be changed regularly). Mutable object will be managed in different way than static onces (another optimizations). More...
 
virtual void SetMutable (const Standard_Boolean theIsMutable)
 Sets if the object has mutable nature (content or location will be changed regularly). This method should be called before object displaying to take effect. More...
 
Standard_Boolean HasDisplayMode () const
 Returns true if the Interactive Object has display mode setting overriding global setting (within Interactive Context). More...
 
Standard_Integer DisplayMode () const
 Returns the display mode setting of the Interactive Object. The range of supported display mode indexes should be specified within object definition and filtered by AccepDisplayMode(). More...
 
void SetDisplayMode (const Standard_Integer theMode)
 Sets the display mode for the interactive object. An object can have its own temporary display mode, which is different from that proposed by the interactive context. More...
 
void UnsetDisplayMode ()
 Removes display mode settings from the interactive object. More...
 
Standard_Boolean HasHilightMode () const
 Returns true if the Interactive Object is in highlight mode. More...
 
Standard_Integer HilightMode () const
 Returns highlight display mode. This is obsolete method for backward compatibility - use ::HilightAttributes() and ::DynamicHilightAttributes() instead. More...
 
void SetHilightMode (const Standard_Integer theMode)
 Sets highlight display mode. This is obsolete method for backward compatibility - use ::HilightAttributes() and ::DynamicHilightAttributes() instead. More...
 
void UnsetHilightMode ()
 Unsets highlight display mode. More...
 
virtual Standard_Integer DefaultDisplayMode () const
 Returns the default display mode. More...
 
Standard_Boolean ToBeUpdated (Standard_Boolean theToIncludeHidden=Standard_False) const
 Returns TRUE if any active presentation has invalidation flag. More...
 
void SetToUpdate (Standard_Integer theMode)
 Flags presentation to be updated; UpdatePresentations() will recompute these presentations. More...
 
void SetToUpdate ()
 flags all the Presentations to be Updated. More...
 
Standard_Boolean IsInfinite () const
 Returns true if the interactive object is infinite; FALSE by default. This flag affects various operations operating on bounding box of graphic presentations of this object. For instance, infinite objects are not taken in account for View FitAll. This does not necessarily means that object is actually infinite, auxiliary objects might be also marked with this flag to achieve desired behavior. More...
 
void SetInfiniteState (const Standard_Boolean theFlag=Standard_True)
 Sets if object should be considered as infinite. More...
 
PrsMgr_TypeOfPresentation3d TypeOfPresentation3d () const
 Returns information on whether the object accepts display in HLR mode or not. More...
 
void SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d theType)
 Set type of presentation. More...
 
const Handle< Prs3d_Drawer > & Attributes () const
 Returns the attributes settings. More...
 
virtual void SetAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Initializes the drawing tool theDrawer. More...
 
const Handle< Prs3d_Drawer > & HilightAttributes () const
 Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalSelected and Prs3d_TypeOfHighlight_Selected defined within AIS_InteractiveContext. More...
 
virtual void SetHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Initializes the hilight drawing tool theDrawer. More...
 
const Handle< Prs3d_Drawer > & DynamicHilightAttributes () const
 Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalDynamic and Prs3d_TypeOfHighlight_Dynamic defined within AIS_InteractiveContext. More...
 
virtual void SetDynamicHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Initializes the dynamic hilight drawing tool. More...
 
virtual void UnsetHilightAttributes ()
 Clears settings provided by the hilight drawing tool theDrawer. More...
 
void SynchronizeAspects ()
 Synchronize presentation aspects after their modification. More...
 
const Handle< Graphic3d_TransformPers > & TransformPersistence () const
 Returns Transformation Persistence defining a special Local Coordinate system where this presentable object is located or NULL handle if not defined. Position of the object having Transformation Persistence is mutable and depends on camera position. The same applies to a bounding box of the object. More...
 
virtual void SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers)
 Sets up Transform Persistence defining a special Local Coordinate system where this object should be located. Note that management of Transform Persistence object is more expensive than of the normal one, because it requires its position being recomputed basing on camera position within each draw call / traverse. More...
 
const Handle< Geom_Transformation > & LocalTransformationGeom () const
 Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence. More...
 
void SetLocalTransformation (const gp_Trsf &theTrsf)
 Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence. More...
 
void SetLocalTransformation (const Handle< Geom_Transformation > &theTrsf)
 Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence. More...
 
Standard_Boolean HasTransformation () const
 Returns true if object has a transformation that is different from the identity. More...
 
const Handle< Geom_Transformation > & TransformationGeom () const
 Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence. More...
 
const gp_TrsfLocalTransformation () const
 Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence. More...
 
const gp_TrsfTransformation () const
 Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence. More...
 
const gp_GTrsfInversedTransformation () const
 Return inversed transformation. More...
 
const Handle< Geom_Transformation > & CombinedParentTransformation () const
 Return combined parent transformation. More...
 
const Handle< Graphic3d_SequenceOfHClipPlane > & ClipPlanes () const
 Get clip planes. More...
 
virtual void SetClipPlanes (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes)
 Set clip planes for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes. More...
 
virtual void AddClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane)
 Adds clip plane for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes. More...
 
virtual void RemoveClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane)
 Removes previously added clip plane. More...
 
PrsMgr_PresentableObjectParent () const
 Returns parent of current object in scene hierarchy. More...
 
const PrsMgr_ListOfPresentableObjectsChildren () const
 Returns children of the current object. More...
 
virtual void AddChild (const Handle< PrsMgr_PresentableObject > &theObject)
 Makes theObject child of current object in scene hierarchy. More...
 
void AddChildWithCurrentTransformation (const Handle< PrsMgr_PresentableObject > &theObject)
 Makes theObject child of current object in scene hierarchy with keeping the current global transformation So the object keeps the same position/orientation in the global CS. More...
 
virtual void RemoveChild (const Handle< PrsMgr_PresentableObject > &theObject)
 Removes theObject from children of current object in scene hierarchy. More...
 
void RemoveChildWithRestoreTransformation (const Handle< PrsMgr_PresentableObject > &theObject)
 Removes theObject from children of current object in scene hierarchy with keeping the current global transformation. So the object keeps the same position/orientation in the global CS. More...
 
Standard_Boolean HasOwnPresentations () const
 Returns true if object should have own presentations. More...
 
virtual void BoundingBox (Bnd_Box &theBndBox)
 Returns bounding box of object correspondingly to its current display mode. This method requires presentation to be already computed, since it relies on bounding box of presentation structures, which are supposed to be same/close amongst different display modes of this object. More...
 
void SetIsoOnTriangulation (const Standard_Boolean theIsEnabled)
 Enables or disables on-triangulation build of isolines according to the flag given. More...
 
Aspect_TypeOfFacingModel CurrentFacingModel () const
 Returns the current facing model which is in effect. More...
 
void SetCurrentFacingModel (const Aspect_TypeOfFacingModel theModel=Aspect_TOFM_BOTH_SIDE)
 change the current facing model apply on polygons for SetColor(), SetTransparency(), SetMaterial() methods default facing model is Aspect_TOFM_TWO_SIDE. This mean that attributes is applying both on the front and back face. More...
 
Standard_Boolean HasColor () const
 Returns true if the Interactive Object has color. More...
 
virtual void Color (Quantity_Color &theColor) const
 Returns the color setting of the Interactive Object. More...
 
virtual void SetColor (const Quantity_Color &theColor)
 Only the interactive object knowns which Drawer attribute is affected by the color, if any (ex: for a wire,it's the wireaspect field of the drawer, but for a vertex, only the point aspect field is affected by the color). WARNING : Do not forget to set the corresponding fields here (hasOwnColor and myDrawer->SetColor()) More...
 
virtual void UnsetColor ()
 Removes color settings. Only the Interactive Object knows which Drawer attribute is affected by the color setting. For a wire, for example, wire aspect is the attribute affected. For a vertex, however, only point aspect is affected by the color setting. More...
 
Standard_Boolean HasWidth () const
 Returns true if the Interactive Object has width. More...
 
Standard_Real Width () const
 Returns the width setting of the Interactive Object. More...
 
virtual void SetWidth (const Standard_Real theWidth)
 Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting. More...
 
virtual void UnsetWidth ()
 Reset width to default value. More...
 
Standard_Boolean HasMaterial () const
 Returns true if the Interactive Object has a setting for material. More...
 
virtual Graphic3d_NameOfMaterial Material () const
 Returns the current material setting as enumeration value. More...
 
virtual void SetMaterial (const Graphic3d_MaterialAspect &aName)
 Sets the material aMat defining this display attribute for the interactive object. Material aspect determines shading aspect, color and transparency of visible entities. More...
 
virtual void UnsetMaterial ()
 Removes the setting for material. More...
 
Standard_Boolean IsTransparent () const
 Returns true if there is a transparency setting. More...
 
virtual Standard_Real Transparency () const
 Returns the transparency setting. This will be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent. More...
 
virtual void SetTransparency (const Standard_Real aValue=0.6)
 Attributes a setting aValue for transparency. The transparency value should be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent. Warning At a value of 1.0, there may be nothing visible. More...
 
virtual void UnsetTransparency ()
 Removes the transparency setting. The object is opaque by default. More...
 
virtual Standard_Boolean HasPolygonOffsets () const
 Returns Standard_True if <myDrawer> has non-null shading aspect. More...
 
virtual void PolygonOffsets (Standard_Integer &aMode, Standard_ShortReal &aFactor, Standard_ShortReal &aUnits) const
 Retrieves current polygon offsets settings from <myDrawer>. More...
 
virtual void SetPolygonOffsets (const Standard_Integer aMode, const Standard_ShortReal aFactor=1.0, const Standard_ShortReal aUnits=0.0)
 Sets up polygon offsets for this object. More...
 
virtual void UnsetAttributes ()
 Clears settings provided by the drawing tool aDrawer. More...
 
void ToBeUpdated (TColStd_ListOfInteger &ListOfMode) const
 gives the list of modes which are flagged "to be updated". More...
 
void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane &thePlanes)
 
void SetTransformPersistence (const Graphic3d_TransModeFlags theMode, const gp_Pnt &thePoint=gp_Pnt(0.0, 0.0, 0.0))
 Sets up Transform Persistence Mode for this object. This function used to lock in object position, rotation and / or zooming relative to camera position. Object will be drawn in the origin setted by thePoint parameter (except Graphic3d_TMF_TriedronPers flag. More...
 
Graphic3d_TransModeFlags GetTransformPersistenceMode () const
 Gets Transform Persistence Mode for this object. More...
 
gp_Pnt GetTransformPersistencePoint () const
 Gets point of transform persistence for this object. 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 void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 opencascade::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...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static Standard_Boolean FindColor (const Standard_Real theValue, const Standard_Real theMin, const Standard_Real theMax, const Standard_Integer theColorsCount, const Graphic3d_Vec3d &theColorHlsMin, const Graphic3d_Vec3d &theColorHlsMax, Quantity_Color &theColor)
 Calculate color according passed value; returns true if value is in range or false, if isn't. More...
 
static Standard_Boolean FindColor (const Standard_Real theValue, const Standard_Real theMin, const Standard_Real theMax, const Standard_Integer theColorsCount, Quantity_Color &theColor)
 Calculate color according passed value; returns true if value is in range or false, if isn't. More...
 
static Standard_Real hueToValidRange (const Standard_Real theHue)
 Shift hue into valid range. Lightness and Saturation should be specified in valid range [0.0, 1.0], however Hue might be given out of Quantity_Color range to specify desired range for interpolation. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Protected Member Functions inherited from AIS_InteractiveObject
 AIS_InteractiveObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 The TypeOfPresention3d means that the interactive object may have a presentation dependant of the view of Display. More...
 
- Protected Member Functions inherited from SelectMgr_SelectableObject
 SelectMgr_SelectableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 Protected empty constructor. More...
 
void setGlobalSelMode (const Standard_Integer theMode)
 Override global selection mode. More...
 
virtual void UpdateClipping () override
 Update clipping planes state. More...
 
virtual void updateSelection (const Standard_Integer theMode)
 Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection from outer classes to prevent BVH structures from being outdated. More...
 
- Protected Member Functions inherited from PrsMgr_PresentableObject
void Update (Standard_Boolean theToIncludeHidden=Standard_False)
 Recomputes all presentations of the object. More...
 
void Update (Standard_Integer theMode, Standard_Boolean theToClearOther)
 Recomputes the presentation in the given mode. More...
 
 PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 Protected empty constructor. More...
 
virtual ~PrsMgr_PresentableObject ()
 Destructor. More...
 
virtual void Fill (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Handle< PrsMgr_Presentation > &thePrs, const Standard_Integer theMode)
 Fills the given 3D view presentation for specified display mode using Compute() method. In addition, configures other properties of presentation (transformation, clipping planes). More...
 
virtual void Compute (const Handle< Prs3d_Projector > &theProjector, const Handle< Prs3d_Presentation > &thePrs)
 Calculates the 3D view presentation. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation. It must be redefined to implement hidden line removal for the object. The user never calls this method himself. This is done via the InteractiveContext object and is dependent on the point of view from which the object is displayed. More...
 
virtual void Compute (const Handle< Prs3d_Projector > &theProjector, const Handle< Geom_Transformation > &theTrsf, const Handle< Prs3d_Presentation > &thePrs)
 Calculates the 3D view presentation. A point of view is provided by the projector, and the geometric transformation which has transformed associated presentable objects is specified by transformation. This function is to be used in case where a hidden line removal display cannot be calculated automatically. This occurs when associated presentable objects have been transformed geometrically, but not translated. Warning! The transformation must be applied to the object before computation. More...
 
Standard_Boolean UpdatePresentations (Standard_Boolean theToIncludeHidden=Standard_False)
 Recomputes invalidated presentations of the object. More...
 
virtual void SetCombinedParentTransform (const Handle< Geom_Transformation > &theTrsf)
 Sets myCombinedParentTransform to theTransformation. Thus object receives transformation from parent node and able to derive its own. More...
 
virtual void setLocalTransformation (const Handle< Geom_Transformation > &theTransformation)
 Sets local transformation to theTransformation. More...
 
void recomputeComputed () const
 Recompute computed (HLR) presentations (when view is in computed mode). More...
 
void replaceAspects (const Graphic3d_MapOfAspectsToAspects &theMap)
 Replace aspects of existing (computed) presentation groups, so that the new aspects can be applied without recomputing presentation. It is NOT recommended approach, because user has to fill such map and then search for each occurrence in computed groups. The recommended approach is computing presentation with necessary customized aspects, and then modify them directly followed by SynchronizeAspects() call. More...
 
- Static Protected Member Functions inherited from PrsMgr_PresentableObject
static const gp_TrsfgetIdentityTrsf ()
 Return the identity transformation. More...
 
- Protected Attributes inherited from AIS_InteractiveObject
AIS_InteractiveContextmyCTXPtr
 pointer to Interactive Context, where object is currently displayed; More...
 
Handle< Standard_TransientmyOwner
 application-specific owner object More...
 
- Protected Attributes inherited from SelectMgr_SelectableObject
SelectMgr_SequenceOfSelection myselections
 list of selections More...
 
Handle< Prs3d_PresentationmySelectionPrs
 optional presentation for highlighting selected object More...
 
Handle< Prs3d_PresentationmyHilightPrs
 optional presentation for highlighting detected object More...
 
Standard_Integer myGlobalSelMode
 global selection mode More...
 
Standard_Integer mycurrent
 [deprecated] iterator value More...
 
Standard_Boolean myAutoHilight
 auto-highlighting flag defining More...
 
- Protected Attributes inherited from PrsMgr_PresentableObject
PrsMgr_PresentableObjectmyParent
 pointer to the parent object More...
 
PrsMgr_Presentations myPresentations
 list of presentations More...
 
Handle< Graphic3d_SequenceOfHClipPlanemyClipPlanes
 sequence of object-specific clipping planes More...
 
Handle< Prs3d_DrawermyDrawer
 main presentation attributes More...
 
Handle< Prs3d_DrawermyHilightDrawer
 (optional) custom presentation attributes for highlighting selected object More...
 
Handle< Prs3d_DrawermyDynHilightDrawer
 (optional) custom presentation attributes for highlighting detected object More...
 
Handle< Graphic3d_TransformPersmyTransformPersistence
 transformation persistence More...
 
Handle< Geom_TransformationmyLocalTransformation
 local transformation relative to parent object More...
 
Handle< Geom_TransformationmyTransformation
 absolute transformation of this object (combined parents + local transformations) More...
 
Handle< Geom_TransformationmyCombinedParentTransform
 transformation of parent object (combined for all parents) More...
 
PrsMgr_ListOfPresentableObjects myChildren
 list of children More...
 
gp_GTrsf myInvTransformation
 inversion of absolute transformation (combined parents + local transformations) More...
 
PrsMgr_TypeOfPresentation3d myTypeOfPresentation3d
 presentation type More...
 
Aspect_TypeOfFacingModel myCurrentFacingModel
 current facing model More...
 
Standard_ShortReal myOwnWidth
 custom width value More...
 
Standard_Boolean hasOwnColor
 own color flag More...
 
Standard_Boolean hasOwnMaterial
 own material flag More...
 
Standard_Boolean myInfiniteState
 infinite flag More...
 
Standard_Boolean myIsMutable
 mutable flag More...
 
Standard_Boolean myHasOwnPresentations
 flag indicating if object should have own presentations More...
 

Detailed Description

Class for drawing a custom color scale.

The color scale consists of rectangular color bar (composed of fixed number of color intervals), optional labels, and title. The labels can be positioned either at the boundaries of the intervals, or at the middle of each interval. Colors and labels can be either defined automatically or set by the user. Automatic labels are calculated from numerical limits of the scale, its type (logarithmic or plain), and formatted by specified format string.

Constructor & Destructor Documentation

◆ AIS_ColorScale()

AIS_ColorScale::AIS_ColorScale ( )

Default constructor.

Member Function Documentation

◆ AcceptDisplayMode()

virtual Standard_Boolean AIS_ColorScale::AcceptDisplayMode ( const Standard_Integer  theMode) const
inlineoverridevirtual

Return true if specified display mode is supported.

Reimplemented from PrsMgr_PresentableObject.

◆ ColorRange()

void AIS_ColorScale::ColorRange ( Quantity_Color theMinColor,
Quantity_Color theMaxColor 
) const
inline

Returns color range corresponding to minimum and maximum values, blue to red by default.

◆ Compute()

virtual void AIS_ColorScale::Compute ( const Handle< PrsMgr_PresentationManager3d > &  thePresentationManager,
const Handle< Prs3d_Presentation > &  thePresentation,
const Standard_Integer  theMode 
)
overridevirtual

Compute presentation.

Implements PrsMgr_PresentableObject.

◆ ComputeSelection()

virtual void AIS_ColorScale::ComputeSelection ( const Handle< SelectMgr_Selection > &  ,
const Standard_Integer   
)
inlineoverridevirtual

Compute selection - not implemented for color scale.

Implements SelectMgr_SelectableObject.

◆ FindColor() [1/3]

static Standard_Boolean AIS_ColorScale::FindColor ( const Standard_Real  theValue,
const Standard_Real  theMin,
const Standard_Real  theMax,
const Standard_Integer  theColorsCount,
const Graphic3d_Vec3d theColorHlsMin,
const Graphic3d_Vec3d theColorHlsMax,
Quantity_Color theColor 
)
static

Calculate color according passed value; returns true if value is in range or false, if isn't.

◆ FindColor() [2/3]

static Standard_Boolean AIS_ColorScale::FindColor ( const Standard_Real  theValue,
const Standard_Real  theMin,
const Standard_Real  theMax,
const Standard_Integer  theColorsCount,
Quantity_Color theColor 
)
inlinestatic

Calculate color according passed value; returns true if value is in range or false, if isn't.

◆ FindColor() [3/3]

Standard_Boolean AIS_ColorScale::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.

◆ Format()

const TCollection_AsciiString& AIS_ColorScale::Format ( ) const
inline

Returns the format of text.

◆ GetBreadth()

Standard_Integer AIS_ColorScale::GetBreadth ( ) const
inline

Returns the breadth of color bar, 0 by default (e.g. should be set by user explicitly before displaying).

◆ GetColors() [1/2]

void AIS_ColorScale::GetColors ( Aspect_SequenceOfColor theColors) const

Returns the user specified colors.

◆ GetColors() [2/2]

const Aspect_SequenceOfColor& AIS_ColorScale::GetColors ( ) const
inline

Returns the user specified colors.

◆ GetColorType()

Aspect_TypeOfColorScaleData AIS_ColorScale::GetColorType ( ) const
inline

Returns the type of colors, Aspect_TOCSD_AUTO by default. Aspect_TOCSD_AUTO - value between Red and Blue Aspect_TOCSD_USER - user specified color from color map.

◆ GetFormat()

const TCollection_AsciiString& AIS_ColorScale::GetFormat ( ) const
inline

Returns the format for numbers, "%.4g" by default. The same like format for function printf(). Used if GetLabelType() is TOCSD_AUTO;.

◆ GetHeight()

Standard_Integer AIS_ColorScale::GetHeight ( ) const
inline

Returns the height of color bar, 0 by default (e.g. should be set by user explicitly before displaying).

◆ GetIntervalColor()

Quantity_Color AIS_ColorScale::GetIntervalColor ( const Standard_Integer  theIndex) const

Returns the user specified color from color map with index (starts at 1). Returns default color if index is out of range in color map.

◆ GetLabel()

TCollection_ExtendedString AIS_ColorScale::GetLabel ( const Standard_Integer  theIndex) const

Returns the user specified label with index theIndex. Index is in range from 1 to GetNumberOfIntervals() or to GetNumberOfIntervals() + 1 if IsLabelAtBorder() is true. Returns empty string if label not defined.

◆ GetLabelPosition()

Aspect_TypeOfColorScalePosition AIS_ColorScale::GetLabelPosition ( ) const
inline

Returns the position of labels concerning color filled rectangles, Aspect_TOCSP_RIGHT by default.

◆ GetLabels()

void AIS_ColorScale::GetLabels ( TColStd_SequenceOfExtendedString theLabels) const

Returns the user specified labels.

◆ GetLabelType()

Aspect_TypeOfColorScaleData AIS_ColorScale::GetLabelType ( ) const
inline

Returns the type of labels, Aspect_TOCSD_AUTO by default. Aspect_TOCSD_AUTO - labels as boundary values for intervals Aspect_TOCSD_USER - user specified label is used.

◆ GetMax()

Standard_Real AIS_ColorScale::GetMax ( ) const
inline

Returns maximal value of color scale, 1.0 by default.

◆ GetMin()

Standard_Real AIS_ColorScale::GetMin ( ) const
inline

Returns minimal value of color scale, 0.0 by default.

◆ GetNumberOfIntervals()

Standard_Integer AIS_ColorScale::GetNumberOfIntervals ( ) const
inline

Returns the number of color scale intervals, 10 by default.

◆ GetPosition()

void AIS_ColorScale::GetPosition ( Standard_Real theX,
Standard_Real theY 
) const
inline

Returns the bottom-left position of color scale, 0x0 by default.

◆ GetRange()

void AIS_ColorScale::GetRange ( Standard_Real theMin,
Standard_Real theMax 
) const
inline

Returns minimal and maximal values of color scale, 0.0 to 1.0 by default.

◆ GetSize()

void AIS_ColorScale::GetSize ( Standard_Integer theBreadth,
Standard_Integer theHeight 
) const
inline

Returns the size of color bar, 0 and 0 by default (e.g. should be set by user explicitly before displaying).

◆ GetTextHeight()

Standard_Integer AIS_ColorScale::GetTextHeight ( ) const
inline

Returns the font height of text labels, 20 by default.

◆ GetTitle()

const TCollection_ExtendedString& AIS_ColorScale::GetTitle ( ) const
inline

Returns the color scale title string, empty string by default.

◆ GetTitlePosition()

Aspect_TypeOfColorScalePosition AIS_ColorScale::GetTitlePosition ( ) const
inline

Returns the position of color scale title, Aspect_TOCSP_LEFT by default.

◆ GetXPosition()

Standard_Integer AIS_ColorScale::GetXPosition ( ) const
inline

Returns the left position of color scale, 0 by default.

◆ GetYPosition()

Standard_Integer AIS_ColorScale::GetYPosition ( ) const
inline

Returns the bottom position of color scale, 0 by default.

◆ HueMax()

Standard_Real AIS_ColorScale::HueMax ( ) const
inline

Returns the hue angle corresponding to maximum value, 0 by default (red).

◆ HueMin()

Standard_Real AIS_ColorScale::HueMin ( ) const
inline

Returns the hue angle corresponding to minimum value, 230 by default (blue).

◆ HueRange()

void AIS_ColorScale::HueRange ( Standard_Real theMinAngle,
Standard_Real theMaxAngle 
) const
inline

Returns the hue angle range corresponding to minimum and maximum values, 230 to 0 by default (blue to red).

◆ hueToValidRange()

static Standard_Real AIS_ColorScale::hueToValidRange ( const Standard_Real  theHue)
inlinestatic

Shift hue into valid range. Lightness and Saturation should be specified in valid range [0.0, 1.0], however Hue might be given out of Quantity_Color range to specify desired range for interpolation.

◆ IsLabelAtBorder()

Standard_Boolean AIS_ColorScale::IsLabelAtBorder ( ) const
inline

Returns TRUE if the labels are placed at border of color intervals, TRUE by default. The automatically generated label will show value exactly on the current position:

  • value connecting two neighbor intervals (TRUE)
  • value in the middle of interval (FALSE)

◆ IsLogarithmic()

Standard_Boolean AIS_ColorScale::IsLogarithmic ( ) const
inline

Returns TRUE if the color scale has logarithmic intervals, FALSE by default.

◆ IsReversed()

Standard_Boolean AIS_ColorScale::IsReversed ( ) const
inline

Returns TRUE if the labels and colors used in reversed order, FALSE by default.

  • Normal, bottom-up order with Minimal value on the Bottom and Maximum value on Top.
  • Reversed, top-down order with Maximum value on the Bottom and Minimum value on Top.

◆ IsSmoothTransition()

Standard_Boolean AIS_ColorScale::IsSmoothTransition ( ) const
inline

Return TRUE if color transition between neighbor intervals should be linearly interpolated, FALSE by default.

◆ Labels()

const TColStd_SequenceOfExtendedString& AIS_ColorScale::Labels ( ) const
inline

Returns the user specified labels.

◆ SetBreadth()

void AIS_ColorScale::SetBreadth ( const Standard_Integer  theBreadth)
inline

Sets the width of color bar.

◆ SetColorRange()

void AIS_ColorScale::SetColorRange ( const Quantity_Color theMinColor,
const Quantity_Color theMaxColor 
)
inline

Sets color range corresponding to minimum and maximum values.

◆ SetColors()

void AIS_ColorScale::SetColors ( const Aspect_SequenceOfColor theSeq)

Sets the color scale colors. The length of the sequence should be equal to GetNumberOfIntervals().

◆ SetColorType()

void AIS_ColorScale::SetColorType ( const Aspect_TypeOfColorScaleData  theType)
inline

Sets the type of colors. Aspect_TOCSD_AUTO - value between Red and Blue Aspect_TOCSD_USER - user specified color from color map.

◆ SetFormat()

void AIS_ColorScale::SetFormat ( const TCollection_AsciiString theFormat)
inline

Sets the color scale auto label format specification.

◆ SetHeight()

void AIS_ColorScale::SetHeight ( const Standard_Integer  theHeight)
inline

Sets the height of color bar.

◆ SetHueRange()

void AIS_ColorScale::SetHueRange ( const Standard_Real  theMinAngle,
const Standard_Real  theMaxAngle 
)
inline

Sets hue angle range corresponding to minimum and maximum values. The valid angle range is [0, 360], see Quantity_Color and Quantity_TOC_HLS for more details.

◆ SetIntervalColor()

void AIS_ColorScale::SetIntervalColor ( const Quantity_Color theColor,
const Standard_Integer  theIndex 
)

Sets the color of the specified interval. Note that list is automatically resized to include specified index.

Parameters
theColorcolor value to set
theIndexindex in range [1, GetNumberOfIntervals()]; appended to the end of list if -1 is specified

◆ SetLabel()

void AIS_ColorScale::SetLabel ( const TCollection_ExtendedString theLabel,
const Standard_Integer  theIndex 
)

Sets the color scale label at index. Note that list is automatically resized to include specified index.

Parameters
theLabelnew label text
theIndexindex in range [1, GetNumberOfIntervals()] or [1, GetNumberOfIntervals() + 1] if IsLabelAtBorder() is true; label is appended to the end of list if negative index is specified

◆ SetLabelAtBorder()

void AIS_ColorScale::SetLabelAtBorder ( const Standard_Boolean  theOn)
inline

Sets true if the labels are placed at border of color intervals (TRUE by default). If set to False, labels will be drawn at color intervals rather than at borders.

◆ SetLabelPosition()

void AIS_ColorScale::SetLabelPosition ( const Aspect_TypeOfColorScalePosition  thePos)
inline

Sets the color scale labels position relative to color bar.

◆ SetLabels()

void AIS_ColorScale::SetLabels ( const TColStd_SequenceOfExtendedString theSeq)

Sets the color scale labels. The length of the sequence should be equal to GetNumberOfIntervals() or to GetNumberOfIntervals() + 1 if IsLabelAtBorder() is true. If length of the sequence does not much the number of intervals, then these labels will be considered as "free" and will be located at the virtual intervals corresponding to the number of labels (with flag IsLabelAtBorder() having the same effect as in normal case).

◆ SetLabelType()

void AIS_ColorScale::SetLabelType ( const Aspect_TypeOfColorScaleData  theType)
inline

Sets the type of labels. Aspect_TOCSD_AUTO - labels as boundary values for intervals Aspect_TOCSD_USER - user specified label is used.

◆ SetLogarithmic()

void AIS_ColorScale::SetLogarithmic ( const Standard_Boolean  isLogarithmic)
inline

Sets true if the color scale has logarithmic intervals.

◆ SetMax()

void AIS_ColorScale::SetMax ( const Standard_Real  theMax)
inline

Sets the maximal value of color scale.

◆ SetMin()

void AIS_ColorScale::SetMin ( const Standard_Real  theMin)
inline

Sets the minimal value of color scale.

◆ SetNumberOfIntervals()

void AIS_ColorScale::SetNumberOfIntervals ( const Standard_Integer  theNum)

Sets the number of color scale intervals.

◆ SetPosition()

void AIS_ColorScale::SetPosition ( const Standard_Integer  theX,
const Standard_Integer  theY 
)
inline

Sets the position of color scale.

◆ SetRange()

void AIS_ColorScale::SetRange ( const Standard_Real  theMin,
const Standard_Real  theMax 
)

Sets the minimal and maximal value of color scale. Note that values order will be ignored - the minimum and maximum values will be swapped if needed. ::SetReversed() should be called to swap displaying order.

◆ SetReversed()

void AIS_ColorScale::SetReversed ( const Standard_Boolean  theReverse)
inline

Sets true if the labels and colors used in reversed order.

◆ SetSize()

void AIS_ColorScale::SetSize ( const Standard_Integer  theBreadth,
const Standard_Integer  theHeight 
)
inline

Sets the size of color bar.

◆ SetSmoothTransition()

void AIS_ColorScale::SetSmoothTransition ( const Standard_Boolean  theIsSmooth)
inline

Setup smooth color transition.

◆ SetTextHeight()

void AIS_ColorScale::SetTextHeight ( const Standard_Integer  theHeight)
inline

Sets the height of text of color scale.

◆ SetTitle()

void AIS_ColorScale::SetTitle ( const TCollection_ExtendedString theTitle)
inline

Sets the color scale title string.

◆ SetTitlePosition()

void AIS_ColorScale::SetTitlePosition ( const Aspect_TypeOfColorScalePosition  thePos)
inline

Sets the color scale title position.

Deprecated:
("AIS_ColorScale::SetTitlePosition() has no effect!")

◆ SetXPosition()

void AIS_ColorScale::SetXPosition ( const Standard_Integer  theX)
inline

Sets the left position of color scale.

◆ SetYPosition()

void AIS_ColorScale::SetYPosition ( const Standard_Integer  theY)
inline

Sets the bottom position of color scale.

◆ TextHeight()

Standard_Integer AIS_ColorScale::TextHeight ( const TCollection_ExtendedString theText) const

Returns the height of text.

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

◆ TextSize()

void AIS_ColorScale::TextSize ( const TCollection_ExtendedString theText,
const Standard_Integer  theHeight,
Standard_Integer theWidth,
Standard_Integer theAscent,
Standard_Integer theDescent 
) const

◆ TextWidth()

Standard_Integer AIS_ColorScale::TextWidth ( const TCollection_ExtendedString theText) const

Returns the width of text.

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

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