SALOME_Prs.h

Go to the documentation of this file.

// Copyright (C) 2007-2025  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
//
 
#ifndef SALOME_PRS_H
#define SALOME_PRS_H
 
#ifdef WIN32
#if defined PRS_EXPORTS || defined SalomePrs_EXPORTS
#define PRS_EXPORT __declspec(dllexport)
#else
#define PRS_EXPORT __declspec(dllimport)
#endif
#else
#define PRS_EXPORT
#endif
 
#include <string>
#include <list>
 
#include <Standard_DefineHandle.hxx>
 
class SALOME_View;
class SALOME_Displayer;
class SALOME_ListIO;
class SALOME_InteractiveObject;
 
class PRS_EXPORT SALOME_Prs
{
public:
  explicit SALOME_Prs( const char* );
 
  virtual ~SALOME_Prs() {}
 
  const char* GetEntry() const;
 
  virtual void DisplayIn( SALOME_View* ) const = 0;
 
  virtual void EraseIn( SALOME_View*, const bool = false ) const = 0;
 
  virtual void BeforeDisplayIn( SALOME_Displayer*, SALOME_View* ) const = 0;
 
  virtual void AfterDisplayIn( SALOME_Displayer*, SALOME_View* ) const = 0;
 
  virtual void BeforeEraseIn( SALOME_Displayer*, SALOME_View* ) const = 0;
 
  virtual void AfterEraseIn( SALOME_Displayer*, SALOME_View* ) const = 0;
 
  virtual void Update( SALOME_Displayer* ) = 0;
 
  virtual bool IsNull() const = 0;
 
  virtual void LocalSelectionIn( SALOME_View*, const int ) const = 0;
  virtual void LocalSelectionIn( SALOME_View*, const std::list<int> ) const;
 
    // checks if shape is clippable
  inline bool IsClippable() const
  {
    return myIsClippable;
  }
 
  // makes shape clippable/not clippable
  inline void SetClippable (bool isClippable)
  {
    myIsClippable = isClippable;
  }
 
protected:
  std::string myEntry;
  bool myIsClippable;
};
 
class PRS_EXPORT SALOME_OCCPrs : public SALOME_Prs
{
public:
  explicit SALOME_OCCPrs(const char* e) : SALOME_Prs(e) {}
 
  virtual void DisplayIn( SALOME_View* ) const;
 
  virtual void EraseIn( SALOME_View*, const bool = false ) const;
 
  virtual void BeforeDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void AfterDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void BeforeEraseIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void AfterEraseIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void Update( SALOME_Displayer* );
 
  virtual void LocalSelectionIn( SALOME_View*, const int ) const;
  virtual void LocalSelectionIn( SALOME_View*, const std::list<int> ) const;
};
 
class PRS_EXPORT SALOME_VTKPrs : public SALOME_Prs
{
public:
  explicit SALOME_VTKPrs(const char* e) : SALOME_Prs(e) {}
 
  virtual void DisplayIn( SALOME_View* ) const;
 
  virtual void EraseIn( SALOME_View*, const bool = false ) const;
 
  virtual void BeforeDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void AfterDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void BeforeEraseIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void AfterEraseIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void Update( SALOME_Displayer* );
 
  virtual void LocalSelectionIn( SALOME_View*, const int ) const;
};
 
class PRS_EXPORT SALOME_PV3DPrs : public SALOME_Prs
{
public:
  explicit SALOME_PV3DPrs(const char* e) : SALOME_Prs(e) {}
 
  virtual void DisplayIn( SALOME_View* ) const;
 
  virtual void EraseIn( SALOME_View*, const bool = false ) const;
 
  virtual void BeforeDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void AfterDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void BeforeEraseIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void AfterEraseIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void Update( SALOME_Displayer* );
 
  virtual void LocalSelectionIn( SALOME_View*, const int ) const;
  virtual void LocalSelectionIn( SALOME_View*, const std::list<int> ) const;
};
 
class PRS_EXPORT SALOME_Prs2d : public SALOME_Prs
{
public:
  explicit SALOME_Prs2d(const char* e) : SALOME_Prs(e) {}
 
  virtual void DisplayIn( SALOME_View* ) const;
 
  virtual void EraseIn( SALOME_View*, const bool = false ) const;
 
  virtual void BeforeDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void AfterDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void BeforeEraseIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void AfterEraseIn( SALOME_Displayer*, SALOME_View* ) const;
 
  virtual void Update( SALOME_Displayer* );
 
  virtual void LocalSelectionIn( SALOME_View*, const int ) const;
};
 
class PRS_EXPORT SALOME_View
{
public:
  virtual ~SALOME_View() {}
 
  void Display( SALOME_Displayer*, const SALOME_Prs* );
 
  void Erase( SALOME_Displayer*, const SALOME_Prs*, const bool = false );
 
  virtual void EraseAll( SALOME_Displayer*, const bool = false );
 
  void LocalSelection( const SALOME_Prs*, const int );
  void LocalSelection( const SALOME_Prs*, const std::list<int> );
 
  // Interface for derived views
 
  // Display() methods for ALL kinds of presentation should appear here
  virtual void Display( const SALOME_OCCPrs* );
  virtual void Display( const SALOME_VTKPrs* );
  virtual void Display( const SALOME_PV3DPrs* );
  virtual void Display( const SALOME_Prs2d*  );
  // Add new Display() methods here...
 
  // Erase() methods for ALL kinds of presentation should appear here
  virtual void Erase( const SALOME_OCCPrs*, const bool = false );
  virtual void Erase( const SALOME_VTKPrs*, const bool = false );
  virtual void Erase( const SALOME_PV3DPrs*, const bool = false );
  virtual void Erase( const SALOME_Prs2d*,  const bool = false );
  // Add new Erase() methods here...
 
  // LocalSelection() methods for ALL kinds of presentation should appear here
  virtual void LocalSelection( const SALOME_OCCPrs*, const int );           
  virtual void LocalSelection( const SALOME_OCCPrs*, const std::list<int> );
  virtual void LocalSelection( const SALOME_VTKPrs*, const int );           
  virtual void LocalSelection( const SALOME_PV3DPrs*, const int );          
  virtual void LocalSelection( const SALOME_Prs2d* , const int );           
 
  virtual void GlobalSelection( const bool = false ) const;
 
  virtual SALOME_Prs* CreatePrs( const char* /*entry*/ = 0 ) { return 0; }
 
  // Axiluary methods called before and after displaying of objects
  virtual void BeforeDisplay( SALOME_Displayer*, const SALOME_Prs* );
  virtual void AfterDisplay ( SALOME_Displayer*, const SALOME_Prs* );
 
  // Axiluary methods called before and after erasing of objects
  virtual void BeforeErase( SALOME_Displayer*, const SALOME_Prs* );
  virtual void AfterErase ( SALOME_Displayer*, const SALOME_Prs* );
 
  // New methods (asv)
  virtual bool isVisible( const Handle(SALOME_InteractiveObject)& ){ return false; }
  virtual void Repaint() {} 
  virtual void GetVisible( SALOME_ListIO& /*theList*/ ) {}
};
 
class PRS_EXPORT SALOME_Displayer
{
public:
  virtual ~SALOME_Displayer() {}
 
  void UpdatePrs( SALOME_Prs* );
 
  // Interface for derived displayers
 
  // Update() methods for ALL kinds of presentation should appear here
  virtual void Update( SALOME_OCCPrs* );
  virtual void Update( SALOME_VTKPrs* );
  virtual void Update( SALOME_PV3DPrs* );
  virtual void Update( SALOME_Prs2d* );
  // Add new Update() methods here...
 
  // Auxiliary methods called before and after displaying of objects
  virtual void BeforeDisplay( SALOME_View*, const SALOME_OCCPrs* ) {} 
  virtual void AfterDisplay ( SALOME_View*, const SALOME_OCCPrs* ) {} 
  virtual void BeforeDisplay( SALOME_View*, const SALOME_VTKPrs* ) {} 
  virtual void AfterDisplay ( SALOME_View*, const SALOME_VTKPrs* ) {} 
  virtual void BeforeDisplay( SALOME_View*, const SALOME_PV3DPrs* ) {} 
  virtual void AfterDisplay ( SALOME_View*, const SALOME_PV3DPrs* ) {} 
  virtual void BeforeDisplay( SALOME_View*, const SALOME_Prs2d*  ) {} 
  virtual void AfterDisplay ( SALOME_View*, const SALOME_Prs2d*  ) {} 
 
  // Auxiliary methods called before and after erasing of objects
  virtual void BeforeErase( SALOME_View*, const SALOME_OCCPrs* ) {} 
  virtual void AfterErase ( SALOME_View*, const SALOME_OCCPrs* ) {} 
  virtual void BeforeErase( SALOME_View*, const SALOME_VTKPrs* ) {} 
  virtual void AfterErase ( SALOME_View*, const SALOME_VTKPrs* ) {} 
  virtual void BeforeErase( SALOME_View*, const SALOME_PV3DPrs* ) {} 
  virtual void AfterErase ( SALOME_View*, const SALOME_PV3DPrs* ) {} 
  virtual void BeforeErase( SALOME_View*, const SALOME_Prs2d*  ) {} 
  virtual void AfterErase ( SALOME_View*, const SALOME_Prs2d*  ) {} 
 
  // Auxiliary method called to update visibility state of presentation
  virtual void UpdateVisibility( SALOME_View*, const SALOME_Prs*, bool );
};
 
#endif