src/SMESHGUI/SMESHGUI_VTKUtils.h

Go to the documentation of this file.

// Copyright (C) 2007-2011  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.
//
// 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
//

// SMESH SMESHGUI : GUI for SMESH component
// File   : SMESHGUI_VTKUtils.h
// Author : Open CASCADE S.A.S.
//
#ifndef SMESHGUI_VTKUTILS_H
#define SMESHGUI_VTKUTILS_H

// SMESH includes
#include "SMESH_SMESHGUI.hxx"

#include "SMESHGUI_Utils.h"
#include <SMESH_Object.h>

// SALOME KERNEL includes
#include <SALOMEDSClient_definitions.hxx>

// SALOME GUI includes
#include <SALOME_InteractiveObject.hxx>
#include <VTKViewer_Filter.h>

class TColStd_IndexedMapOfInteger;

class SALOMEDSClient_Study;

class SUIT_ViewWindow;
class SUIT_ViewManager;

class SVTK_ViewWindow;
class SVTK_Selector;

class LightApp_SelectionMgr;
class SalomeApp_Module;

class SMESHGUI;
class SMESH_Actor;
class SALOME_Actor;

class vtkActor;

namespace SMESH
{
  //----------------------------------------------------------------------------
  typedef std::pair<int,std::string> TKeyOfVisualObj;
  
SMESHGUI_EXPORT
  TVisualObjPtr GetVisualObj( int, const char*, bool nulData =false );
SMESHGUI_EXPORT
  void OnVisuException(); // PAL16631

  //----------------------------------------------------------------------------
SMESHGUI_EXPORT
  SVTK_ViewWindow* GetViewWindow( const SalomeApp_Module* = 0,
                                  bool = false );
SMESHGUI_EXPORT
  SVTK_ViewWindow* FindVtkViewWindow( SUIT_ViewManager*, SUIT_ViewWindow* );
SMESHGUI_EXPORT
  SVTK_ViewWindow* GetVtkViewWindow( SUIT_ViewWindow* );

SMESHGUI_EXPORT
  SVTK_ViewWindow* GetCurrentVtkView();

  //----------------------------------------------------------------------------
SMESHGUI_EXPORT
  void RepaintCurrentView();
SMESHGUI_EXPORT
  void RepaintViewWindow( SVTK_ViewWindow* );
SMESHGUI_EXPORT
  void RenderViewWindow( SVTK_ViewWindow* );
SMESHGUI_EXPORT
  void FitAll();

  //----------------------------------------------------------------------------
SMESHGUI_EXPORT
  SMESH_Actor* FindActorByEntry( SUIT_ViewWindow*, const char* );
SMESHGUI_EXPORT
  SMESH_Actor* FindActorByEntry( const char* );

SMESHGUI_EXPORT
  SMESH_Actor* FindActorByObject( CORBA::Object_ptr );

  //----------------------------------------------------------------------------
SMESHGUI_EXPORT  
  SMESH_Actor* CreateActor( _PTR(Study), const char*, int = false );
SMESHGUI_EXPORT
  void DisplayActor( SUIT_ViewWindow*, SMESH_Actor* );
SMESHGUI_EXPORT
  void RemoveActor( SUIT_ViewWindow*, SMESH_Actor* );
SMESHGUI_EXPORT
  void RemoveVisuData( int );

  //----------------------------------------------------------------------------
  enum EDisplaing { eDisplayAll, eDisplay, eDisplayOnly, eErase, eEraseAll };

SMESHGUI_EXPORT
  bool UpdateView( SUIT_ViewWindow*, EDisplaing, const char* = "" );
SMESHGUI_EXPORT            
  bool UpdateView( EDisplaing, const char* = "" );

SMESHGUI_EXPORT
  void UpdateView();

SMESHGUI_EXPORT
  bool UpdateNulData( const Handle(SALOME_InteractiveObject)& theIO, bool theDisplay);

SMESHGUI_EXPORT
  bool Update( const Handle(SALOME_InteractiveObject)& theIO, bool theDisplay);

  //----------------------------------------------------------------------------
SMESHGUI_EXPORT  
  void SetPointRepresentation( bool );

SMESHGUI_EXPORT
  void SetPickable( SMESH_Actor* = 0 );

SMESHGUI_EXPORT
  void UpdateSelectionProp( SMESHGUI* );

  //----------------------------------------------------------------------------
SMESHGUI_EXPORT
  SVTK_Selector* GetSelector( SUIT_ViewWindow* = GetActiveWindow() );

SMESHGUI_EXPORT
  void SetFilter( const Handle(VTKViewer_Filter)&, SVTK_Selector* = GetSelector() );
SMESHGUI_EXPORT
  Handle(VTKViewer_Filter) GetFilter( int, SVTK_Selector* = GetSelector() );
SMESHGUI_EXPORT
  bool IsFilterPresent( int, SVTK_Selector* = GetSelector() );
SMESHGUI_EXPORT
  void RemoveFilter( int, SVTK_Selector* = GetSelector() );

SMESHGUI_EXPORT
  void RemoveFilters( SVTK_Selector* = GetSelector());

SMESHGUI_EXPORT
  bool IsValid( SALOME_Actor*, int, SVTK_Selector* = GetSelector() );

  //----------------------------------------------------------------------------
SMESHGUI_EXPORT  
  int GetNameOfSelectedNodes( SVTK_Selector*,
                              const Handle(SALOME_InteractiveObject)&,
                              QString& );
SMESHGUI_EXPORT
  int GetNameOfSelectedElements( SVTK_Selector*,
                                 const Handle(SALOME_InteractiveObject)&,
                                 QString& );
SMESHGUI_EXPORT
  int GetEdgeNodes( SVTK_Selector*, const TVisualObjPtr&, int&, int& );

  //----------------------------------------------------------------------------
SMESHGUI_EXPORT  
  int GetNameOfSelectedNodes( LightApp_SelectionMgr*,
                              const Handle(SALOME_InteractiveObject)&,
                              QString& );
SMESHGUI_EXPORT
  int GetNameOfSelectedNodes( LightApp_SelectionMgr*, QString& );
SMESHGUI_EXPORT
  int GetNameOfSelectedElements( LightApp_SelectionMgr*,
                                 const Handle(SALOME_InteractiveObject)&,
                                 QString& );
SMESHGUI_EXPORT
  int GetNameOfSelectedElements( LightApp_SelectionMgr*, QString& );
SMESHGUI_EXPORT
  int GetSelected( LightApp_SelectionMgr*, TColStd_IndexedMapOfInteger&, 
                   const bool = true );

SMESHGUI_EXPORT
  int GetEdgeNodes( LightApp_SelectionMgr*, int&, int& );

SMESHGUI_EXPORT
  void SetControlsPrecision( const long );

#ifndef DISABLE_PLOT2DVIEWER
SMESHGUI_EXPORT
  void ClearPlot2Viewers( SUIT_ViewWindow* theWindow );
#endif

  //----------------------------------------------------------------------------
SMESHGUI_EXPORT
  bool ComputeClippingPlaneParameters( std::list<vtkActor*> theActorList,
                                       vtkFloatingPointType theNormal[3],
                                       vtkFloatingPointType theDist,
                                       vtkFloatingPointType theBounds[6],
                                       vtkFloatingPointType theOrigin[3] );
 SMESHGUI_EXPORT
   void RemoveVisualObjectWithActors( const char* theEntry, bool fromAllViews = false );
};

#endif // SMESHGUI_VTKUTILS_H