|
| | PrsDim_Dimension (const PrsDim_KindOfDimension theType) |
| | Constructor with default parameters values.
|
| |
| double | GetValue () const |
| | Gets dimension measurement value. If the value to display is not specified by user, then the dimension object is responsible to compute it on its own in model space coordinates.
|
| |
| void | SetComputedValue () |
| | Sets computed dimension value. Resets custom value mode if it was set.
|
| |
| void | SetCustomValue (const double theValue) |
| | Sets user-defined dimension value. The user-defined dimension value is specified in model space, and affect by unit conversion during the display.
|
| |
| void | SetCustomValue (const TCollection_ExtendedString &theValue) |
| | Sets user-defined dimension value. Unit conversion during the display is not applied.
|
| |
| const TCollection_ExtendedString & | GetCustomValue () const |
| | Gets user-defined dimension value.
|
| |
| const gp_Pln & | GetPlane () const |
| | Get the dimension plane in which the 2D dimension presentation is computed. By default, if plane is not defined by user, it is computed automatically after dimension geometry is computed. If computed dimension geometry (points) can't be placed on the user-defined plane, dimension geometry was set as invalid (validity flag is set to false) and dimension presentation will not be computed. If user-defined plane allow geometry placement on it, it will be used for computing of the dimension presentation.
|
| |
| int | GetGeometryType () const |
| | Geometry type defines type of shapes on which the dimension is to be built.
|
| |
| virtual void | SetCustomPlane (const gp_Pln &thePlane) |
| | Sets user-defined plane where the 2D dimension presentation will be placed. Checks validity of this plane if geometry has been set already. Validity of the plane is checked according to the geometry set and has different criteria for different kinds of dimensions.
|
| |
| void | UnsetCustomPlane () |
| | Unsets user-defined plane. Therefore the plane for dimension will be computed automatically.
|
| |
| bool | IsTextPositionCustom () const |
| |
| virtual void | SetTextPosition (const gp_Pnt &) |
| | Fixes the absolute text position and adjusts flyout, plane and text alignment according to it. Updates presentation if the text position is valid. ATTENTION! It does not change vertical text alignment.
|
| |
| virtual gp_Pnt | GetTextPosition () const |
| | Computes absolute text position from dimension parameters (flyout, plane and text alignment).
|
| |
| occ::handle< Prs3d_DimensionAspect > | DimensionAspect () const |
| | Gets the dimension aspect from AIS object drawer. Dimension aspect contains aspects of line, text and arrows for dimension presentation.
|
| |
| void | SetDimensionAspect (const occ::handle< Prs3d_DimensionAspect > &theDimensionAspect) |
| | Sets new dimension aspect for the interactive object drawer. The dimension aspect provides dynamic properties which are generally used during computation of dimension presentations.
|
| |
| PrsDim_KindOfDimension | KindOfDimension () const |
| |
| AIS_KindOfInteractive | Type () const override |
| |
| bool | AcceptDisplayMode (const int theMode) const override |
| | Returns true if the class of objects accepts the display mode theMode. The interactive context can have a default mode of representation for the set of Interactive Objects. This mode may not be accepted by object.
|
| |
| PrsDim_DisplaySpecialSymbol | DisplaySpecialSymbol () const |
| |
| void | SetDisplaySpecialSymbol (const PrsDim_DisplaySpecialSymbol theDisplaySpecSymbol) |
| | Specifies whether to display special symbol or not.
|
| |
| char16_t | SpecialSymbol () const |
| |
| void | SetSpecialSymbol (const char16_t theSpecialSymbol) |
| | Specifies special symbol.
|
| |
| virtual const TCollection_AsciiString & | GetDisplayUnits () const |
| |
| virtual const TCollection_AsciiString & | GetModelUnits () const |
| |
| virtual void | SetDisplayUnits (const TCollection_AsciiString &) |
| |
| virtual void | SetModelUnits (const TCollection_AsciiString &) |
| |
| void | UnsetFixedTextPosition () |
| | Unsets user defined text positioning and enables text positioning by other parameters: text alignment, extension size, flyout and custom plane.
|
| |
| double | SelToleranceForText2d () const |
| | Returns selection tolerance for text2d: For 2d text selection detection sensitive point with tolerance is used Important! Only for 2d text.
|
| |
| void | SetSelToleranceForText2d (const double theTol) |
| | Sets selection tolerance for text2d: For 2d text selection detection sensitive point with tolerance is used to change this tolerance use this method Important! Only for 2d text.
|
| |
| double | GetFlyout () const |
| |
| void | SetFlyout (const double theFlyout) |
| | Sets flyout value for dimension.
|
| |
| virtual bool | IsValid () const |
| | Check that the input geometry for dimension is valid and the presentation can be successfully computed.
|
| |
| 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.
|
| |
| | ~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.
|
| |
| 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.
|
| |
|
| double | ValueToDisplayUnits () const |
| |
| TCollection_ExtendedString | GetValueString (double &theWidth) const |
| | Get formatted value string and its model space width.
|
| |
| void | DrawArrow (const occ::handle< Prs3d_Presentation > &thePresentation, const gp_Pnt &theLocation, const gp_Dir &theDirection) |
| | Performs drawing of 2d or 3d arrows on the working plane.
|
| |
| void | drawText (const occ::handle< Prs3d_Presentation > &thePresentation, const gp_Pnt &theTextPos, const gp_Dir &theTextDir, const TCollection_ExtendedString &theText, const int theLabelPosition) |
| | Performs drawing of 2d or 3d text on the working plane.
|
| |
| void | DrawExtension (const occ::handle< Prs3d_Presentation > &thePresentation, const double theExtensionSize, const gp_Pnt &theExtensionStart, const gp_Dir &theExtensionDir, const TCollection_ExtendedString &theLabelString, const double theLabelWidth, const int theMode, const int theLabelPosition) |
| | Performs computing of dimension linear extension with text.
|
| |
| void | DrawLinearDimension (const occ::handle< Prs3d_Presentation > &thePresentation, const int theMode, const gp_Pnt &theFirstPoint, const gp_Pnt &theSecondPoint, const bool theIsOneSide=false) |
| | Performs computing of linear dimension (for length, diameter, radius and so on). Please note that this method uses base dimension properties, like working plane flyout length, drawer attributes.
|
| |
| virtual void | ComputeFlyoutLinePoints (const gp_Pnt &theFirstPoint, const gp_Pnt &theSecondPoint, gp_Pnt &theLineBegPoint, gp_Pnt &theLineEndPoint) |
| | Computes points bounded the flyout line for linear dimension.
|
| |
| void | ComputeLinearFlyouts (const occ::handle< SelectMgr_Selection > &theSelection, const occ::handle< SelectMgr_EntityOwner > &theOwner, const gp_Pnt &theFirstPoint, const gp_Pnt &theSecondPoint) |
| | Compute selection sensitives for linear dimension flyout lines (length, diameter, radius). Please note that this method uses base dimension properties: working plane and flyout length.
|
| |
| bool | InitCircularDimension (const TopoDS_Shape &theShape, gp_Circ &theCircle, gp_Pnt &theMiddleArcPoint, bool &theIsClosed) |
| | Performs initialization of circle and middle arc point from the passed shape which is assumed to contain circular geometry.
|
| |
| void | PointsForArrow (const gp_Pnt &thePeakPnt, const gp_Dir &theDirection, const gp_Dir &thePlane, const double theArrowLength, const double theArrowAngle, gp_Pnt &theSidePnt1, gp_Pnt &theSidePnt2) |
| | Produce points for triangular arrow face.
|
| |
| gp_Pnt | GetTextPositionForLinear (const gp_Pnt &theFirstPoint, const gp_Pnt &theSecondPoint, const bool theIsOneSide=false) const |
| | Compute point of text position for dimension parameters for linear kinds of dimensions (length, radius, diameter).
|
| |
| void | FitTextAlignmentForLinear (const gp_Pnt &theFirstPoint, const gp_Pnt &theSecondPoint, const bool theIsOneSide, const Prs3d_DimensionTextHorizontalPosition &theHorizontalTextPos, int &theLabelPosition, bool &theIsArrowsExternal) const |
| | Fits text alignment relatively to the dimension line.
|
| |
| bool | AdjustParametersForLinear (const gp_Pnt &theTextPos, const gp_Pnt &theFirstPoint, const gp_Pnt &theSecondPoint, double &theExtensionSize, Prs3d_DimensionTextHorizontalPosition &theAlignment, double &theFlyout, gp_Pln &thePlane, bool &theIsPlaneOld) const |
| | Adjusts aspect parameters according the text position: extension size, vertical text alignment and flyout.
|
| |
|
Override this method to check if user-defined plane is valid for the dimension geometry.
- Parameters
-
| [in] | thePlane | the working plane for positioning every dimension in the application. |
- Returns
- true is the plane is suitable for building dimension with computed dimension geometry.
|
| virtual bool | CheckPlane (const gp_Pln &) const |
| | Override this method to computed value of dimension.
|
| |
| virtual double | ComputeValue () const |
| | Override this method to computed value of dimension.
|
| |
| virtual void | ComputeFlyoutSelection (const occ::handle< SelectMgr_Selection > &, const occ::handle< SelectMgr_EntityOwner > &) |
| | Override this method to compute selection primitives for flyout lines (if the dimension provides it). This callback is a only a part of base selection computation routine.
|
| |
| void | ComputeSelection (const occ::handle< SelectMgr_Selection > &theSelection, const int theMode) override |
| | Base procedure of computing selection (based on selection geometry data).
|
| |
| | 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.
|
| |
| | 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 | Compute (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const occ::handle< Prs3d_Presentation > &thePrs, const int theMode)=0 |
| | Calculates the 3D view presentation for specified display mode. This is a key interface for implementing Presentable Object interface.
|
| |
| 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.
|
| |
PrsDim_Dimension is a base class for 2D presentations of linear (length, diameter, radius) and angular dimensions.
The dimensions provide measurement of quantities, such as lengths or plane angles. The measurement of dimension "value" is done in model space "as is". These "value" are said to be represented in "model units", which can be specified by user. During the display the measured value converted from "model units" to "display units". The display and model units are stored in common Prs3d_Drawer (drawer of the context) to share it between all dimensions. The specified by user units are stored in the dimension's drawer.
As a drawing, the dimension is composed from the following components:
- Attachment (binding) points. The points where the dimension lines attaches to, for length dimensions the distances are measured between these points.
- Main dimension line. The which extends from the attachment points in "up" direction, and which contains text label on it with value string.
- Flyouts. The lines connecting the attachment points with main dimension line.
- Extension. The lines used to extend the main dimension line in the cases when text or arrows do not fit into the main dimension line due to their size.
- Arrows.
Linear dimensions:
extension
line arrow
-->|------- main dimension line -------|<--
| |
|flyout flyout|
| |
+-----------------------------------+
attachment attachment
point point
Angular dimensions:
extension
line
-->|+++++
arrow | +++
| 90(deg) - main dimension line
flyout | +++
| +
o---flyout---
center ^
point | extension
line
Being a 2D drawings, the dimensions are created on imaginary plane, called "dimension plane", which can be thought of as reference system of axes (X,Y,N) for constructing the presentation.
The role of axes of the dimension plane is to guide you through the encapsulated automations of presentation building to help you understand how is the presentation will look and how it will be oriented in model space during construction.
Orientation of dimension line in model space relatively to the base shapes is defined with the flyouts. Flyouts specify length of flyout lines and their orientation relatively to the attachment points on the working plane. For linear dimensions: Direction of flyouts is specified with direction of main dimension line (vector from the first attachment to the second attachment) and the normal of the dimension plane. Positive direction of flyouts is defined by vector multiplication: AttachVector * PlaneNormal. For angular dimensions: Flyouts are defined by vectors from the center point to the attachment points. These vectors directions are supposed to be the positive directions of flyouts. Negative flyouts directions means that these vectors should be reversed (and dimension will be built out of the angle constructed with center and two attach points).
The dimension plane can be constructed automatically by application (where possible, it depends on the measured geometry). It can be also set by user. However, if the user-defined plane does not fit the geometry of the dimension (attach points do not belong to it), the dimension could not be built. If it is not possible to compute automatic plane (for example, in case of length between two points) the user is supposed to specify the custom plane.
Since the dimensions feature automated construction procedures from an arbitrary shapes, the interfaces to check the validness are also implemented. Once the measured geometry is specified, the one can inquire the validness status by calling "IsValid()" method. If the result is TRUE, then all of public parameters should be pre-computed and ready. The presentation should be also computable. Otherwise, the parameters may return invalid values. In this case, the presentation will not be computed and displayed.
The dimension support two local selection modes: main dimension line selection and text label selection. These modes can be used to develop interactive modification of dimension presentations. The component highlighting in these selection modes is provided by PrsDim_DimensionOwner class. Please note that selection is unavailable until the presentation is computed.
The specific drawing attributes are controlled through Prs3d_DimensionAspect. The one can change color, arrows, text and arrow style and specify positioning of value label by setting corresponding values to the aspect.
Such set of parameters that consists of:
- flyout size and direction,
- user-defined dimension plane,
- horizontal and vertical text alignment can be uniquely replaced with text position in 3d space. Therefore, there are methods to convert this set of parameters to the text position and vice versa:
- If the fixed text position is defined by user, called SetTextPosition (theTextPos) method converts this 3d point to the set of parameters including adjusting of the dimension plane (this plane will be automatic plane, NOT user-defined one). If the fixed text position is set, the flag myIsFixedTextPosition is set to TRUE. ATTENTION! myIsFixedTextPosition fixes all parameters of the set from recomputing inside SetMeasureGeometry() methods. Parameters in dimension aspect (they are horizontal text position and extension size) are adjusted on presentation computing step, user-defined values in dimension aspect are not changed. But plane and flyout as dimension position parameters are changed by SetTextPosition() method according with user-defined text position. If parameters from the set are changed by user with calls of setters, it leads to disabling of fixed text position (myIsFixedTextPosition is set to FALSE). If the fixed text position is set and geometry is changed by user (SetMeasureGeometry() method is called) and the geometry doesn't satisfy computed dimension plane, the dimension is not valid.
- If the set of parameters was set by user (may be without the user-defined plane or with it), it can be converted to the text position by calling the method GetTextPosition(). In this case the text position is NOT fixed, and SetMeasureGeometry() without user-defined plane adjusts the automatic plane according input geometry (if it is possible).
1.10.0