ssMultibeamWindow Class Reference
[Gui/Plan/Aquisition]

The purpose of this class is to manage the GUI. More...

#include <ssMultibeamWindow.h>

Inheritance diagram for ssMultibeamWindow:

Inheritance graph
[legend]
Collaboration diagram for ssMultibeamWindow:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeMacro (ssMultibeamWindow, vtkKWWindow)
void PrintSelf (ostream &os, vtkIndent indent)
 Print the state of this object.
virtual void Create (vtkKWApplication *app, char *args)
 Create the user interface.
virtual vtkKWUserInterfaceManagerGetUserInterfaceManager ()
 Give the user interface manager.
ssMultibeamRenderViewPlanView () const
 Give the current Plan View.
ssMultibeamRenderViewAlongTrackBathymetryView () const
 Give the Along Track Bathymetry View.
ssMultibeamRenderViewAcrossTrackBathymetryView () const
 Give the Across Track Bathymetry View.

Static Public Member Functions

static ssMultibeamWindowNew ()
 Instantiate a new object of this type.

Protected Member Functions

 ssMultibeamWindow ()
 Ctor.
virtual ~ssMultibeamWindow ()
 Dtor.
void PrepareForDelete ()
 Clean up all the object we manage.
void UpdateStatusImage ()
 Update the status bar image.
ssMultibeamApplicationGetMultibeamApplication ()
 Give the current Application in a safe manner.
void InitializeMenus (vtkKWApplication *app)
 Setup the menus.
void CreatePlanView (ssMultibeamApplication *app)
 Create the plan view.
void CreateAlongTrackBathymetryView (ssMultibeamApplication *app)
 Create the along track bathymetry view.
void CreateAcrossTrackBathymetryView (ssMultibeamApplication *app)
 Create the across track bathymetry view.
void InitializeRenderFrames ()
 Setup the Render Frames if necessary (on right hand side of display).
void InteractorTclName (const char *name)
 Specify the Interactor Tcl name.
const char * InteractorTclName () const
 Give the Interactor Tcl name.
void CenterSourceTclName (const char *name)
 Specify the Tcl name of the center object in the plan window.
void CenterMapperTclName (const char *name)
 Specify the Tcl name of the center mapper in the plan window.
void CenterActorTclName (const char *name)
 Specify the Tcl name of the center actor in the plan window.

Protected Attributes

const char * interactorTclName
ssMultibeamPlanRenderViewplanView
 The plan view showing tracks etc.
ssMultibeamAcrossBathymetryRenderViewacrossTrackBathymetryView
 The across track bathymetry showing data from the rear and above.
ssMultibeamAlongBathymetryRenderViewalongTrackBathymetryView
 The along track bathymetry view showing data from left or right and above.
vtkKWSplitFramehorizontalFrame
 Contains the plan view to the left and the frame that holds the frame that contians the bathymetry to the right.
vtkKWSplitFrameverticalFrame
 Contains the across track bathymetry in the top and the along track bathymetry in the bottom.
vtkKWUserInterfaceNotebookManager * userInterfaceManager
 This is the note book UI in the left most frame.
char * centerSourceTclName
char * centerMapperTclName
char * centerActorTclName

Detailed Description

The purpose of this class is to manage the GUI.

Definition at line 28 of file ssMultibeamWindow.h.


Constructor & Destructor Documentation

ssMultibeamWindow::ssMultibeamWindow (  )  [protected]

Ctor.

virtual ssMultibeamWindow::~ssMultibeamWindow (  )  [protected, virtual]

Dtor.


Member Function Documentation

static ssMultibeamWindow* ssMultibeamWindow::New (  )  [static]

Instantiate a new object of this type.

This is the only method that objects of this type may be created.

Returns:
The new object.

Reimplemented from vtkKWWindow.

ssMultibeamWindow::vtkTypeMacro ( ssMultibeamWindow  ,
vtkKWWindow   
)

void ssMultibeamWindow::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Print the state of this object.

Parameters:
os The output stream.
indent The indentation level. Used for formating output.

Reimplemented from vtkKWWindow.

virtual void ssMultibeamWindow::Create ( vtkKWApplication app,
char *  args 
) [virtual]

Create the user interface.

Parameters:
app The Application.
args ??

virtual vtkKWUserInterfaceManager* ssMultibeamWindow::GetUserInterfaceManager (  )  [virtual]

Give the user interface manager.

If there is not a interface manager then make a Notebook manager and return it.

Returns:
The user interface manager.

ssMultibeamRenderView* ssMultibeamWindow::PlanView (  )  const

Give the current Plan View.

Returns:
The Plan View.

ssMultibeamRenderView* ssMultibeamWindow::AlongTrackBathymetryView (  )  const

Give the Along Track Bathymetry View.

Returns:
The Across Track Bathymetry View.

ssMultibeamRenderView* ssMultibeamWindow::AcrossTrackBathymetryView (  )  const

Give the Across Track Bathymetry View.

Returns:
The Across Track Bathymetry View.

void ssMultibeamWindow::PrepareForDelete (  )  [protected, virtual]

Clean up all the object we manage.

Reimplemented from vtkKWWindow.

void ssMultibeamWindow::UpdateStatusImage (  )  [protected, virtual]

Update the status bar image.

Reimplemented from vtkKWWindowBase.

ssMultibeamApplication* ssMultibeamWindow::GetMultibeamApplication (  )  [protected]

Give the current Application in a safe manner.

Returns:
The application suitably cast.

void ssMultibeamWindow::InitializeMenus ( vtkKWApplication app  )  [protected]

Setup the menus.

Parameters:
app The application.

void ssMultibeamWindow::CreatePlanView ( ssMultibeamApplication app  )  [protected]

Create the plan view.

Parameters:
app The application.

void ssMultibeamWindow::CreateAlongTrackBathymetryView ( ssMultibeamApplication app  )  [protected]

Create the along track bathymetry view.

Parameters:
app The application.

void ssMultibeamWindow::CreateAcrossTrackBathymetryView ( ssMultibeamApplication app  )  [protected]

Create the across track bathymetry view.

Parameters:
app The application.

void ssMultibeamWindow::InitializeRenderFrames (  )  [protected]

Setup the Render Frames if necessary (on right hand side of display).

void ssMultibeamWindow::InteractorTclName ( const char *  name  )  [protected]

Specify the Interactor Tcl name.

Parameters:
name The name.

const char* ssMultibeamWindow::InteractorTclName (  )  const [protected]

Give the Interactor Tcl name.

Returns:
The name.

void ssMultibeamWindow::CenterSourceTclName ( const char *  name  )  [protected]

Specify the Tcl name of the center object in the plan window.

This is usually a vtkAxes object.

Parameters:
name The Tcl name.

void ssMultibeamWindow::CenterMapperTclName ( const char *  name  )  [protected]

Specify the Tcl name of the center mapper in the plan window.

This is usually a vtkPolyDataMapper.

Parameters:
name The Tcl name.

void ssMultibeamWindow::CenterActorTclName ( const char *  name  )  [protected]

Specify the Tcl name of the center actor in the plan window.

This is usually a vtkActor.

Parameters:
name The Tcl name.


Member Data Documentation

const char* ssMultibeamWindow::interactorTclName [protected]

Definition at line 176 of file ssMultibeamWindow.h.

ssMultibeamPlanRenderView* ssMultibeamWindow::planView [protected]

The plan view showing tracks etc.

Definition at line 182 of file ssMultibeamWindow.h.

ssMultibeamAcrossBathymetryRenderView* ssMultibeamWindow::acrossTrackBathymetryView [protected]

The across track bathymetry showing data from the rear and above.

Definition at line 187 of file ssMultibeamWindow.h.

ssMultibeamAlongBathymetryRenderView* ssMultibeamWindow::alongTrackBathymetryView [protected]

The along track bathymetry view showing data from left or right and above.

Definition at line 192 of file ssMultibeamWindow.h.

vtkKWSplitFrame* ssMultibeamWindow::horizontalFrame [protected]

Contains the plan view to the left and the frame that holds the frame that contians the bathymetry to the right.

Definition at line 199 of file ssMultibeamWindow.h.

vtkKWSplitFrame* ssMultibeamWindow::verticalFrame [protected]

Contains the across track bathymetry in the top and the along track bathymetry in the bottom.

Definition at line 205 of file ssMultibeamWindow.h.

vtkKWUserInterfaceNotebookManager* ssMultibeamWindow::userInterfaceManager [protected]

This is the note book UI in the left most frame.

Definition at line 210 of file ssMultibeamWindow.h.

char* ssMultibeamWindow::centerSourceTclName [protected]

Definition at line 213 of file ssMultibeamWindow.h.

char* ssMultibeamWindow::centerMapperTclName [protected]

Definition at line 215 of file ssMultibeamWindow.h.

char* ssMultibeamWindow::centerActorTclName [protected]

Definition at line 217 of file ssMultibeamWindow.h.


The documentation for this class was generated from the following file: