OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    AIS_ColorScale Class Reference

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

    #include <AIS_ColorScale.hxx>

    Inheritance diagram for AIS_ColorScale:

    Public Member Functions

     AIS_ColorScale ()
     Default constructor.
    bool FindColor (const double theValue, Quantity_Color &theColor) const
     Calculate color according passed value; returns true if value is in range or false, if isn't.
    double GetMin () const
     Returns minimal value of color scale, 0.0 by default.
    void SetMin (const double theMin)
     Sets the minimal value of color scale.
    double GetMax () const
     Returns maximal value of color scale, 1.0 by default.
    void SetMax (const double theMax)
     Sets the maximal value of color scale.
    void GetRange (double &theMin, double &theMax) const
     Returns minimal and maximal values of color scale, 0.0 to 1.0 by default.
    void SetRange (const double theMin, const double 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.
    double HueMin () const
     Returns the hue angle corresponding to minimum value, 230 by default (blue).
    double HueMax () const
     Returns the hue angle corresponding to maximum value, 0 by default (red).
    void HueRange (double &theMinAngle, double &theMaxAngle) const
     Returns the hue angle range corresponding to minimum and maximum values, 230 to 0 by default (blue to red).
    void SetHueRange (const double theMinAngle, const double 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.
    void ColorRange (Quantity_Color &theMinColor, Quantity_Color &theMaxColor) const
     Returns color range corresponding to minimum and maximum values, blue to red by default.
    void SetColorRange (const Quantity_Color &theMinColor, const Quantity_Color &theMaxColor)
     Sets color range corresponding to minimum and maximum values.
    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.
    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.
    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.
    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.
    int GetNumberOfIntervals () const
     Returns the number of color scale intervals, 10 by default.
    void SetNumberOfIntervals (const int theNum)
     Sets the number of color scale intervals.
    const TCollection_ExtendedString & GetTitle () const
     Returns the color scale title string, empty string by default.
    void SetTitle (const TCollection_ExtendedString &theTitle)
     Sets the color scale title string.
    const TCollection_AsciiString & GetFormat () const
     Returns the format for numbers, "%.4g" by default. The same like format for function printf(). Used if GetLabelType() is TOCSD_AUTO;.
    const TCollection_AsciiString & Format () const
     Returns the format of text.
    void SetFormat (const TCollection_AsciiString &theFormat)
     Sets the color scale auto label format specification.
    TCollection_ExtendedString GetLabel (const int 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.
    Quantity_Color GetIntervalColor (const int 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.
    void SetIntervalColor (const Quantity_Color &theColor, const int theIndex)
     Sets the color of the specified interval. Note that list is automatically resized to include specified index.
    void GetLabels (NCollection_Sequence< TCollection_ExtendedString > &theLabels) const
     Returns the user specified labels.
    const NCollection_Sequence< TCollection_ExtendedString > & Labels () const
     Returns the user specified labels.
    void SetLabels (const NCollection_Sequence< TCollection_ExtendedString > &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).
    void GetColors (NCollection_Sequence< Quantity_Color > &theColors) const
     Returns the user specified colors.
    const NCollection_Sequence< Quantity_Color > & GetColors () const
     Returns the user specified colors.
    void SetColors (const NCollection_Sequence< Quantity_Color > &theSeq)
     Sets the color scale colors. The length of the sequence should be equal to GetNumberOfIntervals().
    void SetUniformColors (double theLightness, double theHueFrom, double theHueTo)
     Populates colors scale by colors of the same lightness value in CIE Lch color space, distributed by hue, with perceptually uniform differences between consequent colors. See MakeUniformColors() for description of parameters.
    Aspect_TypeOfColorScalePosition GetLabelPosition () const
     Returns the position of labels concerning color filled rectangles, Aspect_TOCSP_RIGHT by default.
    void SetLabelPosition (const Aspect_TypeOfColorScalePosition thePos)
     Sets the color scale labels position relative to color bar.
    Aspect_TypeOfColorScalePosition GetTitlePosition () const
     Returns the position of color scale title, Aspect_TOCSP_LEFT by default.
    void SetTitlePosition (const Aspect_TypeOfColorScalePosition thePos)
     Sets the color scale title position.
    bool IsReversed () const
     Returns TRUE if the labels and colors used in reversed order, FALSE by default.
    void SetReversed (const bool theReverse)
     Sets true if the labels and colors used in reversed order.
    bool IsSmoothTransition () const
     Return TRUE if color transition between neighbor intervals should be linearly interpolated, FALSE by default.
    void SetSmoothTransition (const bool theIsSmooth)
     Setup smooth color transition.
    bool 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:
    void SetLabelAtBorder (const bool 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.
    bool IsLogarithmic () const
     Returns TRUE if the color scale has logarithmic intervals, FALSE by default.
    void SetLogarithmic (const bool isLogarithmic)
     Sets true if the color scale has logarithmic intervals.
    void SetLabel (const TCollection_ExtendedString &theLabel, const int theIndex)
     Sets the color scale label at index. Note that list is automatically resized to include specified index.
    void GetSize (int &theBreadth, int &theHeight) const
     Returns the size of color bar, 0 and 0 by default (e.g. should be set by user explicitly before displaying).
    void SetSize (const int theBreadth, const int theHeight)
     Sets the size of color bar.
    int GetBreadth () const
     Returns the breadth of color bar, 0 by default (e.g. should be set by user explicitly before displaying).
    void SetBreadth (const int theBreadth)
     Sets the width of color bar.
    int GetHeight () const
     Returns the height of color bar, 0 by default (e.g. should be set by user explicitly before displaying).
    void SetHeight (const int theHeight)
     Sets the height of color bar.
    void GetPosition (double &theX, double &theY) const
     Returns the bottom-left position of color scale, 0x0 by default.
    void SetPosition (const int theX, const int theY)
     Sets the position of color scale.
    int GetXPosition () const
     Returns the left position of color scale, 0 by default.
    void SetXPosition (const int theX)
     Sets the left position of color scale.
    int GetYPosition () const
     Returns the bottom position of color scale, 0 by default.
    void SetYPosition (const int theY)
     Sets the bottom position of color scale.
    int GetTextHeight () const
     Returns the font height of text labels, 20 by default.
    void SetTextHeight (const int theHeight)
     Sets the height of text of color scale.
    int TextWidth (const TCollection_ExtendedString &theText) const
     Returns the width of text.
    int TextHeight (const TCollection_ExtendedString &theText) const
     Returns the height of text.
    void TextSize (const TCollection_ExtendedString &theText, const int theHeight, int &theWidth, int &theAscent, int &theDescent) const
    bool AcceptDisplayMode (const int theMode) const override
     Return true if specified display mode is supported.
    void Compute (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const occ::handle< Prs3d_Presentation > &thePresentation, const int theMode) override
     Compute presentation.
    void ComputeSelection (const occ::handle< SelectMgr_Selection > &, const int) override
     Compute selection - not implemented for color scale.
    Public Member Functions inherited from AIS_InteractiveObject
    virtual AIS_KindOfInteractive Type () const
     Returns the kind of Interactive Object; AIS_KindOfInteractive_None by default.
    virtual int 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:
    void Redisplay (const bool AllModes=false)
     Updates the active presentation; if <AllModes> = 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.
    bool HasInteractiveContext () const
     Indicates whether the Interactive Object has a pointer to an interactive context.
    AIS_InteractiveContext * InteractiveContext () const
     Returns the context pointer to the interactive context.
    virtual void SetContext (const occ::handle< AIS_InteractiveContext > &aCtx)
     Sets the interactive context aCtx and provides a link to the default drawing tool or "Drawer" if there is none.
    bool 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.
    const occ::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:
    void SetOwner (const occ::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.
    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.
    virtual bool ProcessDragging (const occ::handle< AIS_InteractiveContext > &theCtx, const occ::handle< V3d_View > &theView, const occ::handle< SelectMgr_EntityOwner > &theOwner, const NCollection_Vec2< int > &theDragFrom, const NCollection_Vec2< int > &theDragTo, const AIS_DragAction theAction)
     Drag object in the viewer.
    occ::handle< AIS_InteractiveContext > GetContext () const
     Returns the context pointer to the interactive context.
    bool HasPresentation () const
     Returns TRUE when this object has a presentation in the current DisplayMode().
    occ::handle< Prs3d_Presentation > Presentation () const
     Returns the current presentation of this object according to the current DisplayMode().
    void SetAspect (const occ::handle< Prs3d_BasicAspect > &anAspect)
     Sets the graphic basic aspect to the current presentation.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
     Dumps the content of me into the stream.
    Public Member Functions inherited from SelectMgr_SelectableObject
     ~SelectMgr_SelectableObject () override
     Clears all selections of the object.
    virtual bool 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.
    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.
    void RecomputePrimitives (const int 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.
    void AddSelection (const occ::handle< SelectMgr_Selection > &aSelection, const int aMode)
     Adds the selection aSelection with the selection mode index aMode to this framework.
    void ClearSelections (const bool update=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.
    const occ::handle< SelectMgr_Selection > & Selection (const int theMode) const
     Returns the selection having specified selection mode or NULL.
    bool HasSelection (const int theMode) const
     Returns true if a selection corresponding to the selection mode theMode was computed for this object.
    const NCollection_Sequence< occ::handle< SelectMgr_Selection > > & Selections () const
     Return the sequence of selections.
    void ResetTransformation () override
     resets local transformation to identity.
    void UpdateTransformation () override
     Recomputes the location of the selection aSelection.
    virtual void UpdateTransformations (const occ::handle< SelectMgr_Selection > &aSelection)
     Updates locations in all sensitive entities from <aSelection> and in corresponding entity owners.
    virtual void HilightSelected (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const NCollection_Sequence< occ::handle< SelectMgr_EntityOwner > > &theSeq)
     Method which draws selected owners ( for fast presentation draw ).
    virtual void ClearSelected ()
     Method which clear all selected owners belonging to this selectable object ( for fast presentation draw ).
    virtual void ClearDynamicHighlight (const occ::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.
    virtual void HilightOwnerWithColor (const occ::handle< PrsMgr_PresentationManager > &thePM, const occ::handle< Prs3d_Drawer > &theStyle, const occ::handle< SelectMgr_EntityOwner > &theOwner)
     Method which hilight an owner belonging to this selectable object (for fast presentation draw).
    virtual bool 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.
    virtual void SetAutoHilight (const bool theAutoHilight)
     Set AutoHilight property to true or false.
    occ::handle< Prs3d_Presentation > GetHilightPresentation (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr)
     Creates or returns existing presentation for highlighting detected object.
    occ::handle< Prs3d_Presentation > GetSelectPresentation (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr)
     Creates or returns existing presentation for highlighting selected object.
    virtual void ErasePresentations (bool theToRemove)
     Removes presentations returned by GetHilightPresentation() and GetSelectPresentation().
    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.
    void UpdateSelection (const int 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.
    void SetAssemblyOwner (const occ::handle< SelectMgr_EntityOwner > &theOwner, const int theMode=-1)
     Sets common entity owner for assembly sensitive object entities.
    Bnd_Box BndBoxOfSelected (const occ::handle< NCollection_Shared< NCollection_IndexedMap< occ::handle< SelectMgr_EntityOwner > > > > &theOwners)
     Returns a bounding box of sensitive entities with the owners given if they are a part of activated selection.
    int GlobalSelectionMode () const
     Returns the mode for selection of object as a whole; 0 by default.
    virtual occ::handle< SelectMgr_EntityOwner > GlobalSelOwner () const
     Returns the owner of mode for selection of object as a whole.
    virtual const occ::handle< SelectMgr_EntityOwner > & GetAssemblyOwner () const
     Returns common entity owner if the object is an assembly.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
     Dumps the content of me into the stream.
    Public Member Functions inherited from PrsMgr_PresentableObject
    NCollection_Sequence< occ::handle< PrsMgr_Presentation > > & Presentations ()
     Return presentations.
    Graphic3d_ZLayerId ZLayer () const
     Get ID of Z layer for main presentation.
    bool 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).
    virtual void SetMutable (const bool 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.
    const occ::handle< Graphic3d_ViewAffinity > & ViewAffinity () const
     Return view affinity mask.
    bool HasDisplayMode () const
     Returns true if the Interactive Object has display mode setting overriding global setting (within Interactive Context).
    int 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().
    void SetDisplayMode (const int 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.
    void UnsetDisplayMode ()
     Removes display mode settings from the interactive object.
    bool HasHilightMode () const
     Returns true if the Interactive Object is in highlight mode.
    int HilightMode () const
     Returns highlight display mode. This is obsolete method for backward compatibility - use ::HilightAttributes() and ::DynamicHilightAttributes() instead.
    void SetHilightMode (const int theMode)
     Sets highlight display mode. This is obsolete method for backward compatibility - use ::HilightAttributes() and ::DynamicHilightAttributes() instead.
    void UnsetHilightMode ()
     Unsets highlight display mode.
    virtual int DefaultDisplayMode () const
     Returns the default display mode.
    bool ToBeUpdated (bool theToIncludeHidden=false) const
     Returns TRUE if any active presentation has invalidation flag.
    void SetToUpdate (int theMode)
     Flags presentation to be updated; UpdatePresentations() will recompute these presentations.
    void SetToUpdate ()
     flags all the Presentations to be Updated.
    bool 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.
    void SetInfiniteState (const bool theFlag=true)
     Sets if object should be considered as infinite.
    PrsMgr_TypeOfPresentation3d TypeOfPresentation3d () const
     Returns information on whether the object accepts display in HLR mode or not.
    void SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d theType)
     Set type of presentation.
    PrsMgr_DisplayStatus DisplayStatus () const
     Return presentation display status; PrsMgr_DisplayStatus_None by default.
    const occ::handle< Prs3d_Drawer > & Attributes () const
     Initializes the drawing tool theDrawer.
    virtual void SetAttributes (const occ::handle< Prs3d_Drawer > &theDrawer)
     Initializes the drawing tool theDrawer.
    const occ::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::HighlightStyle().
    virtual void SetHilightAttributes (const occ::handle< Prs3d_Drawer > &theDrawer)
     Initializes the hilight drawing tool theDrawer.
    const occ::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::HighlightStyle().
    virtual void SetDynamicHilightAttributes (const occ::handle< Prs3d_Drawer > &theDrawer)
     Initializes the dynamic hilight drawing tool.
    virtual void UnsetHilightAttributes ()
     Clears settings provided by the hilight drawing tool theDrawer.
    void SynchronizeAspects ()
     Synchronize presentation aspects after their modification.
    const occ::handle< Graphic3d_TransformPers > & TransformPersistence () const
     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.
    virtual void SetTransformPersistence (const occ::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.
    const occ::handle< TopLoc_Datum3D > & 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.
    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.
    void SetLocalTransformation (const occ::handle< TopLoc_Datum3D > &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.
    bool HasTransformation () const
     Returns true if object has a transformation that is different from the identity.
    const occ::handle< TopLoc_Datum3D > & 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.
    const gp_Trsf & LocalTransformation () 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.
    const gp_Trsf & Transformation () 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.
    const gp_GTrsf & InversedTransformation () const
     Return inversed transformation.
    const occ::handle< TopLoc_Datum3D > & CombinedParentTransformation () const
     Return combined parent transformation.
    virtual void RecomputeTransformation (const occ::handle< Graphic3d_Camera > &theProjector)
     Calculates object presentation for specific camera position. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation.
    const occ::handle< Graphic3d_SequenceOfHClipPlane > & ClipPlanes () const
     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.
    virtual void SetClipPlanes (const occ::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.
    virtual void AddClipPlane (const occ::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.
    virtual void RemoveClipPlane (const occ::handle< Graphic3d_ClipPlane > &thePlane)
     Removes previously added clip plane.
    PrsMgr_PresentableObject * Parent () const
     Returns children of the current object.
    const NCollection_List< occ::handle< PrsMgr_PresentableObject > > & Children () const
     Returns children of the current object.
    virtual void AddChild (const occ::handle< PrsMgr_PresentableObject > &theObject)
     Makes theObject child of current object in scene hierarchy.
    void AddChildWithCurrentTransformation (const occ::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.
    virtual void RemoveChild (const occ::handle< PrsMgr_PresentableObject > &theObject)
     Removes theObject from children of current object in scene hierarchy.
    void RemoveChildWithRestoreTransformation (const occ::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.
    bool HasOwnPresentations () const
     Returns true if object should have own presentations.
    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.
    void SetIsoOnTriangulation (const bool theIsEnabled)
     Returns the current facing model which is in effect.
    Aspect_TypeOfFacingModel CurrentFacingModel () const
     Returns the current facing model which is in effect.
    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.
    bool HasColor () const
     Returns true if the Interactive Object has color.
    virtual void Color (Quantity_Color &theColor) const
     Returns the color setting of the Interactive Object.
    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()).
    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.
    bool HasWidth () const
     Returns true if the Interactive Object has width.
    double Width () const
     Returns the width setting of the Interactive Object.
    virtual void SetWidth (const double theWidth)
     Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting.
    virtual void UnsetWidth ()
     Reset width to default value.
    bool HasMaterial () const
     Returns true if the Interactive Object has a setting for material.
    virtual Graphic3d_NameOfMaterial Material () const
     Returns the current material setting as enumeration value.
    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.
    virtual void UnsetMaterial ()
     Removes the setting for material.
    bool IsTransparent () const
     Returns true if there is a transparency setting.
    virtual double 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.
    virtual void SetTransparency (const double 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.
    virtual void UnsetTransparency ()
     Removes the transparency setting. The object is opaque by default.
    virtual bool HasPolygonOffsets () const
     Returns true if <myDrawer> has non-null shading aspect.
    virtual void PolygonOffsets (int &aMode, float &aFactor, float &aUnits) const
     Retrieves current polygon offsets settings from <myDrawer>.
    virtual void SetPolygonOffsets (const int aMode, const float aFactor=1.0, const float aUnits=0.0)
     Sets up polygon offsets for this object.
    virtual void UnsetAttributes ()
     Clears settings provided by the drawing tool aDrawer.
    void ToBeUpdated (NCollection_List< int > &ListOfMode) const
     pointer to the parent object
    bool ToPropagateVisualState () const
     Get value of the flag "propagate visual state" It means that the display/erase/color visual state is propagated automatically to all children; by default, the flag is true.
    void SetPropagateVisualState (const bool theFlag)
     Change the value of the flag "propagate visual state".
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transient & operator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool 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.
    bool IsKind (const char *const 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.
    Standard_Transient * This () 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.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Static Public Member Functions

    static bool FindColor (const double theValue, const double theMin, const double theMax, const int theColorsCount, const NCollection_Vec3< double > &theColorHlsMin, const NCollection_Vec3< double > &theColorHlsMax, Quantity_Color &theColor)
     Calculate color according passed value; returns true if value is in range or false, if isn't.
    static bool FindColor (const double theValue, const double theMin, const double theMax, const int theColorsCount, Quantity_Color &theColor)
     Calculate color according passed value; returns true if value is in range or false, if isn't.
    static double hueToValidRange (const double 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.
    static NCollection_Sequence< Quantity_Color > MakeUniformColors (int theNbColors, double theLightness, double theHueFrom, double theHueTo)
     Generates sequence of colors of the same lightness value in CIE Lch color space (see Quantity_TOC_CIELch), with hue values in the specified range. The colors are distributed across the range such as to have perceptually same difference between neighbour colors. For each color, maximal chroma value fitting in sRGB gamut is used.
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    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 dependent on the view of Display.
    void SetDisplayStatus (PrsMgr_DisplayStatus theStatus)
     Set presentation display status.
    Protected Member Functions inherited from SelectMgr_SelectableObject
     SelectMgr_SelectableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
     Protected empty constructor.
    void setGlobalSelMode (const int theMode)
     Override global selection mode.
    void UpdateClipping () override
     Update clipping planes state.
    virtual void updateSelection (const int 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.
    called instead void Update (bool theToIncludeHidden=false)
     Recomputes all presentations of the object.
    This method is deprecated SetToUpdate ()+UpdatePresentations() should be called instead") 1 void Update(int theMode
     Recomputes the presentation in the given mode.
     PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
     Destructor.
     ~PrsMgr_PresentableObject () override
     Destructor.
    virtual void Fill (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const occ::handle< PrsMgr_Presentation > &thePrs, const int theMode)
     Fills the given 3D view presentation for specified display mode using Compute() method. In addition, configures other properties of presentation (transformation, clipping planes).
    virtual void computeHLR (const occ::handle< Graphic3d_Camera > &theProjector, const occ::handle< TopLoc_Datum3D > &theTrsf, const occ::handle< Prs3d_Presentation > &thePrs)
     Calculates hidden line removal presentation for specific camera position. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation. Default implementation throws Standard_NotImplemented exception Warning! The transformation must be applied to the object before computation.
    bool UpdatePresentations (bool theToIncludeHidden=false)
     Recomputes invalidated presentations of the object.
    virtual void SetCombinedParentTransform (const occ::handle< TopLoc_Datum3D > &theTrsf)
     Sets myCombinedParentTransform to theTransformation. Thus object receives transformation from parent node and able to derive its own.
    virtual void setLocalTransformation (const occ::handle< TopLoc_Datum3D > &theTransformation)
     Sets local transformation to theTransformation.
    void recomputeComputed () const
     Recompute computed (HLR) presentations (when view is in computed mode).
    void replaceAspects (const NCollection_DataMap< occ::handle< Graphic3d_Aspects >, occ::handle< Graphic3d_Aspects > > &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.
    static const gp_Trsf & getIdentityTrsf ()
     Return the identity transformation.
    Protected Attributes inherited from AIS_InteractiveObject
    AIS_InteractiveContext * myCTXPtr
     pointer to Interactive Context, where object is currently displayed;
    occ::handle< Standard_Transient > myOwner
     application-specific owner object
    Protected Attributes inherited from SelectMgr_SelectableObject
    NCollection_Sequence< occ::handle< SelectMgr_Selection > > myselections
     list of selections
    occ::handle< Prs3d_Presentation > mySelectionPrs
     optional presentation for highlighting selected object
    occ::handle< Prs3d_Presentation > myHilightPrs
     optional presentation for highlighting detected object
    int myGlobalSelMode
     global selection mode
    bool myAutoHilight
     auto-highlighting flag defining
    This method is deprecated bool theToClearOther
     pointer to the parent object
    PrsMgr_PresentableObject * myParent
     pointer to the parent object
    NCollection_Sequence< occ::handle< PrsMgr_Presentation > > myPresentations
     list of presentations
    occ::handle< Graphic3d_ViewAffinity > myViewAffinity
     view affinity mask
    occ::handle< Graphic3d_SequenceOfHClipPlane > myClipPlanes
     sequence of object-specific clipping planes
    occ::handle< Prs3d_Drawer > myDrawer
     main presentation attributes
    occ::handle< Prs3d_Drawer > myHilightDrawer
     (optional) custom presentation attributes for highlighting selected object
    occ::handle< Prs3d_Drawer > myDynHilightDrawer
     (optional) custom presentation attributes for highlighting detected object
    occ::handle< Graphic3d_TransformPers > myTransformPersistence
     transformation persistence
    occ::handle< TopLoc_Datum3D > myLocalTransformation
     local transformation relative to parent object
    occ::handle< TopLoc_Datum3D > myTransformation
     absolute transformation of this object (combined parents + local transformations)
    occ::handle< TopLoc_Datum3D > myCombinedParentTransform
     transformation of parent object (combined for all parents)
    NCollection_List< occ::handle< PrsMgr_PresentableObject > > myChildren
     list of children
    gp_GTrsf myInvTransformation
     inversion of absolute transformation (combined parents + local transformations)
    PrsMgr_TypeOfPresentation3d myTypeOfPresentation3d
     presentation type
    PrsMgr_DisplayStatus myDisplayStatus
     presentation display status
    Aspect_TypeOfFacingModel myCurrentFacingModel
     current facing model
    float myOwnWidth
     custom width value
    bool hasOwnColor
     own color flag
    bool hasOwnMaterial
     own material flag
    bool myInfiniteState
     infinite flag
    bool myIsMutable
     mutable flag
    bool myHasOwnPresentations
     flag indicating if object should have own presentations
    bool myToPropagateVisualState
     flag indicating if visual state (display/erase/color) should be propagated to all children

    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()

    bool AIS_ColorScale::AcceptDisplayMode ( const int 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()

    void AIS_ColorScale::Compute ( const occ::handle< PrsMgr_PresentationManager > & thePrsMgr,
    const occ::handle< Prs3d_Presentation > & thePresentation,
    const int theMode )
    overridevirtual

    Compute presentation.

    Implements PrsMgr_PresentableObject.

    ◆ ComputeSelection()

    void AIS_ColorScale::ComputeSelection ( const occ::handle< SelectMgr_Selection > & ,
    const int  )
    inlineoverridevirtual

    Compute selection - not implemented for color scale.

    Implements SelectMgr_SelectableObject.

    ◆ FindColor() [1/3]

    bool AIS_ColorScale::FindColor ( const double theValue,
    const double theMin,
    const double theMax,
    const int theColorsCount,
    const NCollection_Vec3< double > & theColorHlsMin,
    const NCollection_Vec3< double > & 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]

    bool AIS_ColorScale::FindColor ( const double theValue,
    const double theMin,
    const double theMax,
    const int 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]

    bool AIS_ColorScale::FindColor ( const double 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()

    int 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]

    const NCollection_Sequence< Quantity_Color > & AIS_ColorScale::GetColors ( ) const
    inline

    Returns the user specified colors.

    ◆ GetColors() [2/2]

    void AIS_ColorScale::GetColors ( NCollection_Sequence< Quantity_Color > & theColors) const

    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()

    int 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 int 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 int 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 ( NCollection_Sequence< TCollection_ExtendedString > & 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()

    double AIS_ColorScale::GetMax ( ) const
    inline

    Returns maximal value of color scale, 1.0 by default.

    ◆ GetMin()

    double AIS_ColorScale::GetMin ( ) const
    inline

    Returns minimal value of color scale, 0.0 by default.

    ◆ GetNumberOfIntervals()

    int AIS_ColorScale::GetNumberOfIntervals ( ) const
    inline

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

    ◆ GetPosition()

    void AIS_ColorScale::GetPosition ( double & theX,
    double & theY ) const
    inline

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

    ◆ GetRange()

    void AIS_ColorScale::GetRange ( double & theMin,
    double & theMax ) const
    inline

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

    ◆ GetSize()

    void AIS_ColorScale::GetSize ( int & theBreadth,
    int & 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()

    int 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()

    int AIS_ColorScale::GetXPosition ( ) const
    inline

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

    ◆ GetYPosition()

    int AIS_ColorScale::GetYPosition ( ) const
    inline

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

    ◆ HueMax()

    double AIS_ColorScale::HueMax ( ) const
    inline

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

    ◆ HueMin()

    double AIS_ColorScale::HueMin ( ) const
    inline

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

    ◆ HueRange()

    void AIS_ColorScale::HueRange ( double & theMinAngle,
    double & theMaxAngle ) const
    inline

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

    ◆ hueToValidRange()

    double AIS_ColorScale::hueToValidRange ( const double 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()

    bool 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()

    bool AIS_ColorScale::IsLogarithmic ( ) const
    inline

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

    ◆ IsReversed()

    bool 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()

    bool AIS_ColorScale::IsSmoothTransition ( ) const
    inline

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

    ◆ Labels()

    const NCollection_Sequence< TCollection_ExtendedString > & AIS_ColorScale::Labels ( ) const
    inline

    Returns the user specified labels.

    ◆ MakeUniformColors()

    NCollection_Sequence< Quantity_Color > AIS_ColorScale::MakeUniformColors ( int theNbColors,
    double theLightness,
    double theHueFrom,
    double theHueTo )
    static

    Generates sequence of colors of the same lightness value in CIE Lch color space (see Quantity_TOC_CIELch), with hue values in the specified range. The colors are distributed across the range such as to have perceptually same difference between neighbour colors. For each color, maximal chroma value fitting in sRGB gamut is used.

    Parameters
    theNbColors- number of colors to generate
    theLightness- lightness to be used (0 is black, 100 is white, 32 is lightness of pure blue)
    theHueFrom- hue value at the start of the scale
    theHueTo- hue value defining the end of the scale

    Hue value can be out of the range [0, 360], interpreted as modulo 360. The colors of the scale will be in the order of increasing hue if theHueTo > theHueFrom, and decreasing otherwise.

    ◆ SetBreadth()

    void AIS_ColorScale::SetBreadth ( const int 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 NCollection_Sequence< Quantity_Color > & 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 int theHeight)
    inline

    Sets the height of color bar.

    ◆ SetHueRange()

    void AIS_ColorScale::SetHueRange ( const double theMinAngle,
    const double 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 int 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 int 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 bool 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 NCollection_Sequence< TCollection_ExtendedString > & 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 bool isLogarithmic)
    inline

    Sets true if the color scale has logarithmic intervals.

    ◆ SetMax()

    void AIS_ColorScale::SetMax ( const double theMax)
    inline

    Sets the maximal value of color scale.

    ◆ SetMin()

    void AIS_ColorScale::SetMin ( const double theMin)
    inline

    Sets the minimal value of color scale.

    ◆ SetNumberOfIntervals()

    void AIS_ColorScale::SetNumberOfIntervals ( const int theNum)

    Sets the number of color scale intervals.

    ◆ SetPosition()

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

    Sets the position of color scale.

    ◆ SetRange()

    void AIS_ColorScale::SetRange ( const double theMin,
    const double 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 bool theReverse)
    inline

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

    ◆ SetSize()

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

    Sets the size of color bar.

    ◆ SetSmoothTransition()

    void AIS_ColorScale::SetSmoothTransition ( const bool theIsSmooth)
    inline

    Setup smooth color transition.

    ◆ SetTextHeight()

    void AIS_ColorScale::SetTextHeight ( const int 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!")

    ◆ SetUniformColors()

    void AIS_ColorScale::SetUniformColors ( double theLightness,
    double theHueFrom,
    double theHueTo )
    inline

    Populates colors scale by colors of the same lightness value in CIE Lch color space, distributed by hue, with perceptually uniform differences between consequent colors. See MakeUniformColors() for description of parameters.

    ◆ SetXPosition()

    void AIS_ColorScale::SetXPosition ( const int theX)
    inline

    Sets the left position of color scale.

    ◆ SetYPosition()

    void AIS_ColorScale::SetYPosition ( const int theY)
    inline

    Sets the bottom position of color scale.

    ◆ TextHeight()

    int AIS_ColorScale::TextHeight ( const TCollection_ExtendedString & theText) const

    Returns the height of text.

    Parameters
    [in]theTextthe text of which to calculate height.

    ◆ TextSize()

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

    ◆ TextWidth()

    int AIS_ColorScale::TextWidth ( const TCollection_ExtendedString & theText) const

    Returns the width of text.

    Parameters
    [in]theTextthe text of which to calculate width.

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