From a19bd93fbf73fbe01dd3bd0063ab670d2e7f7994 Mon Sep 17 00:00:00 2001 From: apo Date: Wed, 26 Oct 2005 08:36:06 +0000 Subject: [PATCH] Documentation of the sources --- src/SVTK/SVTK_ViewModel.h | 59 +++++++++++++++++++++++++++++---------- 1 file changed, 45 insertions(+), 14 deletions(-) diff --git a/src/SVTK/SVTK_ViewModel.h b/src/SVTK/SVTK_ViewModel.h index 24b6a3006..cc2f67b76 100644 --- a/src/SVTK/SVTK_ViewModel.h +++ b/src/SVTK/SVTK_ViewModel.h @@ -13,28 +13,43 @@ class SVTK_ViewWindow; +//! Extends two interfaces #SVTK_ViewModelBase and #SALOME_View class SVTK_EXPORT SVTK_Viewer : public SVTK_ViewModelBase, public SALOME_View { Q_OBJECT; public: typedef SVTK_ViewWindow TViewWindow; + + //! Define string representation of the viewer type static QString Type() { return "VTKViewer"; } SVTK_Viewer(); virtual ~SVTK_Viewer(); + //! See #SUIT_ViewModel::createView virtual SUIT_ViewWindow* createView(SUIT_Desktop*); - virtual void setViewManager(SUIT_ViewManager* theViewManager); - virtual void contextMenuPopup( QPopupMenu* ); - virtual QString getType() const { return Type(); } + //! See #SUIT_ViewModel::createView + virtual void setViewManager(SUIT_ViewManager* theViewManager); + //! See #SUIT_ViewModel::contextMenuPopup + virtual void contextMenuPopup( QPopupMenu* ); + + //! See #SUIT_ViewModel::getType + virtual QString getType() const { return Type(); } + + //! Get background color of the viewer QColor backgroundColor() const; - void setBackgroundColor( const QColor& ); - int trihedronSize() const; - void setTrihedronSize( const int ); + //! Set background color to the viewer + void setBackgroundColor( const QColor& ); + + //! Get size of trihedron of the viewer (see #SVTK_Renderer::SetTrihedronSize) + int trihedronSize() const; + + //! Set size of trihedron of the viewer (see #SVTK_Renderer::SetTrihedronSize) + void setTrihedronSize( const int ); public: void enableSelection(bool isEnabled); @@ -46,14 +61,30 @@ public: int getSelectionCount() const; /* Reimplemented from SALOME_View */ - void Display( const SALOME_VTKPrs* ); - void Erase( const SALOME_VTKPrs*, const bool = false ); - void EraseAll( const bool = false ); - SALOME_Prs* CreatePrs( const char* entry = 0 ); - virtual void BeforeDisplay( SALOME_Displayer* d ); - virtual void AfterDisplay ( SALOME_Displayer* d ); - virtual bool isVisible( const Handle(SALOME_InteractiveObject)& ); - virtual void Repaint(); + + //! See #SALOME_View::Display( const SALOME_Prs* ) + void Display( const SALOME_VTKPrs* ); + + //! See #SALOME_View::Erase( const SALOME_VTKPrs*, const bool = false ) + void Erase( const SALOME_VTKPrs*, const bool = false ); + + //! See #SALOME_View::EraseAll( const bool = false ) + void EraseAll( const bool = false ); + + //! See #SALOME_View::CreatePrs( const char* entry = 0 ) + SALOME_Prs* CreatePrs( const char* entry = 0 ); + + //! See #SALOME_View::BeforeDisplay( SALOME_Displayer* d ) + virtual void BeforeDisplay( SALOME_Displayer* d ); + + //! See #SALOME_View::AfterDisplay( SALOME_Displayer* d ) + virtual void AfterDisplay( SALOME_Displayer* d ); + + //! See #SALOME_View::isVisible( const Handle(SALOME_InteractiveObject)& ) + virtual bool isVisible( const Handle(SALOME_InteractiveObject)& ); + + //! See #SALOME_View::Repaint() + virtual void Repaint(); protected slots: void onMousePress(SUIT_ViewWindow*, QMouseEvent*); -- 2.39.2