Open CASCADE Technology  7.0.0
Public Member Functions | Static Public Member Functions | Protected 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;. More...
 
Standard_Real GetMax () const
 Returns maximal value of color scale;. More...
 
void GetRange (Standard_Real &theMin, Standard_Real &theMax) const
 Returns minimal and maximal values of color scale;. More...
 
Aspect_TypeOfColorScaleData GetLabelType () const
 Returns the type of labels; Aspect_TOCSD_AUTO - labels as boundary values for intervals Aspect_TOCSD_USER - user specified label is used. More...
 
Aspect_TypeOfColorScaleData GetColorType () const
 Returns the type of colors; Aspect_TOCSD_AUTO - value between Red and Blue Aspect_TOCSD_USER - user specified color from color map. More...
 
Standard_Integer GetNumberOfIntervals () const
 Returns the number of color scale intervals;. More...
 
TCollection_ExtendedString GetTitle () const
 Returns the color scale title string;. More...
 
TCollection_AsciiString GetFormat () const
 Returns the format for numbers. The same like format for function printf(). Used if GetLabelType() is TOCSD_AUTO;. More...
 
TCollection_ExtendedString GetLabel (const Standard_Integer theIndex) const
 Returns the user specified label with index 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 <anIndex> (starts at 1). Returns default color if index is out of range in color map. More...
 
void GetLabels (TColStd_SequenceOfExtendedString &theLabels) const
 Returns the user specified labels. More...
 
void GetColors (Aspect_SequenceOfColor &theColors) const
 Returns the user specified colors. More...
 
Aspect_TypeOfColorScalePosition GetLabelPosition () const
 Returns the position of labels concerning color filled rectangles. More...
 
Aspect_TypeOfColorScalePosition GetTitlePosition () const
 Returns the position of color scale title. More...
 
Standard_Boolean IsReversed () const
 Returns true if the labels and colors used in reversed order. More...
 
Standard_Boolean IsLabelAtBorder () const
 Returns true if the labels are placed at border of color intervals. More...
 
Standard_Boolean IsLogarithmic () const
 Returns true if the color scale has logarithmic intervals. More...
 
void SetMin (const Standard_Real theMin)
 Sets the minimal value of color scale. More...
 
void SetMax (const Standard_Real theMax)
 Sets the maximal value of color scale. More...
 
void SetRange (const Standard_Real theMin, const Standard_Real theMax)
 Sets the minimal and maximal value of color scale. More...
 
void SetLabelType (const Aspect_TypeOfColorScaleData theType)
 Sets the type of labels. Aspect_TOCSD_AUTO - labels as boundary values for intervals Aspect_TOCSD_USER - user specified label is used. More...
 
void SetColorType (const Aspect_TypeOfColorScaleData theType)
 Sets the type of colors. Aspect_TOCSD_AUTO - value between Red and Blue Aspect_TOCSD_USER - user specified color from color map. More...
 
void SetNumberOfIntervals (const Standard_Integer theNum)
 Sets the number of color scale intervals. More...
 
void SetTitle (const TCollection_ExtendedString &theTitle)
 Sets the color scale title string. More...
 
void SetFormat (const TCollection_AsciiString &theFormat)
 Sets the color scale auto label format specification. More...
 
void SetLabel (const TCollection_ExtendedString &theLabel, const Standard_Integer anIndex)
 Sets the color scale label at index. Index is in range from 1 to GetNumberOfIntervals() or to GetNumberOfIntervals() + 1 if IsLabelAtBorder() is true. More...
 
void SetIntervalColor (const Quantity_Color &theColor, const Standard_Integer theIndex)
 Sets the color of the specified interval. Index is in range from 1 to GetNumberOfIntervals(). 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. More...
 
void SetColors (const Aspect_SequenceOfColor &theSeq)
 Sets the color scale colors. The length of the sequence should be equal to GetNumberOfIntervals(). More...
 
void SetLabelPosition (const Aspect_TypeOfColorScalePosition thePos)
 Sets the color scale labels position relative to color bar. More...
 
void SetTitlePosition (const Aspect_TypeOfColorScalePosition thePos)
 Sets the color scale title position. More...
 
void SetReversed (const Standard_Boolean theReverse)
 Sets true if the labels and colors used in reversed order. More...
 
void SetLabelAtBorder (const Standard_Boolean theOn)
 Sets true if the labels 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...
 
void SetLogarithmic (const Standard_Boolean isLogarithmic)
 Sets true if the color scale has logarithmic intervals. More...
 
void GetSize (Standard_Integer &theBreadth, Standard_Integer &theHeight) const
 Returns the size of color bar. More...
 
Standard_Integer GetBreadth () const
 Returns the breadth of color bar. More...
 
Standard_Integer GetHeight () const
 Returns the height of color bar. More...
 
void SetSize (const Standard_Integer theWidth, const Standard_Integer theHeight)
 Sets the size of color bar. More...
 
void SetBreadth (const Standard_Integer theBreadth)
 Sets the width of color bar. 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 position of color scale. More...
 
Standard_Integer GetXPosition () const
 Returns the X position of color scale. More...
 
Standard_Integer GetYPosition () const
 Returns the height of color scale. More...
 
void SetPosition (const Standard_Integer theX, const Standard_Integer theY)
 Sets the position of color scale. More...
 
void SetXPosition (const Standard_Integer theX)
 Sets the X position of color scale. More...
 
void SetYPosition (const Standard_Integer theY)
 Sets the Y position of color scale. More...
 
Standard_Integer GetTextHeight () const
 Returns the height of text of color scale. More...
 
void SetTextHeight (const Standard_Integer theHeight)
 Sets the height of text of color scale. More...
 
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
 
- Public Member Functions inherited from AIS_InteractiveObject
virtual AIS_KindOfInteractive Type () const
 Returns the kind of Interactive Object: More...
 
virtual Standard_Integer Signature () const
 Specifies additional characteristics of Interactive Objects. A signature is, in fact, an index with integer values assigned different properties. This method is frequently used in conjuction with Type to give a particular type and signature to an Interactive Object. By default, the Interactive Object has a None type and a signature of 0. Among the datums, this signature is attributed to the shape The remaining datums have the following default signatures: 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. Activation methods for standard selection modes are proposed in the Interactive Context. These include selection by vertex or by edges. For datums with the same behavior as AIS_Shape, such as vetices and edges, we must redefine the virtual method so that AcceptShapeDecomposition returns false. Rule for selection : Mode 0 : Selection of the interactive Object itself Mode 1 : Selection of vertices Mode 2 : Selection Of Edges Mode 3 : Selection Of Wires Mode 4 : Selection Of Faces ... More...
 
void SetCurrentFacingModel (const Aspect_TypeOfFacingModel aModel=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...
 
Aspect_TypeOfFacingModel CurrentFacingModel () const
 Returns the current facing model which is in effect. More...
 
virtual void SetColor (const Quantity_Color &aColor)
 
virtual void SetColor (const Quantity_NameOfColor aColor)
 only the interactive obj knowns which Drawer attribute is affected by the color (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 myOwnColor) 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...
 
virtual void SetWidth (const Standard_Real aValue)
 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 ()
 
virtual Standard_Boolean AcceptDisplayMode (const Standard_Integer aMode) const
 Returns true if the class of objects accepts the display mode aMode. The interactive context can have a default mode of representation for the set of Interactive Objects. This mode may not be accepted by a given class of objects. Consequently, this virtual method allowing us to get information about the class in question must be implemented. More...
 
virtual Standard_Integer DefaultDisplayMode () const
 Returns the default display mode. This method is to be implemented when the main mode is not mode 0. 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...
 
void SetInfiniteState (const Standard_Boolean aFlag=Standard_True)
 Sets the infinite state flag aFlage. if <aFlag> = True , the interactiveObject is considered as infinite, i.e. its graphic presentations are not taken in account for View FitAll... More...
 
Standard_Boolean IsInfinite () const
 Returns true if the interactive object is infinite. In this case, its graphic presentations are not taken into account in the fit-all view. More...
 
Standard_Boolean HasInteractiveContext () const
 Indicates whether the Interactive Object has a pointer to an interactive context. More...
 
Handle< AIS_InteractiveContextGetContext () 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 > &ApplicativeEntity)
 Allows you to attribute the owner ApplicativeEntity 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...
 
Standard_Boolean HasUsers () const
 
const TColStd_ListOfTransientUsers () const
 
void AddUser (const Handle< Standard_Transient > &aUser)
 
void ClearUsers ()
 
Standard_Boolean HasDisplayMode () const
 Returns true if the Interactive Object has a display mode setting. Otherwise, it is displayed in Neutral Point. More...
 
void SetDisplayMode (const Standard_Integer aMode)
 Sets the display mode aMode for the interactive object. An object can have its own temporary display mode, which is different from that proposed by the interactive context. The range of possibilities currently proposed is the following: More...
 
void UnsetDisplayMode ()
 Removes display mode settings from the interactive object. More...
 
Standard_Integer DisplayMode () const
 Returns the display mode setting of the Interactive Object. The range of possibilities is the following: More...
 
Standard_Integer SelectionPriority () const
 Returns the selection priority setting. -1 indicates that there is none. You can modify the selection priority of an owner to make one entity more selectionable than another one. The default selection priority for an owner is 5, for example. To increase selection priority, choose a setting between 5 and 10. An entity with priority 7 will take priority over one with a setting of 6 if both objects are selected at the same time. You could give vertices priority 8, edges priority 7, faces priority 6, and shapes priority 5. If a vertex, an edge and a face are simultaneously detected during selection, only the vertex will then be highlighted. For trihedra, for example, the default priorities are the following four: More...
 
void SetSelectionPriority (const Standard_Integer aPriority)
 Allows you to provide a setting aPriority for selection priority. You can modify selection priority of an owner to make one entity more selectionable than another one. The default selection priority for an owner is 5, for example. To increase selection priority, choose a setting between 5 and 10. An entity with priority 7 will take priority over one with a setting of 6. More...
 
void UnsetSelectionPriority ()
 Removes the setting for selection priority. SelectionPriority then returns -1. More...
 
Standard_Boolean HasSelectionPriority () const
 Returns true if there is a setting for selection priority. You can modify selection priority of an owner to make one entity more selectionable than another one. The default selection priority for an owner is 5, for example. To increase selection priority, choose a setting between 5 and 10. An entity with priority 7 will take priority over one with a setting of 6. More...
 
Standard_Boolean HasHilightMode () const
 Returns true if the Interactive Object is in highlight mode. More...
 
Standard_Integer HilightMode () const
 Returns the setting for highlight mode. At dynamic detection, the presentation echoed by the Interactive Context, is by default the presentation already on the screen. You can specify a Highlight presentation mode which is valid no matter what the active representation of the object. It makes no difference whether this choice is temporary or definitive. To do this, we use the following functions: More...
 
void SetHilightMode (const Standard_Integer anIndex)
 Sets the highlight mode anIndex for the interactive object. If, for example, you want to systematically highlight the wireframe presentation of a shape - whether visualized in wireframe presentation or with shading - you set the highlight mode to 0. More...
 
void UnsetHilightMode ()
 Allows the user to take a given Prs for hilight ex : for a shape which would be displayed in shading mode the hilight Prs is the wireframe mode. if No specific hilight mode is defined, the displayed Prs will be the hilighted one. More...
 
Standard_Boolean HasColor () const
 Returns true if the Interactive Object has color. More...
 
virtual Quantity_NameOfColor Color () const
 Returns the color setting of the Interactive Object. More...
 
virtual void Color (Quantity_Color &aColor) const
 
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...
 
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. This will be on of the following materials: More...
 
virtual void SetMaterial (const Graphic3d_NameOfMaterial aName)
 Sets the name aName for material defining this display attribute for the interactive object. Material aspect determines shading aspect, color and transparency of visible entities. 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...
 
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...
 
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 UnsetTransparency ()
 Removes the transparency setting. The object is opaque by default. More...
 
virtual void UnsetAttributes () override
 Clears settings provided by the drawing tool aDrawer. More...
 
void State (const Standard_Integer theState)
 
Standard_Integer State () const
 
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, const Standard_Boolean globalChange=Standard_True)
 Sets the graphic basic aspect to the current presentation. When <globalChange> is TRUE , the full object presentation is changed. When <globalChange> is FALSE , only the current group of the object presentation is changed. 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. It modifies all existing presentations of <anObj> (if any), so it is reasonable to call this method after <anObj> has been displayed. Otherwise, Compute() method should pass Graphic3d_AspectFillArea3d aspect from <myDrawer> to Graphic3d_Group to make polygon offsets work. 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 BoundingBox (Bnd_Box &theBndBox) override
 Returns bounding box of object correspondingly to its current display mode. More...
 
void SetIsoOnTriangulation (const Standard_Boolean theIsEnabled)
 Enables or disables on-triangulation build of isolines according to the flag given. More...
 
- Public Member Functions inherited from SelectMgr_SelectableObject
virtual ~SelectMgr_SelectableObject ()
 Clears all selections of the object. 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 aMode) const
 Returns the selection Selection having the selection mode aMode. More...
 
virtual 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...
 
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...
 
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_PresentationManager3d > &PM, const SelectMgr_SequenceOfOwner &Seq)
 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 HilightOwnerWithColor (const Handle< PrsMgr_PresentationManager3d > &thePM, const Quantity_NameOfColor theColor, 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 newAutoHilight)
 Set AutoHilight property to true or false Sets up Transform Persistence Mode for this object. More...
 
Handle< Prs3d_PresentationGetHilightPresentation (const Handle< PrsMgr_PresentationManager3d > &TheMgr)
 
Handle< Prs3d_PresentationGetSelectPresentation (const Handle< PrsMgr_PresentationManager3d > &TheMgr)
 
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...
 
virtual void SetAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Initializes the drawing tool theDrawer. More...
 
const Handle< Prs3d_Drawer > & Attributes () const
 Returns the attributes settings. More...
 
virtual void SetHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Initializes the hilight drawing tool theDrawer. More...
 
const Handle< Prs3d_Drawer > & HilightAttributes () const
 Returns the hilight attributes settings. More...
 
virtual void UnsetHilightAttributes ()
 Clears settings provided by the hilight drawing tool theDrawer. More...
 
void SetAssemblyOwner (const Handle< SelectMgr_EntityOwner > &theOwner, const Standard_Integer theMode=-1)
 Sets common entity owner for assembly sensitive object entities. More...
 
const Handle< SelectMgr_EntityOwner > & GetAssemblyOwner () const
 Returns common entity owner if the object is an assembly. More...
 
Bnd_Box BndBoxOfSelected (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. More...
 
virtual Handle< SelectMgr_EntityOwnerGlobalSelOwner () const
 Returns the owner of mode for selection of object as a whole. More...
 
- Public Member Functions inherited from PrsMgr_PresentableObject
PrsMgr_PresentationsPresentations ()
 
PrsMgr_TypeOfPresentation3d TypeOfPresentation3d () const
 Returns information on whether the object accepts display in HLR mode or not. More...
 
virtual void SetTransformPersistence (const Graphic3d_TransModeFlags &aFlag, const gp_Pnt &APoint)
 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 APoint parameter (except Graphic3d_TMF_TriedronPers flag. More...
 
void SetTransformPersistence (const Graphic3d_TransModeFlags &aFlag)
 Calls previous method with point (0,0,0) 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...
 
const Graphic3d_TransformPersTransformPersistence () const
 
void SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d aType)
 
void SetToUpdate (const Standard_Integer aMode)
 flags the Prs of mode <AMode> to be Updated. the Update will be done when needed. More...
 
void SetToUpdate ()
 flags all the Presentations to be Updated. More...
 
void ToBeUpdated (TColStd_ListOfInteger &ListOfMode) const
 gives the list of modes which are flagged "to be updated". More...
 
virtual void SetLocalTransformation (const gp_Trsf &theTransformation)
 Sets local transformation to theTransformation. More...
 
Standard_Boolean HasTransformation () const
 Returns true if object has a transformation that is different from the identity. More...
 
const gp_TrsfLocalTransformation () const
 
const gp_TrsfTransformation () const
 
const gp_TrsfInversedTransformation () const
 
virtual void UpdateTransformation (const Handle< Prs3d_Presentation > &P)
 
Graphic3d_ZLayerId ZLayer () const
 Get ID of Z layer. 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 substracted 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...
 
virtual void SetClipPlanes (const 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 substracted from limit to predict the maximum possible number of object clipping planes. More...
 
const Graphic3d_SequenceOfHClipPlaneGetClipPlanes () const
 Get clip planes. 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 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 AddChild (const Handle< PrsMgr_PresentableObject > &theObject)
 Makes theObject child of current object in scene hierarchy. More...
 
virtual void RemoveChild (const Handle< PrsMgr_PresentableObject > &theObject)
 Removes theObject from children of current object in scene hierarchy. More...
 
const PrsMgr_ListOfPresentableObjectsChildren () const
 Returns children of the current object. More...
 
Standard_Boolean HasOwnPresentations () const
 Returns true if object should have own presentations. More...
 
PrsMgr_PresentableObjectPointer Parent () const
 Returns parent of current object in scene hierarchy. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const override
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const 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, Quantity_Color &theColor)
 
- Static Public Member Functions inherited from SelectMgr_SelectableObject
static void InitDefaultHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Initializes theDrawer by default hilight settings. 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...
 

Protected Member Functions

void drawFrame (const Handle< Prs3d_Presentation > &thePresentation, const Standard_Integer theX, const Standard_Integer theY, const Standard_Integer theWidth, const Standard_Integer theHeight, const Quantity_Color &theColor)
 Draws a frame. More...
 
void drawText (const Handle< Prs3d_Presentation > &thePresentation, const TCollection_ExtendedString &theText, const Standard_Integer theX, const Standard_Integer theY, const Quantity_Color &theColor)
 Draws a text. 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)
 
void setGlobalSelMode (const Standard_Integer theMode)
 
- Protected Member Functions inherited from PrsMgr_PresentableObject
 PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 
virtual ~PrsMgr_PresentableObject ()
 
virtual void Compute (const Handle< Prs3d_Projector > &aProjector, const Handle< Prs3d_Presentation > &aPresentation)
 Calculates the 3D view aPresentation and its updates. The latter are managed by aPresentationManager. 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 > &aProjector, const Handle< Geom_Transformation > &aTrsf, const Handle< Prs3d_Presentation > &aPresentation)
 Calculates the 3D view aPresentation and its updates. The latter are managed by aPresentationManager. A point of view is provided by the projector aProjector, and the geometric transformation which has transformed associated presentable objects is specified by aTrsf. 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 aTrsf must be applied to the object before computation. More...
 
void Update (const Standard_Boolean AllModes=Standard_False)
 recomputes all presentations of the object. More...
 
void Update (const Standard_Integer aMode, const Standard_Boolean ClearOther)
 Recomputes the presentation in the given mode. If ClearOther is true, other presentation will be cleared. More...
 
virtual void Fill (const Handle< PrsMgr_PresentationManager > &aPresentationManager, const Handle< PrsMgr_Presentation > &aPresentation, const Standard_Integer aMode=0)
 High-level interface for controlling polygon offsets. More...
 
virtual void SetCombinedParentTransform (const gp_Trsf &theTransformation)
 Sets myCombinedParentTransform to theTransformation. Thus object receives transformation from parent node and able to derive its own. More...
 
virtual void UpdateClipping ()
 General virtual method for internal update of presentation state when some modifications on list of clip planes occurs. Base implementation propagate clip planes to every presentation. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Protected Attributes inherited from AIS_InteractiveObject
Standard_Real myTransparency
 
Quantity_Color myOwnColor
 
Graphic3d_NameOfMaterial myOwnMaterial
 
Standard_Integer myHilightMode
 
Standard_Real myOwnWidth
 
Standard_Boolean myInfiniteState
 
Standard_Boolean hasOwnColor
 
Standard_Boolean hasOwnMaterial
 
Aspect_TypeOfFacingModel myCurrentFacingModel
 
Standard_Boolean myRecomputeEveryPrs
 
TColStd_ListOfInteger myToRecomputeModes
 
- Protected Attributes inherited from SelectMgr_SelectableObject
SelectMgr_SequenceOfSelection myselections
 
Handle< Prs3d_DrawermyDrawer
 
Handle< Prs3d_DrawermyHilightDrawer
 
Handle< SelectMgr_EntityOwnermyAssemblyOwner
 
- Protected Attributes inherited from PrsMgr_PresentableObject
PrsMgr_Presentations myPresentations
 
PrsMgr_TypeOfPresentation3d myTypeOfPresentation3d
 
Graphic3d_SequenceOfHClipPlane myClipPlanes
 
Standard_Boolean myIsMutable
 
Graphic3d_ZLayerId myZLayer
 
Standard_Boolean myHasOwnPresentations
 

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

Default constructor.

Member Function Documentation

void AIS_ColorScale::drawFrame ( const Handle< Prs3d_Presentation > &  thePresentation,
const Standard_Integer  theX,
const Standard_Integer  theY,
const Standard_Integer  theWidth,
const Standard_Integer  theHeight,
const Quantity_Color theColor 
)
protected

Draws a frame.

Parameters
theX[in] the X coordinate of frame position.
theY[in] the Y coordinate of frame position.
theWidth[in] the width of frame.
theHeight[in] the height of frame.
theColor[in] the color of frame.
void AIS_ColorScale::drawText ( const Handle< Prs3d_Presentation > &  thePresentation,
const TCollection_ExtendedString theText,
const Standard_Integer  theX,
const Standard_Integer  theY,
const Quantity_Color theColor 
)
protected

Draws a text.

Parameters
theText[in] the text to draw.
theX[in] the X coordinate of text position.
theY[in] the Y coordinate of text position.
theColor[in] the color of text.
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.

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 
)
static
Standard_Integer AIS_ColorScale::GetBreadth ( ) const
inline

Returns the breadth of color bar.

void AIS_ColorScale::GetColors ( Aspect_SequenceOfColor theColors) const

Returns the user specified colors.

Aspect_TypeOfColorScaleData AIS_ColorScale::GetColorType ( ) const
inline

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

TCollection_AsciiString AIS_ColorScale::GetFormat ( ) const
inline

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

Standard_Integer AIS_ColorScale::GetHeight ( ) const
inline

Returns the height of color bar.

Quantity_Color AIS_ColorScale::GetIntervalColor ( const Standard_Integer  theIndex) const

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

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.

Aspect_TypeOfColorScalePosition AIS_ColorScale::GetLabelPosition ( ) const
inline

Returns the position of labels concerning color filled rectangles.

void AIS_ColorScale::GetLabels ( TColStd_SequenceOfExtendedString theLabels) const

Returns the user specified labels.

Aspect_TypeOfColorScaleData AIS_ColorScale::GetLabelType ( ) const
inline

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

Standard_Real AIS_ColorScale::GetMax ( ) const
inline

Returns maximal value of color scale;.

Standard_Real AIS_ColorScale::GetMin ( ) const
inline

Returns minimal value of color scale;.

Standard_Integer AIS_ColorScale::GetNumberOfIntervals ( ) const
inline

Returns the number of color scale intervals;.

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

Returns the position of color scale.

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

Returns minimal and maximal values of color scale;.

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

Returns the size of color bar.

Standard_Integer AIS_ColorScale::GetTextHeight ( ) const
inline

Returns the height of text of color scale.

TCollection_ExtendedString AIS_ColorScale::GetTitle ( ) const
inline

Returns the color scale title string;.

Aspect_TypeOfColorScalePosition AIS_ColorScale::GetTitlePosition ( ) const
inline

Returns the position of color scale title.

Standard_Integer AIS_ColorScale::GetXPosition ( ) const
inline

Returns the X position of color scale.

Standard_Integer AIS_ColorScale::GetYPosition ( ) const
inline

Returns the height of color scale.

Standard_Boolean AIS_ColorScale::IsLabelAtBorder ( ) const
inline

Returns true if the labels are placed at border of color intervals.

Standard_Boolean AIS_ColorScale::IsLogarithmic ( ) const
inline

Returns true if the color scale has logarithmic intervals.

Standard_Boolean AIS_ColorScale::IsReversed ( ) const
inline

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

void AIS_ColorScale::SetBreadth ( const Standard_Integer  theBreadth)

Sets the width of color bar.

void AIS_ColorScale::SetColors ( const Aspect_SequenceOfColor theSeq)

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

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

void AIS_ColorScale::SetFormat ( const TCollection_AsciiString theFormat)

Sets the color scale auto label format specification.

void AIS_ColorScale::SetHeight ( const Standard_Integer  theHeight)

Sets the height of color bar.

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

Sets the color of the specified interval. Index is in range from 1 to GetNumberOfIntervals().

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

Sets the color scale label at index. Index is in range from 1 to GetNumberOfIntervals() or to GetNumberOfIntervals() + 1 if IsLabelAtBorder() is true.

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

void AIS_ColorScale::SetLabelPosition ( const Aspect_TypeOfColorScalePosition  thePos)

Sets the color scale labels position relative to color bar.

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.

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

void AIS_ColorScale::SetLogarithmic ( const Standard_Boolean  isLogarithmic)
inline

Sets true if the color scale has logarithmic intervals.

void AIS_ColorScale::SetMax ( const Standard_Real  theMax)

Sets the maximal value of color scale.

void AIS_ColorScale::SetMin ( const Standard_Real  theMin)

Sets the minimal value of color scale.

void AIS_ColorScale::SetNumberOfIntervals ( const Standard_Integer  theNum)

Sets the number of color scale intervals.

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

Sets the position of color scale.

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

Sets the minimal and maximal value of color scale.

void AIS_ColorScale::SetReversed ( const Standard_Boolean  theReverse)

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

void AIS_ColorScale::SetSize ( const Standard_Integer  theWidth,
const Standard_Integer  theHeight 
)

Sets the size of color bar.

void AIS_ColorScale::SetTextHeight ( const Standard_Integer  theHeight)
inline

Sets the height of text of color scale.

void AIS_ColorScale::SetTitle ( const TCollection_ExtendedString theTitle)

Sets the color scale title string.

void AIS_ColorScale::SetTitlePosition ( const Aspect_TypeOfColorScalePosition  thePos)

Sets the color scale title position.

void AIS_ColorScale::SetXPosition ( const Standard_Integer  theX)

Sets the X position of color scale.

void AIS_ColorScale::SetYPosition ( const Standard_Integer  theY)

Sets the Y position of color scale.

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.
void AIS_ColorScale::TextSize ( const TCollection_ExtendedString theText,
const Standard_Integer  theHeight,
Standard_Integer theWidth,
Standard_Integer theAscent,
Standard_Integer theDescent 
) const
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: