From 3989f42077d66fe875a3ca483010d5cd8ee5889b Mon Sep 17 00:00:00 2001 From: ouv Date: Fri, 11 Nov 2005 14:14:19 +0000 Subject: [PATCH] Documentation. --- src/OBJECT/VISU_GaussPtsAct.h | 48 +++++++++++++++++++++++++-- src/OBJECT/VISU_GaussPtsSettings.h | 15 ++++++++- src/VVTK/VVTK_PickingDlg.h | 8 +++++ src/VVTK/VVTK_SegmentationCursorDlg.h | 11 ++++++ 4 files changed, 79 insertions(+), 3 deletions(-) diff --git a/src/OBJECT/VISU_GaussPtsAct.h b/src/OBJECT/VISU_GaussPtsAct.h index 05accb6e..3721026b 100644 --- a/src/OBJECT/VISU_GaussPtsAct.h +++ b/src/OBJECT/VISU_GaussPtsAct.h @@ -64,6 +64,12 @@ class VISU_OutsideCursorSettings; //============================================================================ +//! Base class for Gauss Points Actors. +/*! + * Contains device actor (VISU_GaussPtsDeviceActor), + * which has two representation modes - outside and + * inside segmentation cursor. + */ class VTKOCC_EXPORT VISU_GaussPtsAct : public VISU_Actor { public: @@ -87,14 +93,17 @@ class VTKOCC_EXPORT VISU_GaussPtsAct : public VISU_Actor ShallowCopyPL(VISU_PipeLine* thePipeLine); //---------------------------------------------------------------------------- + //! Redefined method of getting a native mapper of the actor. virtual vtkMapper* GetMapper(); + //! Redefined method of getting an actor bounds. virtual float* GetBounds(); + //! Redefined method of getting an actor input. virtual vtkDataSet* GetInput(); @@ -108,61 +117,78 @@ class VTKOCC_EXPORT VISU_GaussPtsAct : public VISU_Actor GetGaussPtsFactory(); //---------------------------------------------------------------------------- + //! Add actor to the renderer. virtual void AddToRender(vtkRenderer* theRenderer); + //! Remove actor from the renderer. virtual void RemoveFromRender(vtkRenderer* theRenderer); + //! Set the Render Window Interactor to the actor. virtual void SetInteractor(vtkRenderWindowInteractor* theInteractor); + //! Apply the transform on the actor. virtual void SetTransform(VTKViewer_Transform* theTransform); + //! Redefined method of rendering the Opaque Geometry. virtual int RenderOpaqueGeometry(vtkViewport *viewport); + //! Redefined method of rendering the Translucent Geometry. virtual int RenderTranslucentGeometry(vtkViewport *viewport); //---------------------------------------------------------------------------- + //! Set actor visibility. virtual void SetVisibility(int theMode); + //! Set Scalar Bar Control to the actor. VISU_ScalarBarCtrl* GetScalarBarCtrl(); + //! Set the Scalar Bar Control visibility. void SetBarVisibility(bool theMode); + //! Get the Scalar Bar Control visibility. bool GetBarVisibility(); + //! Set Implicit Function Widget to the actor. virtual void SetImplicitFunctionWidget(VISU_ImplicitFunctionWidget* theWidget); + //! Return the information about pipeline magnification changing. + /*! True indicates that magnification is increased, false - decreased. */ bool ChangeMagnification(); //---------------------------------------------------------------------------- + //! Internal highlight. virtual void Highlight(bool theIsHighlight); + //! Redefined method of the actor's prehighlighting virtual bool PreHighlight(vtkInteractorStyle* theInteractorStyle, SVTK_SelectionEvent* theSelectionEvent, bool theIsHighlight); + + //! Redefined method of the actor's highlighting virtual bool Highlight(vtkInteractorStyle* theInteractorStyle, @@ -170,9 +196,11 @@ class VTKOCC_EXPORT VISU_GaussPtsAct : public VISU_Actor bool theIsHighlight); //---------------------------------------------------------------------------- + //! Set the picking settings to the actor. void SetPickingSettings(VISU_PickingSettings* thePickingSettings); + //! Apply the picking settings on the actor. void UpdatePickingSettings(); @@ -187,6 +215,7 @@ class VTKOCC_EXPORT VISU_GaussPtsAct : public VISU_Actor virtual ~VISU_GaussPtsAct(); + // Redefined method of setting mapper input. virtual void SetMapperInput(vtkDataSet* theDataSet); @@ -198,13 +227,15 @@ class VTKOCC_EXPORT VISU_GaussPtsAct : public VISU_Actor //---------------------------------------------------------------------------- vtkSmartPointer myEventCallbackCommand; - // Main process VTK event method + //! Main process VTK event method static void ProcessEvents(vtkObject* theObject, unsigned long theEvent, void* theClientData, void* theCallData); + + // To process VTK event method virtual void OnInteractorEvent(unsigned long theEvent); @@ -242,6 +273,7 @@ class VTKOCC_EXPORT VISU_GaussPtsAct : public VISU_Actor //============================================================================ class VISU_GaussPtsAct2; +//! Gauss Points Actor, displayed in the Base View. class VTKOCC_EXPORT VISU_GaussPtsAct1 : public VISU_GaussPtsAct { public: @@ -256,6 +288,7 @@ class VTKOCC_EXPORT VISU_GaussPtsAct1 : public VISU_GaussPtsAct ShallowCopyPL(VISU_PipeLine* thePipeLine); //---------------------------------------------------------------------------- + //! Set actor visibility. virtual void SetVisibility(int theMode); @@ -265,25 +298,31 @@ class VTKOCC_EXPORT VISU_GaussPtsAct1 : public VISU_GaussPtsAct Connect(VISU_GaussPtsAct2* theActor); //---------------------------------------------------------------------------- + //! Set the Outside Cursor Gauss Points settings to the actor. void SetOutsideCursorSettings(VISU_OutsideCursorSettings* theOutsideCursorSettings); + //! Apply the Outside Cursor Gauss Points settings on the actor. void UpdateOutsideCursorSettings(); //---------------------------------------------------------------------------- + //! Add actor to the renderer. virtual void AddToRender(vtkRenderer* theRenderer); + //! Remove actor from the renderer. virtual void RemoveFromRender(vtkRenderer* theRenderer); + //! Apply the transform on the actor. virtual void SetTransform(VTKViewer_Transform* theTransform); + //! Set Implicit Function Widget to the actor. virtual void SetImplicitFunctionWidget(VISU_ImplicitFunctionWidget* theWidget); @@ -295,6 +334,7 @@ class VTKOCC_EXPORT VISU_GaussPtsAct1 : public VISU_GaussPtsAct virtual ~VISU_GaussPtsAct1(); + // Redefined method of setting mapper input. virtual void SetMapperInput(vtkDataSet* theDataSet); @@ -322,7 +362,7 @@ class VTKOCC_EXPORT VISU_GaussPtsAct1 : public VISU_GaussPtsAct }; -//============================================================================ +//! Gauss Points Actor, displayed in the Segmented View. class VTKOCC_EXPORT VISU_GaussPtsAct2 : public VISU_GaussPtsAct { public: @@ -332,6 +372,7 @@ class VTKOCC_EXPORT VISU_GaussPtsAct2 : public VISU_GaussPtsAct VISU_GaussPtsAct2* New(); + // Redefined method of setting mapper input. virtual void SetMapperInput(vtkDataSet* theDataSet); @@ -341,14 +382,17 @@ class VTKOCC_EXPORT VISU_GaussPtsAct2 : public VISU_GaussPtsAct ShallowCopyPL(VISU_PipeLine* thePipeLine); //---------------------------------------------------------------------------- + //! Set actor visibility. virtual void SetVisibility(int theMode); + //! Get actor visibility. virtual int GetVisibility(); + //! Set Implicit Function Widget to the actor. virtual void SetImplicitFunctionWidget(VISU_ImplicitFunctionWidget* theWidget); diff --git a/src/OBJECT/VISU_GaussPtsSettings.h b/src/OBJECT/VISU_GaussPtsSettings.h index e7618d79..178cd517 100644 --- a/src/OBJECT/VISU_GaussPtsSettings.h +++ b/src/OBJECT/VISU_GaussPtsSettings.h @@ -42,6 +42,12 @@ namespace VISU const vtkIdType UpdatePickingSettingsEvent = vtkCommand::UserEvent + 200; } +//! Class of Outside Cursor Gauss Points settings. +/*! + * Contains information about the point sprite parameters: + * Clamp, Texture, Alpha threshold, Const size and Color. + * Used by Gauss Points Actor. + */ class VISU_OutsideCursorSettings : public vtkObject { public: @@ -83,7 +89,14 @@ private: }; -//============================================================================ +//! Class of Picking settings. +/*! + * Contains information about the following parameters: + * Cursor Pyramid height, Info Window transparency, + * Info Window position, Zoom factor on first selected point, + * Camera movement steps number and Display parent mesh. + * Used by Gauss Points Actor. + */ class VISU_PickingSettings : public vtkObject { public: diff --git a/src/VVTK/VVTK_PickingDlg.h b/src/VVTK/VVTK_PickingDlg.h index 5f4fb2d9..7e8b375d 100644 --- a/src/VVTK/VVTK_PickingDlg.h +++ b/src/VVTK/VVTK_PickingDlg.h @@ -33,6 +33,11 @@ class VISU_PickingSettings; class SVTK_RenderWindowInteractor; +//! Picking Dialog. +/*! + * Uses for set up picking preferenses and apply + * them to all actors in the current renderer. + */ class VVTK_PickingDlg : public QDialog { Q_OBJECT @@ -41,11 +46,14 @@ public: VVTK_PickingDlg( QWidget* parent = 0, const char* name = 0 ); ~VVTK_PickingDlg(); + //! Used to switch toggle state of the Picking action. void SetAction( QtxAction* theAction ) { myAction = theAction; } + //! Make an actor to listen the event of Update Picking Settings event. void AddActor( VISU_GaussPtsAct* ); void RemoveActor( VISU_GaussPtsAct* ); + //! Update dialog contents. void Update(); VISU_PickingSettings* GetPickingSettings(); diff --git a/src/VVTK/VVTK_SegmentationCursorDlg.h b/src/VVTK/VVTK_SegmentationCursorDlg.h index 1e63fcad..d41ea973 100644 --- a/src/VVTK/VVTK_SegmentationCursorDlg.h +++ b/src/VVTK/VVTK_SegmentationCursorDlg.h @@ -34,6 +34,11 @@ class VISU_GaussPtsAct1; class VISU_OutsideCursorSettings; class VISU_ImplicitFunctionWidget; +//! Segmentation Cursor Dialog. +/*! + * Uses for set up Segmentation and Outside Cursor Gauss Points preferenses + * and apply them to all actors in the current renderer. + */ class VVTK_SegmentationCursorDlg : public QDialog { Q_OBJECT @@ -42,14 +47,20 @@ public: VVTK_SegmentationCursorDlg( QWidget* parent = 0, const char* name = 0 ); ~VVTK_SegmentationCursorDlg(); + //! Make an actor to listen the event of Update Ouside Cursor Settings event. void AddActor( VISU_GaussPtsAct1* ); void RemoveActor( VISU_GaussPtsAct1* ); + //! Set the Implicit Function Widget. void SetWidget( VISU_ImplicitFunctionWidget* ); + + //! Used to switch toggle state of the Segmentation action. void SetAction( QtxAction* theAction ) { myAction = theAction; } + //! Update contents of the Segmentation tab. void UpdateSegmentation(); + //! Update contents of the Outside Cursor tab. void UpdateOutsideCursor(); VISU_OutsideCursorSettings* GetOutsideCursorSettings(); -- 2.39.2