1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // GEOM OBJECT : interactive object for Geometry entities visualization
24 // File : GEOM_Annotation.hxx
27 #ifndef GEOM_Annotation_HeaderFile
28 #define GEOM_Annotation_HeaderFile
30 #include <AIS_InteractiveObject.hxx>
31 #include <Bnd_Box.hxx>
32 #include <Font_FontAspect.hxx>
34 #include <NCollection_Handle.hxx>
35 #include <NCollection_String.hxx>
36 #include <OpenGl_Element.hxx>
37 #include <OpenGl_TextParam.hxx>
38 #include <Prs3d_Presentation.hxx>
39 #include <Prs3d_LineAspect.hxx>
40 #include <Prs3d_TextAspect.hxx>
41 #include <PrsMgr_PresentationManager3d.hxx>
42 #include <Select3D_SensitiveBox.hxx>
43 #include <SelectMgr_EntityOwner.hxx>
44 #include <StdSelect_Shape.hxx>
45 #include <TCollection_ExtendedString.hxx>
47 class OpenGl_GraphicDriver;
48 class OpenGl_PrimitiveArray;
53 * \class GEOM_Annotation
54 * \brief Interactive object, representating annotation entity
56 class GEOM_Annotation : public AIS_InteractiveObject
60 DEFINE_STANDARD_RTTIEXT( GEOM_Annotation, AIS_InteractiveObject )
62 //! Enumerates supported highlighting modes.
63 //! - HighlightAll : all elements of the annotation are highlighted.
64 //! - HighlightLabel : only annotation label is highlighted.
74 Standard_EXPORT GEOM_Annotation();
77 virtual ~GEOM_Annotation() {}
79 //! Sets annotation text string.
80 //! \param theText [in] the string displayed in annotation label.
81 Standard_EXPORT void SetText( const TCollection_ExtendedString& theText );
83 //! Returns annotation text string.
84 const TCollection_ExtendedString& GetText() const { return myText; }
86 //! Sets position of the annotation text label.
87 //! \param thePosition [in] the cartesian point defining the position of lower left
88 //! corner of the text label. When displayed in fixed screen position mode
89 //! (\sa SetScreenFixed) the position is defined as {x,y} pixel coordinate
90 //! of window space, otherwise 3D point defined in world's coordinate system
92 Standard_EXPORT void SetPosition( const gp_Pnt& thePosition );
94 //! Returns position of the annotation text label.
95 const gp_Pnt& GetPosition() const { return myPosition; }
97 //! Sets or disables "2D screen fixed" positioning mode. In this mode the annotation
98 //! is fixed at predefined pixel location in the window coordinate space. Other mode
99 //! is "3D screen aligned" positioning, when the label is aligned in plane of the
100 //! screen, while its position is a 3D point defined in world's coordinate system.
101 Standard_EXPORT void SetIsScreenFixed( const Standard_Boolean theIsFixed );
103 //! Returns value of "screen fixed" positioning mode.
104 Standard_Boolean GetIsScreenFixed() const { return myIsScreenFixed; }
106 //! Converts annotation position to screen fixed coordinates and
107 //! modifies its "2D screen fixed" flag correspondingly.
108 //! @param theView [in] the view to perform projection of coordinates.
109 Standard_EXPORT void Set2dPosition( const Handle(V3d_View)& theView );
111 //! Converts annotation position from screen fixed coordinates
112 //! to 3D position and modifies its "2D screen fixed" flag
114 //! @param theView [in] the view to perform projection of coordinates.
115 Standard_EXPORT void Set3dPosition( const Handle(V3d_View)& theView );
117 //! Sets attachment point of extension line.
118 //! \param thePoint [in] the 3D cartesian point defined in world's coordinate system
119 //! (a point on annotated geometry).
120 Standard_EXPORT void SetAttachPoint( const gp_Pnt& thePoint );
122 //! Returns attachment point of extension line.
123 const gp_Pnt& GetAttachPoint() const { return myAttach; }
125 //! Sets shape (annotated shape) that will be used for hilighting.
126 Standard_EXPORT void SetHilightShape( const TopoDS_Shape& theShape );
128 //! Returns the hilighting shape.
129 const TopoDS_Shape HilightShape() const { return myShape; }
133 //! Sets color for the presentation.
134 Standard_EXPORT virtual void SetColor( const Quantity_Color& theColor ) Standard_OVERRIDE;
137 Standard_EXPORT void SetTextColor( const Quantity_Color& theColor );
139 //! Returns color for the text's label.
140 Quantity_Color GetTextColor() const { return myDrawer->TextAspect()->Aspect()->Color(); }
142 //! Sets line's color.
143 Standard_EXPORT void SetLineColor( const Quantity_Color& theColor);
145 //! Returns color for the connection line.
146 Quantity_Color GetLineColor() const { return myDrawer->LineAspect()->Aspect()->Color(); }
148 //! Sets line width to be used for drawing the annotation's extension line and underline.
149 Standard_EXPORT void SetLineWidth( const Standard_Real theLineWidth );
151 //! Returns line width for drawing the annotation's extension line and underline.
152 Standard_Real GetLineWidth() const { return myDrawer->LineAspect()->Aspect()->Width(); }
154 //! Sets style of connection line.
155 Standard_EXPORT void SetLineStyle( const Aspect_TypeOfLine theStyle );
157 //! Retusn style of connection line.
158 Aspect_TypeOfLine GetLineStyle() const { return myDrawer->LineAspect()->Aspect()->Type(); }
160 //! Sets style of hidden connection line.
161 Standard_EXPORT void SetHiddenLineStyle( const Aspect_TypeOfLine theStyle );
163 //! Retusn style of hidden connection line.
164 Aspect_TypeOfLine GetHiddenLineStyle() const { return myDrawer->HiddenLineAspect()->Aspect()->Type(); }
166 //! Sets text height in pixels.
167 Standard_EXPORT void SetTextHeight( const Standard_Real theHeight );
169 //! Returns text's height in pixels.
170 Standard_Real GetTextHeight() const { return myDrawer->TextAspect()->Height(); }
172 //! Sets font aspect for label.
173 Standard_EXPORT void SetFontAspect( const Font_FontAspect theFontAspect );
175 //! Returns label's font aspect.
176 Font_FontAspect GetFontAspect() const { return myDrawer->TextAspect()->Aspect()->GetTextFontAspect(); }
178 //! Sets font used for drawing the label.
179 Standard_EXPORT void SetFont( const TCollection_AsciiString& theFont );
181 //! Returns font used for drawing the label.
182 TCollection_AsciiString GetFont() const { return myDrawer->TextAspect()->Aspect()->Font(); }
184 //! Sets annotation auto-hiding option.
185 //! \param theIsEnable [in] the option flag. If passed true, the annotation
186 //! will be automatically hidden in the view if the attachment point
187 //! goes outside of the view.
188 void SetAutoHide( const Standard_Boolean theIsEnable ) { myIsAutoHide = theIsEnable; }
190 //! Returns current state of the auto-hiding option.
191 Standard_Boolean GetAutoHide() const { return myIsAutoHide; }
193 //! Sets highlight mode used for display of presentation.
194 //! \param theMode [in] the one of the supported highlight modes.
195 void SetHighlightMode( const HighlightMode theMode ) { myHilightMode = theMode; }
197 //! Returns highlight mode
198 HighlightMode GetHilightMode() const { return myHilightMode; }
200 //! Sets special flag that allows disabling depth testing when rendering
201 //! the graphical presentation. When disable the hidden parts such as
202 //! lines and text become visible and a rendered with another drawing
203 //! aspect. This mode should be explicitly used with setting top layer
204 //! for the presentation. Otherwise the behavior is undefined.
205 Standard_EXPORT void SetDepthCulling( const Standard_Boolean theToEnable );
207 //! Returns depth culling state.
208 Standard_Boolean GetDepthCulling() const { return myIsDepthCulling; }
213 //! Restores default z-layer for this presentation.
214 Standard_EXPORT void SetDefaultZLayer();
216 //! Returns default position for placing annotation when its attachment point
217 //! has been determined.
218 //! @param theIsScreenFixed [in] the state of annotation's "2D screen fixed" mode.
219 //! @param theAttachPnt [in] the attachment point.
220 //! @param theOffset [in] the offset value for placing the position relative to attachment.s
221 //! @param theView [in] the view for projecting coordinates.
222 Standard_EXPORT static gp_Pnt GetDefaultPosition( const Standard_Boolean theIsScreenFixed,
223 const gp_Pnt& theAttachPnt,
224 const Standard_Real theOffset,
225 const Handle(V3d_View)& theView );
227 //! Converts 3d position to 2d on screen point.
228 //! @param thePosition [in] the 3d position.
229 //! @param theAttach [in] the attachment point.
230 //! @param theView [in] the view for projecting coordinates.
231 Standard_EXPORT static gp_Pnt ConvertPosition2d( const gp_Pnt& thePosition,
232 const gp_Pnt& theAttach,
233 const Handle(V3d_View)& theView );
235 //! Converts 2d position to 3d point.
236 //! @param thePosition [in] the 2d position.
237 //! @param theAttach [in] the attachment point.
238 //! @param theView [in] the view for projecting coordinates.
239 Standard_EXPORT static gp_Pnt ConvertPosition3d( const gp_Pnt& thePosition,
240 const gp_Pnt& theAttach,
241 const Handle(V3d_View)& theView );
243 // Interactive dragging:
246 //! Prepares necessary data to perform dragging.
247 Standard_EXPORT void BeginDrag();
249 //! Drags annotation presentation in the screen plane using the given pixel delta.
250 //! \param theDx, theDy [in] the drag offset in pixels (from beginning of dragging).
251 //! \param theView [in] the current view for evaluating drag with 3D position mode.
252 Standard_EXPORT void Drag( const Standard_Integer theDx,
253 const Standard_Integer theDy,
254 const Handle(V3d_View)& theView );
256 //! Perform necessary update when dragging is finished.
257 Standard_EXPORT void EndDrag();
259 //! Perform necessary update when dragging need undo.
260 Standard_EXPORT void UndoDrag();
264 virtual void Compute( const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
265 const Handle(Prs3d_Presentation)& thePresentation,
266 const Standard_Integer theMode = 0 ) Standard_OVERRIDE;
268 virtual void ComputeSelection( const Handle(SelectMgr_Selection)& theSelection,
269 const Standard_Integer theMode ) Standard_OVERRIDE;
271 virtual void setLocalTransformation( const Handle(Geom_Transformation)& /*theTransformation*/ ) Standard_OVERRIDE {}
273 virtual void SetTransformPersistence( const Handle(Graphic3d_TransformPers)& /*theTrsfPers*/ ) Standard_OVERRIDE {}
275 Bnd_Box TextBoundingBox() const;
277 void SetPosition( const gp_Pnt& thePosition, const Standard_Boolean theUpdateSelection );
281 gp_Pnt myAttach; //!< Attachment point of extension line.
282 gp_Pnt myPosition; //!< Position of text label.
283 gp_Pnt myStartPosition; //!< Position before starting dragging operation.
284 Standard_Boolean myIsScreenFixed; //!< Flag indicating whether "screen fixed" positioning mode is turned on or off.
285 Standard_Boolean myIsAutoHide; //!< Flag indicating whether "auto-hiding" option is turned on.
286 Standard_Boolean myIsDepthCulling; //!< Flag indiciating whether the "depth culling" is turned on.
287 HighlightMode myHilightMode; //!< Highlight mode for presentation.
288 TCollection_ExtendedString myText; //!< Text string of the label presentation.
289 TopoDS_Shape myShape; //!< Hilighting shape.
293 //! Custom element implementing dynamic rendering of 3D annotation
294 //! and invoking dynamic callback in presentation class.
295 class OpenGl_Annotation : public OpenGl_Element
299 //! Constructor. Some of the input properties are assigned by reference for dynamic draw
300 //! (it is not likely that GL element will ever outlive the interactive object).
301 //! \param theAnnotation [in] the instance of interactive presentation class.
302 //! \param theTextHeight [in] the height of the text label.
303 //! \param theDriver [in] the instance of graphical driver required for initialization.
304 OpenGl_Annotation( GEOM_Annotation* theAnnotation,
305 const Standard_Integer theTextHeight,
306 const OpenGl_GraphicDriver* theDriver );
308 //! Destructor. Releases GL resources with NULL context.
309 virtual ~OpenGl_Annotation();
311 //! Releases GL resources with the given GL context.
312 virtual void Release( OpenGl_Context* theCtx ) Standard_OVERRIDE;
314 //! Renders the annotation graphical elements.
315 virtual void Render( const Handle(OpenGl_Workspace)& theWorkspace ) const Standard_OVERRIDE;
317 void SetDepthMode( const int theMode ) { myDepthMode = theMode; }
328 GEOM_Annotation* myAISObject; //!< Instance of presentation class.
329 NCollection_String myText; //!< Text string of annotation label.
330 OpenGl_TextParam myTextParams; //!< Text draw parameters.
331 OpenGl_Text* myTextDraw; //!< Text draw element.
332 OpenGl_PrimitiveArray* myTextLineDraw; //!< Text underline draw element.
333 OpenGl_PrimitiveArray* myExtLineDraw; //!< Extension line draw element.
334 OpenGl_PrimitiveArray* myExtMarkerDraw; //!< Extension marker draw element.
335 int myDepthMode; //!< Depth mode for drawing hidden line presentation.
336 mutable float myTextLineY; //!< Text's underlines relative position.
337 mutable TextSize myTextSize; //!< Text's size parameters
338 mutable Graphic3d_Vec2 myTextUnderline; //!< Text's underline position.
339 mutable unsigned int myTextDPI; //!< Text's DPI scale used for last rendering.
342 friend class OpenGl_Annotation; // allow opengl element to get private data and invoke callback methods
346 //! Custom entity owner implementing correct highlight for topmost mode.
347 class GEOM_AnnotationOwner : public SelectMgr_EntityOwner
352 GEOM_AnnotationOwner( const TopoDS_Shape& theShape,
353 const Handle(SelectMgr_SelectableObject)& theSelectable,
354 const Standard_Integer thePriority )
355 : SelectMgr_EntityOwner( theSelectable, thePriority ),
356 myShape( theShape ) {}
358 //! Perform highlighting of the presentation.
359 //! \param thePresentationMgr [in] the presentation manager.
360 //! \param theColor [in] the highlighting color.
361 //! \param theMode [in] the display mode.
363 HilightWithColor( const Handle(PrsMgr_PresentationManager3d)& thePM,
364 const Handle(Prs3d_Drawer)& theStyle,
365 const Standard_Integer theMode = 0 ) Standard_OVERRIDE;
367 //! Removes highlighting from the type of shape.
369 Unhilight ( const Handle(PrsMgr_PresentationManager)& thePM,
370 const Standard_Integer theMode = 0 ) Standard_OVERRIDE;
372 //! Clears the presentation manager object aPM of all shapes
373 //! with the given selection mode.
375 Clear ( const Handle(PrsMgr_PresentationManager)& thePM,
376 const Standard_Integer theMode = 0 ) Standard_OVERRIDE;
380 TopoDS_Shape myShape;
381 Handle(StdSelect_Shape) myPrsSh;
384 //! Custom sensitive entity with implementing option to support selection
385 //! with depth culling flag turned off.
386 class GEOM_AnnotationSensEntity : public Select3D_SensitiveBox
391 GEOM_AnnotationSensEntity( const Handle(SelectMgr_EntityOwner)& theOwner,
392 const Bnd_Box& theBox,
393 const Standard_Boolean theIsDepthCulling )
394 : Select3D_SensitiveBox( theOwner, theBox ),
395 myIsDepthCulling( theIsDepthCulling ) {}
397 //! Checks whether the box overlaps current selecting volume.
398 virtual Standard_Boolean Matches( SelectBasics_SelectingVolumeManager& theMgr,
399 SelectBasics_PickResult& thePickResult ) Standard_OVERRIDE
401 const Standard_Boolean isMatches = Select3D_SensitiveBox::Matches( theMgr, thePickResult );
402 if ( !myIsDepthCulling )
404 thePickResult = SelectBasics_PickResult( -DBL_MAX, thePickResult.DistToGeomCenter() );
411 Standard_Boolean myIsDepthCulling;
415 DEFINE_STANDARD_HANDLE( GEOM_Annotation, AIS_InteractiveObject )