GEOM_Annotation.hxx

Go to the documentation of this file.

// Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
//  GEOM OBJECT : interactive object for Geometry entities visualization
//  File   : GEOM_Annotation.hxx
//  Module : GEOM
//
#ifndef GEOM_Annotation_HeaderFile
#define GEOM_Annotation_HeaderFile
 
#include <AIS_InteractiveObject.hxx>
#include <Bnd_Box.hxx>
#include <Font_FontAspect.hxx>
#include <gp_Pnt.hxx>
#include <NCollection_Handle.hxx>
#include <NCollection_String.hxx>
#include <OpenGl_Element.hxx>
#include <Prs3d_Presentation.hxx>
#include <Prs3d_LineAspect.hxx>
#include <Prs3d_TextAspect.hxx>
#include <PrsMgr_PresentationManager3d.hxx>
#include <Select3D_SensitiveBox.hxx>
#include <SelectMgr_EntityOwner.hxx>
#include <StdSelect_Shape.hxx>
#include <TCollection_ExtendedString.hxx>
 
#include <Basics_OCCTVersion.hxx>
#if OCC_VERSION_LARGE >= 0x07040000
#include <Graphic3d_Text.hxx>
#else
#include <OpenGl_TextParam.hxx>
#endif
 
class OpenGl_GraphicDriver;
class OpenGl_PrimitiveArray;
class OpenGl_Text;
class V3d_View;
 
class GEOM_Annotation : public AIS_InteractiveObject
{
public:
 
  DEFINE_STANDARD_RTTIEXT( GEOM_Annotation, AIS_InteractiveObject )
 
  
  enum HighlightMode
  {
    HighlightAll   = 0,
    HighlightLabel = 1
  };
 
public:
 
  Standard_EXPORT GEOM_Annotation();
 
  virtual ~GEOM_Annotation() {}
 
  Standard_EXPORT void SetText( const TCollection_ExtendedString& theText );
 
  const TCollection_ExtendedString& GetText() const { return myText; }
 
  Standard_EXPORT void SetPosition( const gp_Pnt& thePosition );
 
  const gp_Pnt& GetPosition() const { return myPosition; }
 
  Standard_EXPORT void SetIsScreenFixed( const Standard_Boolean theIsFixed );
 
  Standard_Boolean GetIsScreenFixed() const { return myIsScreenFixed; }
 
  Standard_EXPORT void Set2dPosition( const Handle(V3d_View)& theView );
 
  Standard_EXPORT void Set3dPosition( const Handle(V3d_View)& theView );
 
  Standard_EXPORT void SetAttachPoint( const gp_Pnt& thePoint );
 
  const gp_Pnt& GetAttachPoint() const { return myAttach; }
 
  Standard_EXPORT void SetHilightShape( const TopoDS_Shape& theShape );
 
  const TopoDS_Shape HilightShape() const { return myShape; }
 
public:
 
  Standard_EXPORT virtual void SetColor( const Quantity_Color& theColor ) Standard_OVERRIDE;
 
  Standard_EXPORT void SetTextColor( const Quantity_Color& theColor );
 
  Quantity_Color GetTextColor() const { return myDrawer->TextAspect()->Aspect()->Color(); }
 
  Standard_EXPORT void SetLineColor( const Quantity_Color& theColor);
 
  Quantity_Color GetLineColor() const { return myDrawer->LineAspect()->Aspect()->Color(); }
 
  Standard_EXPORT void SetLineWidth( const Standard_Real theLineWidth );
 
  Standard_Real GetLineWidth() const { return myDrawer->LineAspect()->Aspect()->Width(); }
 
  Standard_EXPORT void SetLineStyle( const Aspect_TypeOfLine theStyle );
 
  Aspect_TypeOfLine GetLineStyle() const { return myDrawer->LineAspect()->Aspect()->Type(); }
 
  Standard_EXPORT void SetHiddenLineStyle( const Aspect_TypeOfLine theStyle );
 
  Aspect_TypeOfLine GetHiddenLineStyle() const { return myDrawer->HiddenLineAspect()->Aspect()->Type(); }
 
  Standard_EXPORT void SetTextHeight( const Standard_Real theHeight );
 
  Standard_Real GetTextHeight() const { return myDrawer->TextAspect()->Height(); }
 
  Standard_EXPORT void SetFontAspect( const Font_FontAspect theFontAspect );
 
  Font_FontAspect GetFontAspect() const { return myDrawer->TextAspect()->Aspect()->GetTextFontAspect(); }
 
  Standard_EXPORT void SetFont( const TCollection_AsciiString& theFont );
 
  TCollection_AsciiString GetFont() const { return myDrawer->TextAspect()->Aspect()->Font(); }
 
  void SetAutoHide( const Standard_Boolean theIsEnable ) { myIsAutoHide = theIsEnable; }
 
  Standard_Boolean GetAutoHide() const { return myIsAutoHide; }
 
  void SetHighlightMode( const HighlightMode theMode ) { myHilightMode = theMode; }
 
  HighlightMode GetHilightMode() const { return myHilightMode; }
 
  Standard_EXPORT void SetDepthCulling( const Standard_Boolean theToEnable );
 
  Standard_Boolean GetDepthCulling() const { return myIsDepthCulling; }
 
// Helper tools:
public:
 
  Standard_EXPORT void SetDefaultZLayer();
 
  Standard_EXPORT static gp_Pnt GetDefaultPosition( const Standard_Boolean theIsScreenFixed,
                                                    const gp_Pnt& theAttachPnt,
                                                    const Standard_Real theOffset,
                                                    const Handle(V3d_View)& theView );
 
  Standard_EXPORT static gp_Pnt ConvertPosition2d( const gp_Pnt& thePosition,
                                                   const gp_Pnt& theAttach,
                                                   const Handle(V3d_View)& theView );
 
  Standard_EXPORT static gp_Pnt ConvertPosition3d( const gp_Pnt& thePosition,
                                                   const gp_Pnt& theAttach,
                                                   const Handle(V3d_View)& theView );
 
// Interactive dragging:
public:
 
  Standard_EXPORT void BeginDrag();
 
  Standard_EXPORT void Drag( const Standard_Integer theDx,
                             const Standard_Integer theDy,
                             const Handle(V3d_View)& theView );
 
  Standard_EXPORT void EndDrag();
 
  Standard_EXPORT void UndoDrag();
 
private:
 
  virtual void Compute( const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
                        const Handle(Prs3d_Presentation)& thePresentation,
                        const Standard_Integer theMode = 0 ) Standard_OVERRIDE;
 
  virtual void ComputeSelection( const Handle(SelectMgr_Selection)& theSelection,
                                 const Standard_Integer theMode ) Standard_OVERRIDE;
 
#if OCC_VERSION_LARGE >= 0x070400ff
  virtual void setLocalTransformation( const Handle(TopLoc_Datum3D)& /*theTransformation*/ ) Standard_OVERRIDE {}
#else
  virtual void setLocalTransformation( const Handle(Geom_Transformation)& /*theTransformation*/ ) Standard_OVERRIDE {}
#endif
 
  virtual void SetTransformPersistence( const Handle(Graphic3d_TransformPers)& /*theTrsfPers*/ ) Standard_OVERRIDE {}
 
  Bnd_Box TextBoundingBox() const;
 
  void SetPosition( const gp_Pnt& thePosition, const Standard_Boolean theUpdateSelection );
 
private:
 
  gp_Pnt myAttach; 
  gp_Pnt myPosition; 
  gp_Pnt myStartPosition; 
  Standard_Boolean myIsScreenFixed; 
  Standard_Boolean myIsAutoHide; 
  Standard_Boolean myIsDepthCulling; 
  HighlightMode myHilightMode; 
  TCollection_ExtendedString myText; 
  TopoDS_Shape myShape; 
 
private:
 
  class OpenGl_Annotation : public OpenGl_Element
  {
  public:
 
    OpenGl_Annotation( GEOM_Annotation* theAnnotation,
                       const Standard_Integer theTextHeight,
                       const OpenGl_GraphicDriver* theDriver );
 
    virtual ~OpenGl_Annotation();
 
    virtual void Release( OpenGl_Context* theCtx ) Standard_OVERRIDE;
 
    virtual void Render( const Handle(OpenGl_Workspace)& theWorkspace ) const Standard_OVERRIDE;
 
    void SetDepthMode( const int theMode ) { myDepthMode = theMode; }
 
  private:
 
    struct TextSize {
      float x; // width
      float y; // height
      float a; // ascent
      float d; // descent
    };
 
    GEOM_Annotation* myAISObject;           
    NCollection_String myText;              
#if OCC_VERSION_LARGE >= 0x07040000
    Handle(Graphic3d_Text) myTextParams;    
#else
    OpenGl_TextParam myTextParams;          
#endif
    OpenGl_Text* myTextDraw;                
    OpenGl_PrimitiveArray* myTextLineDraw;  
    OpenGl_PrimitiveArray* myExtLineDraw;   
    OpenGl_PrimitiveArray* myExtMarkerDraw; 
    int myDepthMode;                        
    mutable float myTextLineY;              
    mutable TextSize myTextSize;            
    mutable Graphic3d_Vec2 myTextUnderline; 
    mutable unsigned int myTextDPI;         
  };
 
  friend class OpenGl_Annotation; // allow opengl element to get private data and invoke callback methods
 
public:
 
  class GEOM_AnnotationOwner : public SelectMgr_EntityOwner
  {
  public:
 
    GEOM_AnnotationOwner( const TopoDS_Shape& theShape,
                          const Handle(SelectMgr_SelectableObject)& theSelectable,
                          const Standard_Integer thePriority )
      : SelectMgr_EntityOwner( theSelectable, thePriority ),
        myShape( theShape ) {}
 
    virtual void
      HilightWithColor( const Handle(PrsMgr_PresentationManager3d)& thePM,
               const Handle(Prs3d_Drawer)& theStyle,
                        const Standard_Integer theMode = 0 ) Standard_OVERRIDE;
 
    virtual void
      Unhilight ( const Handle(PrsMgr_PresentationManager)& thePM,
                  const Standard_Integer theMode = 0 ) Standard_OVERRIDE;
 
    virtual void
      Clear ( const Handle(PrsMgr_PresentationManager)& thePM,
              const Standard_Integer theMode = 0 ) Standard_OVERRIDE;
 
  private:
 
    TopoDS_Shape myShape;
    Handle(StdSelect_Shape) myPrsSh;
  };
 
  class GEOM_AnnotationSensEntity : public Select3D_SensitiveBox
  {
  public:
 
    GEOM_AnnotationSensEntity( const Handle(SelectMgr_EntityOwner)& theOwner,
                               const Bnd_Box& theBox,
                               const Standard_Boolean theIsDepthCulling )
      : Select3D_SensitiveBox( theOwner, theBox ),
        myIsDepthCulling( theIsDepthCulling ) {}
 
    virtual Standard_Boolean Matches( SelectBasics_SelectingVolumeManager& theMgr,
                                      SelectBasics_PickResult& thePickResult ) Standard_OVERRIDE
    {
      const Standard_Boolean isMatches = Select3D_SensitiveBox::Matches( theMgr, thePickResult );
      if ( !myIsDepthCulling )
      {
        thePickResult = SelectBasics_PickResult( -DBL_MAX, thePickResult.DistToGeomCenter(), thePickResult.PickedPoint() );
      }
      return isMatches;
    }
 
  private:
 
    Standard_Boolean myIsDepthCulling;
  };
};
 
DEFINE_STANDARD_HANDLE( GEOM_Annotation, AIS_InteractiveObject )
 
#endif