GEOMGUI_AnnotationAttrs.h

Go to the documentation of this file.

// Copyright (C) 2007-2026  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
//
 
// File   : GEOMGUI_AnnotationAttrs.h
// Author : Anton POLETAEV, Open CASCADE S.A.S.
//
 
#ifndef GEOMGUI_ANNOTATIONATTRS_H
#define GEOMGUI_ANNOTATIONATTRS_H
 
// SALOME GUI includes
#include <GEOMGUI.h>
#include <SalomeApp_Study.h>
 
// OCCT includes
#include <gp_Ax3.hxx>
#include <gp_Pnt.hxx>
#include <Standard_Transient.hxx>
 
// Qt, STL includes
#include <QString>
 
class GEOM_Annotation;
class gp_Ax3;
 
class GEOMGUI_AnnotationAttrs : public Standard_Transient
{
public:
 
  DEFINE_STANDARD_RTTIEXT( GEOMGUI_AnnotationAttrs, Standard_Transient )
 
  
  GEOMGUI_EXPORT static Handle(GEOMGUI_AnnotationAttrs) FindAttributes( const _PTR(SObject)& theObject );
 
  GEOMGUI_EXPORT static Handle(GEOMGUI_AnnotationAttrs) FindOrCreateAttributes( const _PTR(SObject)& theObject,
                                                                                SalomeApp_Study* theStudy );
 
  GEOMGUI_EXPORT static void Remove( const _PTR(SObject)& theObject );
 
// Import / Export
public:
 
  GEOMGUI_EXPORT QString ExportAsPropertyString() const;
 
  GEOMGUI_EXPORT void ImportFromPropertyString( const QString& theString );
 
public:
 
  struct Properties
  {
    QString Text;          
    bool    IsVisible;     
    bool    IsScreenFixed; 
    gp_Pnt  Position;      
    gp_Pnt  Attach;        
    int     ShapeIndex;    
    int     ShapeType;     
  };
 
  GEOMGUI_EXPORT static void SetupPresentation( const Handle(GEOM_Annotation)& thePresentation,
                                                const Properties& theProps,
                                                const gp_Ax3& theShapeLCS );
 
  GEOMGUI_EXPORT void SetupPresentation( const Handle(GEOM_Annotation)& thePresentation,
                                         const int theIndex,
                                         const gp_Ax3& theShapeLCS );
 
public:
 
  GEOMGUI_EXPORT void SetNbAnnotation( const int theCount ) const;
 
  GEOMGUI_EXPORT int GetNbAnnotation() const;
 
  GEOMGUI_EXPORT void SetIsVisible( const int theIndex, const bool theIsVisible );
 
  GEOMGUI_EXPORT bool GetIsVisible( const int theIndex ) const;
 
  GEOMGUI_EXPORT void SetText( const int theIndex, const QString& theText );
 
  GEOMGUI_EXPORT QString GetText( const int theIndex ) const;
 
  GEOMGUI_EXPORT void SetIsScreenFixed( const int theIndex, const bool theIsScreenFixed );
 
  GEOMGUI_EXPORT bool GetIsScreenFixed( const int theIndex ) const;
 
  GEOMGUI_EXPORT void SetPosition( const int theIndex, const gp_Pnt& thePosition );
 
  GEOMGUI_EXPORT gp_Pnt GetPosition( const int theIndex ) const;
 
  GEOMGUI_EXPORT void SetAttach( const int theIndex, const gp_Pnt& theAttach );
 
  GEOMGUI_EXPORT gp_Pnt GetAttach( const int theIndex ) const;
 
  GEOMGUI_EXPORT void SetShapeSel( const int theIndex, const int theShapeType, const int theSubIdx );
 
  GEOMGUI_EXPORT void GetShapeSel( const int theIndex, int& theShapeType, int& theSubIdx ) const;
 
public:
 
  GEOMGUI_EXPORT void Append( const Properties& theProps );
 
  GEOMGUI_EXPORT void Append( const Properties& theProps, const gp_Ax3& theShapeLCS );
 
  GEOMGUI_EXPORT void Remove( const Standard_Integer theIndex );
 
  GEOMGUI_EXPORT void SetProperties( const int theIndex, const Properties& theProps );
 
  GEOMGUI_EXPORT void SetProperties( const int theIndex, const Properties& theProps, const gp_Ax3& theShapeLCS );
 
  GEOMGUI_EXPORT void GetProperties( const int theIndex, Properties& theProps ) const;
 
private:
 
  GEOMGUI_AnnotationAttrs( const _PTR(SObject)& theObject, const _PTR(AttributeParameter)& theParameter )
  : myObj( theObject ),
    myParameterMap( theParameter ) {}
 
  GEOMGUI_AnnotationAttrs( const GEOMGUI_AnnotationAttrs& ); // private copy constructor, must be never called
  void operator=( const GEOMGUI_AnnotationAttrs& ); // private assignment operator, must be never called
 
private:
 
  _PTR(SObject) myObj;
  _PTR(AttributeParameter) myParameterMap;
};
 
DEFINE_STANDARD_HANDLE( GEOMGUI_AnnotationAttrs, Standard_Transient )
 
#endif