+// Copyright (C) 2007-2022 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
+//
+
#ifndef SALOME_PRS_H
#define SALOME_PRS_H
-#ifdef WNT
-#ifdef PRS_EXPORTS
+#ifdef WIN32
+#if defined PRS_EXPORTS || defined SalomePrs_EXPORTS
#define PRS_EXPORT __declspec(dllexport)
#else
#define PRS_EXPORT __declspec(dllimport)
#define PRS_EXPORT
#endif
+#include <string>
+#include <list>
+
+#include <Standard_DefineHandle.hxx>
+
class SALOME_View;
class SALOME_Displayer;
-class Handle_SALOME_InteractiveObject;
+class SALOME_ListIO;
+class SALOME_InteractiveObject;
-//===========================================================
/*!
- * Class: SALOME_Prs
- * Description: Base class for SALOME graphic object wrappers - presentations.
- * Presentations are temporary objects, so they can be created on the stack.
- */
-//===========================================================
+ \class SALOME_Prs
+ Base class for SALOME graphic object wrappers - presentations.
+ Presentations are temporary objects, so they can be created on the stack.
+*/
class PRS_EXPORT SALOME_Prs
{
public:
+ //! Constructor
+ explicit SALOME_Prs( const char* );
+
+ //! Destructor
virtual ~SALOME_Prs() {}
- // Destructor
+ //! Get entry
+ const char* GetEntry() const;
+
+ //! Key method for double dispatch of display operation
virtual void DisplayIn( SALOME_View* ) const = 0;
- // Key method for double dispatch of display operation
+ //! Key method for double dispatch of erase operation
virtual void EraseIn( SALOME_View*, const bool = false ) const = 0;
- // Key method for double dispatch of erase operation
+ //! Key method for double dispatch of pre-display operation
+ virtual void BeforeDisplayIn( SALOME_Displayer*, SALOME_View* ) const = 0;
+
+ //! Key method for double dispatch of post-display operation
+ virtual void AfterDisplayIn( SALOME_Displayer*, SALOME_View* ) const = 0;
+
+ //! Key method for double dispatch of pre-erase operation
+ virtual void BeforeEraseIn( SALOME_Displayer*, SALOME_View* ) const = 0;
+
+ //! Key method for double dispatch of post-erase operation
+ virtual void AfterEraseIn( SALOME_Displayer*, SALOME_View* ) const = 0;
+
+ //! Key method for double dispatch of update operation
virtual void Update( SALOME_Displayer* ) = 0;
- // Key method for double dispatch of update operation
+ //! Should return true, if this presentation contains a graphic object
virtual bool IsNull() const = 0;
- // Should return true, if this presentation contains a graphic object
+ //! Key method for double dispatch of activation of sub-shapes selection
virtual void LocalSelectionIn( SALOME_View*, const int ) const = 0;
- // Key method for double dispatch of activation of subshapes selection
+ 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: SALOME_OCCPrs
- * Description: Base class for OpenCASCADE graphic object (AIS_InteractiveObject) wrappers.
- * This intermediate class is necessary to avoid dependencies from OCC libs.
- */
-//===========================================================
+ \class SALOME_OCCPrs
+ Base class for OpenCASCADE graphic object (AIS_InteractiveObject) wrappers.
+ This intermediate class is necessary to avoid dependencies from OCC libs.
+*/
class PRS_EXPORT SALOME_OCCPrs : public SALOME_Prs
{
public:
+ //! Constructor
+ explicit SALOME_OCCPrs(const char* e) : SALOME_Prs(e) {}
+
+ //! It uses double dispatch in order to
+ //! invoke Display() method corresponding to the actual type of presentation.
virtual void DisplayIn( SALOME_View* ) const;
- // It uses double dispatch in order to
- // invoke Display() method corresponding to the actual type of presentation.
+ //! It uses double dispatch in order to
+ //! invoke Erase() method corresponding to the actual type of presentation.
virtual void EraseIn( SALOME_View*, const bool = false ) const;
- // It uses double dispatch in order to
- // invoke Erase() method corresponding to the actual type of presentation.
+ //! It uses double dispatch in order to
+ //! invoke BeforeDisplayIn() method corresponding to the actual type of presentation.
+ virtual void BeforeDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke AfterDisplayIn() method corresponding to the actual type of presentation.
+ virtual void AfterDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke BeforeEraseIn() method corresponding to the actual type of presentation.
+ virtual void BeforeEraseIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke AfterEraseIn() method corresponding to the actual type of presentation.
+ virtual void AfterEraseIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke Update() method corresponding to the actual type of presentation.
virtual void Update( SALOME_Displayer* );
- // It uses double dispatch in order to
- // invoke Update() method corresponding to the actual type of presentation.
+ //! Key method for double dispatch of activation of sub-shapes selection
virtual void LocalSelectionIn( SALOME_View*, const int ) const;
- // Key method for double dispatch of activation of subshapes selection
+ virtual void LocalSelectionIn( SALOME_View*, const std::list<int> ) const;
};
-//===========================================================
/*!
- * Class: SALOME_VTKPrs
- * Description: Base class for VTK graphic object (vtkActor) wrappers
- * This intermediate class is necessary to avoid dependencies from VTK libs.
- */
-//===========================================================
-
+ \class SALOME_VTKPrs
+ Base class for VTK graphic object (vtkActor) wrappers.
+ This intermediate class is necessary to avoid dependencies from VTK libs.
+*/
class PRS_EXPORT SALOME_VTKPrs : public SALOME_Prs
{
public:
+ //! Constructor
+ explicit SALOME_VTKPrs(const char* e) : SALOME_Prs(e) {}
+
+ //! It uses double dispatch in order to
+ //! invoke Display() method corresponding to the actual type of presentation.
virtual void DisplayIn( SALOME_View* ) const;
- // It uses double dispatch in order to
- // invoke Display() method corresponding to the actual type of presentation.
+ //! It uses double dispatch in order to
+ //! invoke Erase() method corresponding to the actual type of presentation.
virtual void EraseIn( SALOME_View*, const bool = false ) const;
- // It uses double dispatch in order to
- // invoke Erase() method corresponding to the actual type of presentation.
+ //! It uses double dispatch in order to
+ //! invoke BeforeDisplayIn() method corresponding to the actual type of presentation.
+ virtual void BeforeDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke AfterDisplayIn() method corresponding to the actual type of presentation.
+ virtual void AfterDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke BeforeEraseIn() method corresponding to the actual type of presentation.
+ virtual void BeforeEraseIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke AfterEraseIn() method corresponding to the actual type of presentation.
+ virtual void AfterEraseIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke Update() method corresponding to the actual type of presentation.
virtual void Update( SALOME_Displayer* );
- // It uses double dispatch in order to
- // invoke Update() method corresponding to the actual type of presentation.
+ //! Key method for double dispatch of activation of sub-shapes selection
virtual void LocalSelectionIn( SALOME_View*, const int ) const;
- // Key method for double dispatch of activation of subshapes selection
};
-//===========================================================
/*!
- * Class: SALOME_Prs2d
- * Description: Base class for Plot2d graphic object (Plot2d_Curve) wrappers.
- */
-//===========================================================
-
+ \class SALOME_Prs2d
+ Base class for Plot2d graphic object (Plot2d_Curve) wrappers.
+*/
class PRS_EXPORT SALOME_Prs2d : public SALOME_Prs
{
public:
+ //! Constructor
+ explicit SALOME_Prs2d(const char* e) : SALOME_Prs(e) {}
+
+ //! It uses double dispatch in order to
+ //! invoke Display() method corresponding to the actual type of presentation.
virtual void DisplayIn( SALOME_View* ) const;
- // It uses double dispatch in order to
- // invoke Display() method corresponding to the actual type of presentation.
+ //! It uses double dispatch in order to
+ //! invoke Erase() method corresponding to the actual type of presentation.
virtual void EraseIn( SALOME_View*, const bool = false ) const;
- // It uses double dispatch in order to
- // invoke Erase() method corresponding to the actual type of presentation.
+ //! It uses double dispatch in order to
+ //! invoke BeforeDisplayIn() method corresponding to the actual type of presentation.
+ virtual void BeforeDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke AfterDisplayIn() method corresponding to the actual type of presentation.
+ virtual void AfterDisplayIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke BeforeEraseIn() method corresponding to the actual type of presentation.
+ virtual void BeforeEraseIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke AfterEraseIn() method corresponding to the actual type of presentation.
+ virtual void AfterEraseIn( SALOME_Displayer*, SALOME_View* ) const;
+
+ //! It uses double dispatch in order to
+ //! invoke Update() method corresponding to the actual type of presentation.
virtual void Update( SALOME_Displayer* );
- // It uses double dispatch in order to
- // invoke Update() method corresponding to the actual type of presentation.
+ //! Key method for double dispatch of activation of sub-shapes selection
virtual void LocalSelectionIn( SALOME_View*, const int ) const;
- // Key method for double dispatch of activation of subshapes selection
};
-/////////////////////////////////////////////////////////////////////////
-// Base classes for object wrappers for any other visualization libraries
-// should be added here!
-/////////////////////////////////////////////////////////////////////////
-
-//===========================================================
/*!
- * Class: SALOME_View
- * Description: Base class for SALOME views (or view frames)
- */
-//===========================================================
-
+ Base classes for object wrappers for any other visualization libraries should be added here!
+*/
+/*!
+ \class SALOME_View
+ Base class for SALOME views (or view frames)
+*/
class PRS_EXPORT SALOME_View
{
public:
+ //! Destructor
virtual ~SALOME_View() {}
- // Destructor
- void Display( const SALOME_Prs* );
- // This Display() method should be called to display given presentation
- // created anywhere by anybody. It simply passes control to SALOME_Prs object
- // so that it could perform double dispatch.
- void Erase( const SALOME_Prs*, const bool = false );
- // This Erase() method should be called to erase given presentation
- // created anywhere by anybody. It simply passes control to SALOME_Prs object
- // so that it could perform double dispatch.
+ //! This Display() method should be called to display given presentation
+ //! created anywhere by anybody. It simply passes control to SALOME_Prs object
+ //! so that it could perform double dispatch.
+ void Display( SALOME_Displayer*, const SALOME_Prs* );
+
+ //! This Erase() method should be called to erase given presentation
+ //! created anywhere by anybody. It simply passes control to SALOME_Prs object
+ //! so that it could perform double dispatch.
+ void Erase( SALOME_Displayer*, const SALOME_Prs*, const bool = false );
+ //! This EraseAll() method should be called to erase all presentations
+ //! created anywhere by anybody.
+ virtual void EraseAll( SALOME_Displayer*, const bool = false );
+
+ //! This LocalSelection() method should be called to activate sub-shapes selection
+ //! created anywhere by anybody. It simply passes control to SALOME_Prs object
+ //! so that it could perform double dispatch.
void LocalSelection( const SALOME_Prs*, const int );
- // This LocalSelection() method should be called to activate sub-shapes selection
- // created anywhere by anybody. It simply passes control to SALOME_Prs object
- // so that it could perform double dispatch.
+ 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_Prs2d* );
+ virtual void Display( const SALOME_OCCPrs* );//!< Display SALOME_OCCPrs presentation.
+ virtual void Display( const SALOME_VTKPrs* );//!< Display SALOME_VTKPrs presentation.
+ virtual void Display( const SALOME_Prs2d* );//!< Display SALOME_Prs2d presentation.
// 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_Prs2d*, const bool = false );
- virtual void EraseAll( const bool = false );
+ virtual void Erase( const SALOME_OCCPrs*, const bool = false );//!< Erase SALOME_OCCPrs
+ virtual void Erase( const SALOME_VTKPrs*, const bool = false );//!< Erase SALOME_VTKPrs
+ virtual void Erase( const SALOME_Prs2d*, const bool = false );//!< Erase SALOME_Prs2d
// 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_VTKPrs*, const int );
- virtual void LocalSelection( const SALOME_Prs2d* , const int );
+ virtual void LocalSelection( const SALOME_OCCPrs*, const int ); //!< Local selection SALOME_OCCPrs
+ virtual void LocalSelection( const SALOME_OCCPrs*, const std::list<int> );//!< Multiple local selection SALOME_OCCPrs
+ virtual void LocalSelection( const SALOME_VTKPrs*, const int ); //!< Local selection SALOME_VTKPrs
+ virtual void LocalSelection( const SALOME_Prs2d* , const int ); //!< Local selection SALOME_Prs2d
+ //! Deactivates selection of sub-shapes (must be redefined with OCC viewer)
virtual void GlobalSelection( const bool = false ) const;
- // Deactivates selection of sub-shapes (must be redefined with OCC viewer)
- // Creates empty presenation of corresponding type
- virtual SALOME_Prs* CreatePrs( const char* entry = 0 ) { return 0; }
+ //! Creates empty presenation of corresponding type
+ virtual SALOME_Prs* CreatePrs( const char* /*entry*/ = 0 ) { return 0; }
// Axiluary methods called before and after displaying of objects
- virtual void BeforeDisplay( SALOME_Displayer* d ) {}
- virtual void AfterDisplay ( SALOME_Displayer* d ) {}
+ 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() {}
+ //! \retval Return false.
+ virtual bool isVisible( const Handle(SALOME_InteractiveObject)& ){ return false; }
+ virtual void Repaint() {} //!< Null body here.
+ virtual void GetVisible( SALOME_ListIO& /*theList*/ ) {}
};
-//===========================================================
/*!
- * Classes: SALOME_Displayer
- * Description: These classes are used to specify type of view
- * VTK, OCC or Plot2d
- */
-//===========================================================
-
-class PRS_EXPORT SALOME_OCCViewType {};
-class PRS_EXPORT SALOME_VTKViewType {};
-class PRS_EXPORT SALOME_Plot2dViewType {};
-
-//===========================================================
-/*!
- * Class: SALOME_Displayer
- * Description: Base class for SALOME displayers
- */
-//===========================================================
-
+ \class SALOME_Displayer
+ Base class for SALOME displayers
+*/
class PRS_EXPORT SALOME_Displayer
{
public:
- virtual ~SALOME_Displayer() {}
- // Destructor
+ //! Destructor
+ virtual ~SALOME_Displayer() {/*! Null body here*/}
+ //! This Update() method should be called to update given presentation
+ //! created anywhere by anybody. It simply passes control to SALOME_Prs object
+ //! so that it could perform double dispatch.
void UpdatePrs( SALOME_Prs* );
- // This Update() method should be called to update given presentation
- // created anywhere by anybody. It simply passes control to SALOME_Prs object
- // so that it could perform double dispatch.
// 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_Prs2d* );
+ virtual void Update( SALOME_OCCPrs* );//!< Update SALOME_OCCPrs presentation.
+ virtual void Update( SALOME_VTKPrs* );//!< Update SALOME_VTKPrs presentation.
+ virtual void Update( SALOME_Prs2d* );//!< Update SALOME_Prs2d presentation.
// Add new Update() methods here...
// Axiluary methods called before and after displaying of objects
- virtual void BeforeDisplay( SALOME_View*, const SALOME_OCCViewType& ) {};
- virtual void AfterDisplay ( SALOME_View*, const SALOME_OCCViewType& ) {};
- virtual void BeforeDisplay( SALOME_View*, const SALOME_VTKViewType& ) {};
- virtual void AfterDisplay ( SALOME_View*, const SALOME_VTKViewType& ) {};
- virtual void BeforeDisplay( SALOME_View*, const SALOME_Plot2dViewType& ) {};
- virtual void AfterDisplay ( SALOME_View*, const SALOME_Plot2dViewType& ) {};
+ virtual void BeforeDisplay( SALOME_View*, const SALOME_OCCPrs* ) {} //! Null body here
+ virtual void AfterDisplay ( SALOME_View*, const SALOME_OCCPrs* ) {} //! Null body here
+ virtual void BeforeDisplay( SALOME_View*, const SALOME_VTKPrs* ) {} //! Null body here
+ virtual void AfterDisplay ( SALOME_View*, const SALOME_VTKPrs* ) {} //! Null body here
+ virtual void BeforeDisplay( SALOME_View*, const SALOME_Prs2d* ) {} //! Null body here
+ virtual void AfterDisplay ( SALOME_View*, const SALOME_Prs2d* ) {} //! Null body here
+
+ // Axiluary methods called before and after erasing of objects
+ virtual void BeforeErase( SALOME_View*, const SALOME_OCCPrs* ) {} //! Null body here
+ virtual void AfterErase ( SALOME_View*, const SALOME_OCCPrs* ) {} //! Null body here
+ virtual void BeforeErase( SALOME_View*, const SALOME_VTKPrs* ) {} //! Null body here
+ virtual void AfterErase ( SALOME_View*, const SALOME_VTKPrs* ) {} //! Null body here
+ virtual void BeforeErase( SALOME_View*, const SALOME_Prs2d* ) {} //! Null body here
+ virtual void AfterErase ( SALOME_View*, const SALOME_Prs2d* ) {} //! Null body here
+
+ // Axiluary method called to update visibility state of presentation
+ virtual void UpdateVisibility( SALOME_View*, const SALOME_Prs*, bool );
};
#endif
