|
| AIS_ColorScale () |
| Default constructor.
|
|
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.
|
|
Standard_Real | GetMin () const |
| Returns minimal value of color scale, 0.0 by default.
|
|
void | SetMin (const Standard_Real theMin) |
| Sets the minimal value of color scale.
|
|
Standard_Real | GetMax () const |
| Returns maximal value of color scale, 1.0 by default.
|
|
void | SetMax (const Standard_Real theMax) |
| Sets the maximal value of color scale.
|
|
void | GetRange (Standard_Real &theMin, Standard_Real &theMax) const |
| Returns minimal and maximal values of color scale, 0.0 to 1.0 by default.
|
|
void | SetRange (const Standard_Real theMin, const Standard_Real theMax) |
| Sets the minimal and maximal value of color scale. Note that values order will be ignored - the minimum and maximum values will be swapped if needed. SetReversed() should be called to swap displaying order.
|
|
Standard_Real | HueMin () const |
| Returns the hue angle corresponding to minimum value, 230 by default (blue).
|
|
Standard_Real | HueMax () const |
| Returns the hue angle corresponding to maximum value, 0 by default (red).
|
|
void | HueRange (Standard_Real &theMinAngle, Standard_Real &theMaxAngle) const |
| Returns the hue angle range corresponding to minimum and maximum values, 230 to 0 by default (blue to red).
|
|
void | SetHueRange (const Standard_Real theMinAngle, const Standard_Real theMaxAngle) |
| Sets hue angle range corresponding to minimum and maximum values. The valid angle range is [0, 360], see Quantity_Color and Quantity_TOC_HLS for more details.
|
|
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.
|
|
Standard_Integer | GetNumberOfIntervals () const |
| Returns the number of color scale intervals, 10 by default.
|
|
void | SetNumberOfIntervals (const Standard_Integer 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 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.
|
|
Quantity_Color | GetIntervalColor (const Standard_Integer theIndex) const |
| Returns the user specified color from color map with index (starts at 1). Returns default color if index is out of range in color map.
|
|
void | SetIntervalColor (const Quantity_Color &theColor, const Standard_Integer theIndex) |
| Sets the color of the specified interval. Note that list is automatically resized to include specified index.
|
|
void | GetLabels (TColStd_SequenceOfExtendedString &theLabels) const |
| Returns the user specified labels.
|
|
const TColStd_SequenceOfExtendedString & | Labels () const |
| Returns the user specified labels.
|
|
void | SetLabels (const TColStd_SequenceOfExtendedString &theSeq) |
| Sets the color scale labels. The length of the sequence should be equal to GetNumberOfIntervals() or to GetNumberOfIntervals() + 1 if IsLabelAtBorder() is true. If length of the sequence does not much the number of intervals, then these labels will be considered as "free" and will be located at the virtual intervals corresponding to the number of labels (with flag IsLabelAtBorder() having the same effect as in normal case).
|
|
void | GetColors (Aspect_SequenceOfColor &theColors) const |
| Returns the user specified colors.
|
|
const Aspect_SequenceOfColor & | GetColors () const |
| Returns the user specified colors.
|
|
void | SetColors (const Aspect_SequenceOfColor &theSeq) |
| Sets the color scale colors. The length of the sequence should be equal to GetNumberOfIntervals().
|
|
void | SetUniformColors (Standard_Real theLightness, Standard_Real theHueFrom, Standard_Real 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.
|
|
Standard_Boolean | IsReversed () const |
| Returns TRUE if the labels and colors used in reversed order, FALSE by default.
|
|
void | SetReversed (const Standard_Boolean theReverse) |
| Sets true if the labels and colors used in reversed order.
|
|
Standard_Boolean | IsSmoothTransition () const |
| Return TRUE if color transition between neighbor intervals should be linearly interpolated, FALSE by default.
|
|
void | SetSmoothTransition (const Standard_Boolean theIsSmooth) |
| Setup smooth color transition.
|
|
Standard_Boolean | IsLabelAtBorder () const |
| Returns TRUE if the labels are placed at border of color intervals, TRUE by default. The automatically generated label will show value exactly on the current position:
|
|
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.
|
|
Standard_Boolean | IsLogarithmic () const |
| Returns TRUE if the color scale has logarithmic intervals, FALSE by default.
|
|
void | SetLogarithmic (const Standard_Boolean isLogarithmic) |
| Sets true if the color scale has logarithmic intervals.
|
|
void | SetLabel (const TCollection_ExtendedString &theLabel, const Standard_Integer theIndex) |
| Sets the color scale label at index. Note that list is automatically resized to include specified index.
|
|
void | GetSize (Standard_Integer &theBreadth, Standard_Integer &theHeight) const |
| Returns the size of color bar, 0 and 0 by default (e.g. should be set by user explicitly before displaying).
|
|
void | SetSize (const Standard_Integer theBreadth, const Standard_Integer theHeight) |
| Sets the size of color bar.
|
|
Standard_Integer | GetBreadth () const |
| Returns the breadth of color bar, 0 by default (e.g. should be set by user explicitly before displaying).
|
|
void | SetBreadth (const Standard_Integer theBreadth) |
| Sets the width of color bar.
|
|
Standard_Integer | GetHeight () const |
| Returns the height of color bar, 0 by default (e.g. should be set by user explicitly before displaying).
|
|
void | SetHeight (const Standard_Integer theHeight) |
| Sets the height of color bar.
|
|
void | GetPosition (Standard_Real &theX, Standard_Real &theY) const |
| Returns the bottom-left position of color scale, 0x0 by default.
|
|
void | SetPosition (const Standard_Integer theX, const Standard_Integer theY) |
| Sets the position of color scale.
|
|
Standard_Integer | GetXPosition () const |
| Returns the left position of color scale, 0 by default.
|
|
void | SetXPosition (const Standard_Integer theX) |
| Sets the left position of color scale.
|
|
Standard_Integer | GetYPosition () const |
| Returns the bottom position of color scale, 0 by default.
|
|
void | SetYPosition (const Standard_Integer theY) |
| Sets the bottom position of color scale.
|
|
Standard_Integer | GetTextHeight () const |
| Returns the font height of text labels, 20 by default.
|
|
void | SetTextHeight (const Standard_Integer theHeight) |
| Sets the height of text of color scale.
|
|
Standard_Integer | TextWidth (const TCollection_ExtendedString &theText) const |
| Returns the width of text.
|
|
Standard_Integer | TextHeight (const TCollection_ExtendedString &theText) const |
| Returns the height of text.
|
|
void | TextSize (const TCollection_ExtendedString &theText, const Standard_Integer theHeight, Standard_Integer &theWidth, Standard_Integer &theAscent, Standard_Integer &theDescent) const |
|
virtual Standard_Boolean | AcceptDisplayMode (const Standard_Integer theMode) const override |
| Return true if specified display mode is supported.
|
|
virtual void | Compute (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Handle< Prs3d_Presentation > &thePresentation, const Standard_Integer theMode) override |
| Compute presentation.
|
|
virtual void | ComputeSelection (const Handle< SelectMgr_Selection > &, const Standard_Integer) override |
| Compute selection - not implemented for color scale.
|
|
virtual AIS_KindOfInteractive | Type () const |
| Returns the kind of Interactive Object; AIS_KindOfInteractive_None by default.
|
|
virtual Standard_Integer | Signature () const |
| Specifies additional characteristics of Interactive Object of Type(); -1 by default. Among the datums, this signature is attributed to the shape. The remaining datums have the following default signatures:
|
|
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.
|
|
Standard_Boolean | 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 Handle< AIS_InteractiveContext > &aCtx) |
| Sets the interactive context aCtx and provides a link to the default drawing tool or "Drawer" if there is none.
|
|
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.
|
|
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:
|
|
void | SetOwner (const Handle< Standard_Transient > &theApplicativeEntity) |
| Allows you to attribute the owner theApplicativeEntity to an Interactive Object. This can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of. The owner takes the form of a transient.
|
|
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 Standard_Boolean | ProcessDragging (const Handle< AIS_InteractiveContext > &theCtx, const Handle< V3d_View > &theView, const Handle< SelectMgr_EntityOwner > &theOwner, const Graphic3d_Vec2i &theDragFrom, const Graphic3d_Vec2i &theDragTo, const AIS_DragAction theAction) |
| Drag object in the viewer.
|
|
Handle< AIS_InteractiveContext > | GetContext () const |
| Returns the context pointer to the interactive context.
|
|
Standard_Boolean | HasPresentation () const |
| Returns TRUE when this object has a presentation in the current DisplayMode()
|
|
Handle< Prs3d_Presentation > | Presentation () const |
| Returns the current presentation of this object according to the current DisplayMode()
|
|
void | SetAspect (const Handle< Prs3d_BasicAspect > &anAspect) |
| Sets the graphic basic aspect to the current presentation.
|
|
virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override |
| Dumps the content of me into the stream.
|
|
virtual | ~SelectMgr_SelectableObject () |
| Clears all selections of the object.
|
|
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.
|
|
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 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.
|
|
void | AddSelection (const Handle< SelectMgr_Selection > &aSelection, const Standard_Integer aMode) |
| Adds the selection aSelection with the selection mode index aMode to this framework.
|
|
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.
|
|
const Handle< SelectMgr_Selection > & | Selection (const Standard_Integer theMode) const |
| Returns the selection having specified selection mode or NULL.
|
|
Standard_Boolean | HasSelection (const Standard_Integer theMode) const |
| Returns true if a selection corresponding to the selection mode theMode was computed for this object.
|
|
const SelectMgr_SequenceOfSelection & | Selections () const |
| Return the sequence of selections.
|
|
void | ResetTransformation () override |
| resets local transformation to identity.
|
|
virtual void | UpdateTransformation () override |
| Recomputes the location of the selection aSelection.
|
|
virtual void | UpdateTransformations (const Handle< SelectMgr_Selection > &aSelection) |
| Updates locations in all sensitive entities from <aSelection> and in corresponding entity owners.
|
|
virtual void | HilightSelected (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const SelectMgr_SequenceOfOwner &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 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 Handle< PrsMgr_PresentationManager > &thePM, const Handle< Prs3d_Drawer > &theStyle, const Handle< SelectMgr_EntityOwner > &theOwner) |
| Method which hilight an owner belonging to this selectable object ( for fast presentation draw )
|
|
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.
|
|
virtual void | SetAutoHilight (const Standard_Boolean theAutoHilight) |
| Set AutoHilight property to true or false.
|
|
Handle< Prs3d_Presentation > | GetHilightPresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr) |
| Creates or returns existing presentation for highlighting detected object.
|
|
Handle< Prs3d_Presentation > | GetSelectPresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr) |
| Creates or returns existing presentation for highlighting selected object.
|
|
virtual void | ErasePresentations (Standard_Boolean theToRemove) |
| Removes presentations returned by GetHilightPresentation() and GetSelectPresentation().
|
|
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.
|
|
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.
|
|
void | SetAssemblyOwner (const Handle< SelectMgr_EntityOwner > &theOwner, const Standard_Integer theMode=-1) |
| Sets common entity owner for assembly sensitive object entities.
|
|
Bnd_Box | BndBoxOfSelected (const Handle< SelectMgr_IndexedMapOfOwner > &theOwners) |
| Returns a bounding box of sensitive entities with the owners given if they are a part of activated selection.
|
|
Standard_Integer | GlobalSelectionMode () const |
| Returns the mode for selection of object as a whole; 0 by default.
|
|
virtual Handle< SelectMgr_EntityOwner > | GlobalSelOwner () const |
| Returns the owner of mode for selection of object as a whole.
|
|
virtual const Handle< SelectMgr_EntityOwner > & | GetAssemblyOwner () const |
| Returns common entity owner if the object is an assembly.
|
|
PrsMgr_Presentations & | Presentations () |
| Return presentations.
|
|
Graphic3d_ZLayerId | ZLayer () const |
| Get ID of Z layer for main presentation.
|
|
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).
|
|
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.
|
|
const Handle< Graphic3d_ViewAffinity > & | ViewAffinity () const |
| Return view affinity mask.
|
|
Standard_Boolean | HasDisplayMode () const |
| Returns true if the Interactive Object has display mode setting overriding global setting (within Interactive Context).
|
|
Standard_Integer | DisplayMode () const |
| Returns the display mode setting of the Interactive Object. The range of supported display mode indexes should be specified within object definition and filtered by AccepDisplayMode().
|
|
void | SetDisplayMode (const Standard_Integer theMode) |
| Sets the display mode for the interactive object. An object can have its own temporary display mode, which is different from that proposed by the interactive context.
|
|
void | UnsetDisplayMode () |
| Removes display mode settings from the interactive object.
|
|
Standard_Boolean | HasHilightMode () const |
| Returns true if the Interactive Object is in highlight mode.
|
|
Standard_Integer | HilightMode () const |
| Returns highlight display mode. This is obsolete method for backward compatibility - use HilightAttributes() and DynamicHilightAttributes() instead.
|
|
void | SetHilightMode (const Standard_Integer theMode) |
| Sets highlight display mode. This is obsolete method for backward compatibility - use HilightAttributes() and DynamicHilightAttributes() instead.
|
|
void | UnsetHilightMode () |
| Unsets highlight display mode.
|
|
virtual Standard_Integer | DefaultDisplayMode () const |
| Returns the default display mode.
|
|
Standard_Boolean | ToBeUpdated (Standard_Boolean theToIncludeHidden=Standard_False) const |
| Returns TRUE if any active presentation has invalidation flag.
|
|
void | SetToUpdate (Standard_Integer theMode) |
| Flags presentation to be updated; UpdatePresentations() will recompute these presentations.
|
|
void | SetToUpdate () |
| flags all the Presentations to be Updated.
|
|
Standard_Boolean | IsInfinite () const |
| Returns true if the interactive object is infinite; FALSE by default. This flag affects various operations operating on bounding box of graphic presentations of this object. For instance, infinite objects are not taken in account for View FitAll. This does not necessarily means that object is actually infinite, auxiliary objects might be also marked with this flag to achieve desired behavior.
|
|
void | SetInfiniteState (const Standard_Boolean theFlag=Standard_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 Handle< Prs3d_Drawer > & | Attributes () const |
| Returns the attributes settings.
|
|
virtual void | SetAttributes (const Handle< Prs3d_Drawer > &theDrawer) |
| Initializes the drawing tool theDrawer.
|
|
const Handle< Prs3d_Drawer > & | HilightAttributes () const |
| Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalSelected and Prs3d_TypeOfHighlight_Selected defined within AIS_InteractiveContext::HighlightStyle().
|
|
virtual void | SetHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer) |
| Initializes the hilight drawing tool theDrawer.
|
|
const Handle< Prs3d_Drawer > & | DynamicHilightAttributes () const |
| Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalDynamic and Prs3d_TypeOfHighlight_Dynamic defined within AIS_InteractiveContext::HighlightStyle().
|
|
virtual void | SetDynamicHilightAttributes (const 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 Handle< Graphic3d_TransformPers > & | TransformPersistence () const |
| Returns Transformation Persistence defining a special Local Coordinate system where this presentable object is located or NULL handle if not defined. Position of the object having Transformation Persistence is mutable and depends on camera position. The same applies to a bounding box of the object.
|
|
virtual void | SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers) |
| Sets up Transform Persistence defining a special Local Coordinate system where this object should be located. Note that management of Transform Persistence object is more expensive than of the normal one, because it requires its position being recomputed basing on camera position within each draw call / traverse.
|
|
const 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 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.
|
|
Standard_Boolean | HasTransformation () const |
| Returns true if object has a transformation that is different from the identity.
|
|
const 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 Handle< TopLoc_Datum3D > & | CombinedParentTransformation () const |
| Return combined parent transformation.
|
|
const Handle< Graphic3d_SequenceOfHClipPlane > & | ClipPlanes () const |
| Get clip planes.
|
|
virtual void | SetClipPlanes (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes) |
| Set clip planes for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.
|
|
virtual void | AddClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane) |
| Adds clip plane for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.
|
|
virtual void | RemoveClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane) |
| Removes previously added clip plane.
|
|
PrsMgr_PresentableObject * | Parent () const |
| Returns parent of current object in scene hierarchy.
|
|
const PrsMgr_ListOfPresentableObjects & | Children () const |
| Returns children of the current object.
|
|
virtual void | AddChild (const Handle< PrsMgr_PresentableObject > &theObject) |
| Makes theObject child of current object in scene hierarchy.
|
|
void | AddChildWithCurrentTransformation (const Handle< PrsMgr_PresentableObject > &theObject) |
| Makes theObject child of current object in scene hierarchy with keeping the current global transformation So the object keeps the same position/orientation in the global CS.
|
|
virtual void | RemoveChild (const Handle< PrsMgr_PresentableObject > &theObject) |
| Removes theObject from children of current object in scene hierarchy.
|
|
void | RemoveChildWithRestoreTransformation (const Handle< PrsMgr_PresentableObject > &theObject) |
| Removes theObject from children of current object in scene hierarchy with keeping the current global transformation. So the object keeps the same position/orientation in the global CS.
|
|
Standard_Boolean | 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 Standard_Boolean theIsEnabled) |
| Enables or disables on-triangulation build of isolines according to the flag given.
|
|
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.
|
|
Standard_Boolean | 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.
|
|
Standard_Boolean | HasWidth () const |
| Returns true if the Interactive Object has width.
|
|
Standard_Real | Width () const |
| Returns the width setting of the Interactive Object.
|
|
virtual void | SetWidth (const Standard_Real theWidth) |
| Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting.
|
|
virtual void | UnsetWidth () |
| Reset width to default value.
|
|
Standard_Boolean | 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.
|
|
Standard_Boolean | IsTransparent () const |
| Returns true if there is a transparency setting.
|
|
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.
|
|
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.
|
|
virtual void | UnsetTransparency () |
| Removes the transparency setting. The object is opaque by default.
|
|
virtual Standard_Boolean | HasPolygonOffsets () const |
| Returns Standard_True if <myDrawer> has non-null shading aspect.
|
|
virtual void | PolygonOffsets (Standard_Integer &aMode, Standard_ShortReal &aFactor, Standard_ShortReal &aUnits) const |
| Retrieves current polygon offsets settings from <myDrawer>.
|
|
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.
|
|
virtual void | UnsetAttributes () |
| Clears settings provided by the drawing tool aDrawer.
|
|
void | ToBeUpdated (TColStd_ListOfInteger &ListOfMode) const |
| gives the list of modes which are flagged "to be updated".
|
|
Standard_Boolean | 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 Standard_Boolean 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 () |
| Destructor must be virtual.
|
|
virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object.
|
|
Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type.
|
|
Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName.
|
|
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.
|
|
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.
|
|
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.
|
|
Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object.
|
|
void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object.
|
|
Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value.
|
|
virtual void | Delete () const |
| Memory deallocator for transient classes.
|
|