geom/src/GEOMBase/GEOMBase_Helper.h

// Copyright (C) 2007-2019  CEA/DEN, EDF R&D, 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 GEOMGUI : GUI for Geometry component
// File   : GEOMBase_Helper.h
// Author : Sergey ANIKIN, Open CASCADE S.A.S. (sergey.anikin@opencascade.com)

#ifndef GEOMBASE_HELPER_H
#define GEOMBASE_HELPER_H

#include "GEOM_GEOMBase.hxx"
#include "GEOM_GenericObjPtr.h"

#include <GEOM_Displayer.h>
#include <SALOME_ListIO.hxx>
#include <SALOMEconfig.h>
#include CORBA_CLIENT_HEADER(GEOM_Gen)

#include <TColStd_MapOfInteger.hxx>

#include <QString>
#include <QMap>

#include <list>

typedef std::list<GEOM::GEOM_Object_ptr> ObjectList;

class SalomeApp_Study;
class SUIT_Desktop;
class SUIT_ViewWindow;
class SALOME_Prs;
class GEOM_Operation;

//================================================================
// Class       : GEOMBase_Helper
// Description : Helper class for dialog box development, can be used as
//               the second base class for dialog boxes. Contains convenient methods
//               performing common operations (display/erase, selection activation,
//               publication in a study, transaction management)
//================================================================
class GEOMBASE_EXPORT GEOMBase_Helper
{
public:
  GEOMBase_Helper( SUIT_Desktop* );
  virtual ~GEOMBase_Helper();
  static SUIT_ViewWindow* getActiveView();

protected:
  typedef std::list<SALOME_Prs*> PrsList;

  static GEOM::GEOM_Gen_ptr getGeomEngine();

  void display         ( const ObjectList&, const bool = true );
  void display         ( GEOM::GEOM_Object_ptr, const bool = true );
  void erase           ( const ObjectList&, const bool = true );
  void erase           ( GEOM::GEOM_Object_ptr, const bool = true );
  void redisplay       ( const ObjectList&, const bool = true, const bool = true );
  void redisplay       ( GEOM::GEOM_Object_ptr, const bool = true, const bool = true );

  virtual void displayPreview ( const bool   display,
                                const bool   activate = false,
                                const bool   update = true,
                                const bool   toRemoveFromEngine = true,
                                const double lineWidth = -1,
                                const int    displayMode = -1,
                                const int    color  = -1,
                                const bool   append = false );
  // This is the easiest way to show preview. It is based on execute() method.
  // It removes temporary GEOM::GEOM_Objects automatically.

  virtual void displayPreview  ( GEOM::GEOM_Object_ptr obj,
                                 const bool   append = false,
                                 const bool   activate = false,
                                 const bool   update = true,
                                 const double lineWidth = -1,
                                 const int    displayMode = -1,
                                 const int    color  = -1 );
  void displayPreview  ( const SALOME_Prs* prs,
                         const bool append = false,
                         const bool = true );
  void erasePreview    ( const bool = true );

  const PrsList& getPreview() const { return myPreview; }

  void localSelection( const ObjectList&, const std::list<int> );
  void localSelection( const ObjectList&, const int );
  void localSelection( GEOM::GEOM_Object_ptr, const std::list<int> );
  void localSelection( GEOM::GEOM_Object_ptr, const int );
  void localSelection( const std::list<int> );
  void localSelection( const int );
  void activate( const int );
  void globalSelection( const int = GEOM_ALLOBJECTS, const bool = false  );
  void globalSelection( const TColStd_MapOfInteger&, const bool = false );
  void globalSelection( const TColStd_MapOfInteger&, const QList<int>& ,const bool = false );
  void updateViewer    ();

  void prepareSelection( const ObjectList&, const int );
  void prepareSelection( GEOM::GEOM_Object_ptr, const int );

  QString addInStudy   ( GEOM::GEOM_Object_ptr, const char* theName );

  bool openCommand     ();
  bool abortCommand    ();
  bool commitCommand   ( const char* = 0 );
  bool hasCommand      () const;

  void updateObjBrowser() const;
  SalomeApp_Study* getStudy  () const;
  bool checkViewWindow ();

  bool onAccept( const bool publish = true, const bool useTransaction = true, bool erasePreviewFlag = true);
  // This method should be called from "OK" button handler.
  // <publish> == true means that objects returned by execute()
  // should be published in a study.

  void showError();
  // Shows a message box with information about an error taken from getOperation()->GetErrorCode()
  void showError( const QString& msg );
  // Shows a error message followed by <msg>

  GEOM::GEOM_IOperations_ptr getOperation();
  // If <myOperation> is nil --> calls createOperation() and put the result
  // into <myOperation> and returns it;
  // otherwise, simply returns <myOperation>

  inline void setPrefix( const QString& prefix ) { myPrefix = prefix; }
  QString getPrefix( GEOM::GEOM_Object_ptr = GEOM::GEOM_Object::_nil() ) const;

  bool selectObjects( ObjectList& objects );
  // Selects list of objects

  ////////////////////////////////////////////////////////////////////////////
  // Virtual methods, to be redefined in dialog classes
  ////////////////////////////////////////////////////////////////////////////

  virtual GEOM::GEOM_IOperations_ptr createOperation();
  // This method should be redefined in dialog boxes so as to return
  // proper GEOM_IOperation interface.
  // Returns nil reference by default

  virtual bool isValid( QString& msg );
  // Called by onAccept(). Redefine this method to check validity of user input in dialog boxes.

  virtual bool execute( ObjectList& objects );
  // This method is called by onAccept().
  // It should perform the required operation and put all new or modified objects into
  // <objects> argument.Should return <false> if some error occurs during its execution.

  virtual void restoreSubShapes( SALOMEDS::SObject_ptr theSObject );
  // This method is called by addInStudy().

  virtual GEOM::GEOM_Object_ptr getFather( GEOM::GEOM_Object_ptr theObj );
  // This method is called by addInStudy(). It should return a father object
  // for <theObj> or a nil reference if <theObj> should be published
  // as a top-level object.

  virtual QString getNewObjectName (int CurrObj = -1) const;
  virtual QString getObjectName(GEOM::GEOM_Object_ptr object) const;
  virtual bool extractPrefix() const;
  virtual void addSubshapesToStudy();
  virtual QList<GEOM::GeomObjPtr> getSourceObjects();

  GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, const QString& theName );
  GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, int theIndex );
  // These methods are used to find published sub-object (sub-shape) in the parent object (main shape)

  GEOM::GeomObjPtr        getSelected( TopAbs_ShapeEnum type );
  GEOM::GeomObjPtr        getSelected( const QList<TopAbs_ShapeEnum>& types );
  QList<GEOM::GeomObjPtr> getSelected( TopAbs_ShapeEnum type, int count, bool strict = true );
  QList<GEOM::GeomObjPtr> getSelected( const QList<TopAbs_ShapeEnum>& types, int count, bool strict = true );

  void hideSourceObjects( QList<GEOM::GeomObjPtr> theObjectList );
  void SetIsPreview(const bool thePreview) {isPreview = thePreview;}
  bool IsPreview() {return isPreview;}

  GEOM_Displayer*             getDisplayer();
  SUIT_Desktop*               getDesktop() const;

  virtual void                setIsApplyAndClose( const bool theFlag );
  virtual bool                isApplyAndClose() const;

  virtual void                setIsOptimizedBrowsing( const bool theFlag );
  virtual bool                isOptimizedBrowsing() const;

  virtual void                setIsWaitCursorEnabled( const bool theFlag ) {myIsWaitCursorEnabled = theFlag;}
  virtual bool                isWaitCursorEnabled() const {return myIsWaitCursorEnabled ;}
  virtual void                setIsDisableBrowsing( const bool theFlag ) { myIsDisableBrowsing = theFlag; }
  virtual bool                isDisableBrowsing() const { return myIsDisableBrowsing; }
  virtual void                setIsDisplayResult( const bool theFlag ) {myIsDisplayResult = theFlag; }
  virtual bool                isDisplayResult() const { return myIsDisplayResult; }

private:
  QString                     getEntry( GEOM::GEOM_Object_ptr ) const;
  void                        clearShapeBuffer( GEOM::GEOM_Object_ptr );

private:

  PrsList                     myPreview;
  GEOM_Displayer*             myDisplayer;
  GEOM_Operation*             myCommand;
  GEOM::GEOM_IOperations_var  myOperation;
  SUIT_ViewWindow*            myViewWindow;
  QString                     myPrefix;
  bool                        isPreview;
  SALOME_ListIO               mySelected;
  SUIT_Desktop*               myDesktop;
  bool                        myIsApplyAndClose;
  bool                        myIsOptimizedBrowsing;
  bool                        myIsWaitCursorEnabled;
  bool                        myIsDisableBrowsing;  //This flag enable/disable selection
                                                    //in the Object Browser newly created objects.
  bool                        myIsDisplayResult;    //This flag display/hide newly created objects.
};

#endif // GEOMBASE_HELPER_H