ssMultibeamRenderView Class Reference
[Gui/Plan/Aquisition]

This class is the base of the various specialized render views. More...

#include <ssMultibeamRenderView.h>

Inheritance diagram for ssMultibeamRenderView:

Inheritance graph
[legend]
Collaboration diagram for ssMultibeamRenderView:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeMacro (ssMultibeamRenderView, ssMultibeamView)
void PrintSelf (ostream &os, vtkIndent indent)
 Print the state of this object.
void CreateRenderObjects (ssMultibeamApplication *mbApp)
 Set the application right after construction.
virtual void CreateViewProperties ()
 Add widgets to vtkKWView's notebook.
virtual void Create (vtkKWApplication *app, const char *args)
 Create the TK widgets associated with the view.
vtkPolyDataGetInput () const
 Give the PolyData input to this graphic render view.
void ResetCamera ()
 Method called by the toolbar reset camera button.
void StandardViewCallback (float x, float y, float z)
 Callback to set the view up or down one of the three axes.
virtual void SaveAsImage ()
 Make snapshot of the render window.
virtual void SaveAsImage (const char *filename)
 Make snapshot of the render window.
ssMultibeamApplicationGetMBApplication ()
 Give this objects application as a MultibeamApplication.
void Render ()
 Render now if poosible.
void EventuallyRender ()
 Set the EventuallyRenderFlag.
void EventuallyRenderCallBack ()
void UpdateTclButAvoidRendering ()
 Tcl "update" has to be called for various reasons (packing).
void Exposed ()
 Callback method bound to expose events.
void Configured ()
 Callback method bound to configure events.
vtkRendererGetRenderer ()
 Give the renderer.
vtkRenderWindowGetRenderWindow ()
 Give the render window.
void AddBindings ()
 Bind some widget to a motion callback (in the Tcl) ??
void SaveRendererState (ofstream *file)
 Save the state of the renderer to a file.
void SaveRenderWindowState (ofstream *file)
 Save the state of the render window to a file.
void SetBackgroundColor (float r, float g, float b)
 Specify the background color.
virtual void Close ()
 Close the view - called from the vtkkwwindow.
void PrepareForDelete ()
 This method Sets all IVars to NULL and unregisters vtk objects.
ssMultibeamWindowGetMBWindow ()
 Give the parent window.
int * GetRenderWindowSize ()
 Get the size of the render window.
void ExecuteEvent (vtkObject *wdg, unsigned long event, void *calldata)
 This method is called when an event is called that ssMultibeamRenderView is interested in.

Static Public Member Functions

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

Protected Member Functions

 ssMultibeamRenderView ()
 Ctor.
virtual ~ssMultibeamRenderView ()
 Dtor.
 vtkSetStringMacro (RenderPending)

Protected Attributes

vtkPVRenderModuleUI * RenderModuleUI
int EventuallyRenderFlag
char * RenderPending
vtkKWWidgetTopLevelRenderWindow
vtkPVInteractorStyleControl * ManipulatorControl2D
vtkPVInteractorStyleControl * ManipulatorControl3D
ssMultibeamRenderViewObserver * Observer
vtkActordataActor
 The Actor used to represent the data of interest entity (e.g.
vtkPolyDataMapperdataMapper
 The Mapper that maps the data of interest (e.g.

Detailed Description

This class is the base of the various specialized render views.

Definition at line 83 of file ssMultibeamRenderView.h.


Constructor & Destructor Documentation

ssMultibeamRenderView::ssMultibeamRenderView (  )  [protected]

Ctor.

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

Dtor.


Member Function Documentation

static ssMultibeamRenderView* ssMultibeamRenderView::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 ssMultibeamView.

Reimplemented in ssMultibeamAcrossBathymetryRenderView, ssMultibeamAlongBathymetryRenderView, and ssMultibeamPlanRenderView.

ssMultibeamRenderView::vtkTypeMacro ( ssMultibeamRenderView  ,
ssMultibeamView   
)

void ssMultibeamRenderView::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

Print the state of this object.

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

Reimplemented from ssMultibeamView.

Reimplemented in ssMultibeamAcrossBathymetryRenderView, ssMultibeamAlongBathymetryRenderView, and ssMultibeamPlanRenderView.

void ssMultibeamRenderView::CreateRenderObjects ( ssMultibeamApplication mbApp  ) 

Set the application right after construction.

mbApp The application.

virtual void ssMultibeamRenderView::CreateViewProperties (  )  [virtual]

Add widgets to vtkKWView's notebook.

Reimplemented in ssMultibeamAcrossBathymetryRenderView, ssMultibeamAlongBathymetryRenderView, and ssMultibeamPlanRenderView.

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

Create the TK widgets associated with the view.

Parameters:
app The application.
args Aguments to the frame widget.

Reimplemented in ssMultibeamAcrossBathymetryRenderView, ssMultibeamAlongBathymetryRenderView, and ssMultibeamPlanRenderView.

vtkPolyData* ssMultibeamRenderView::GetInput (  )  const

Give the PolyData input to this graphic render view.

Returns:
The data iput.

void ssMultibeamRenderView::ResetCamera (  ) 

Method called by the toolbar reset camera button.

void ssMultibeamRenderView::StandardViewCallback ( float  x,
float  y,
float  z 
)

Callback to set the view up or down one of the three axes.

Parameters:
x The position of the camera in the X domain.
y The position of the camera in the Y domain.
z The position of the camera in the Z domain.

virtual void ssMultibeamRenderView::SaveAsImage (  )  [inline, virtual]

Make snapshot of the render window.

Definition at line 166 of file ssMultibeamRenderView.h.

virtual void ssMultibeamRenderView::SaveAsImage ( const char *  filename  )  [virtual]

Make snapshot of the render window.

Parameters:
filename The destination path.

ssMultibeamApplication* ssMultibeamRenderView::GetMBApplication (  ) 

Give this objects application as a MultibeamApplication.

Returns:
The application cast to a MultibeamApplication.

void ssMultibeamRenderView::Render (  ) 

Render now if poosible.

Otherwise que a render.

void ssMultibeamRenderView::EventuallyRender (  ) 

Set the EventuallyRenderFlag.

void ssMultibeamRenderView::EventuallyRenderCallBack (  ) 

void ssMultibeamRenderView::UpdateTclButAvoidRendering (  ) 

Tcl "update" has to be called for various reasons (packing).

This calls update without triggering EventuallyRenderCallback. I was having problems with multiple renders.

void ssMultibeamRenderView::Exposed (  ) 

Callback method bound to expose events.

void ssMultibeamRenderView::Configured (  ) 

Callback method bound to configure events.

vtkRenderer* ssMultibeamRenderView::GetRenderer (  ) 

Give the renderer.

Returns:
The renderer.

vtkRenderWindow* ssMultibeamRenderView::GetRenderWindow (  ) 

Give the render window.

Returns:
The renderer.

Reimplemented from ssMultibeamView.

void ssMultibeamRenderView::AddBindings (  ) 

Bind some widget to a motion callback (in the Tcl) ??

void ssMultibeamRenderView::SaveRendererState ( ofstream *  file  ) 

Save the state of the renderer to a file.

Parameters:
file The stream of the file.

void ssMultibeamRenderView::SaveRenderWindowState ( ofstream *  file  ) 

Save the state of the render window to a file.

Parameters:
file The file stream.

void ssMultibeamRenderView::SetBackgroundColor ( float  r,
float  g,
float  b 
)

Specify the background color.

Parameters:
r The red value.
g The green value.
b The blue value.

virtual void ssMultibeamRenderView::Close (  )  [virtual]

Close the view - called from the vtkkwwindow.

This default method will simply call Close() for all the composites. Can be overridden.

void ssMultibeamRenderView::PrepareForDelete (  ) 

This method Sets all IVars to NULL and unregisters vtk objects.

This should eliminate circular references.

ssMultibeamWindow* ssMultibeamRenderView::GetMBWindow (  ) 

Give the parent window.

Returns:
The parent window as a MultibeamWindow.

int* ssMultibeamRenderView::GetRenderWindowSize (  ) 

Get the size of the render window.

Returns:
The window size. Note not thread safe.

void ssMultibeamRenderView::ExecuteEvent ( vtkObject wdg,
unsigned long  event,
void *  calldata 
)

This method is called when an event is called that ssMultibeamRenderView is interested in.

Parameters:
wdg Unused.
event This is a vtkCommand::EventIds. If it is equal to vtkCommand::CursorChangedEvent then act on the calldata parameter, otherwise do nothing.
calldata An int* which points to a variable containing one of the defines in vtkRenderWindow.h. If the variable does not equal one of VTK_CURSOR_ARROW, VTK_CURSOR_SIZENE, VTK_CURSOR_SIZENW, VTK_CURSOR_SIZESW, VTK_CURSOR_SIZESE, VTK_CURSOR_SIZENS, VTK_CURSOR_SIZEWE, VTK_CURSOR_SIZEALL or VTK_CURSOR_HAND then set the cusor to "left_ptr" (see <widget> config -cursor), otherwise set the cursor IAW *calldata.

ssMultibeamRenderView::vtkSetStringMacro ( RenderPending   )  [protected]

Reimplemented in ssMultibeamAcrossBathymetryRenderView, ssMultibeamAlongBathymetryRenderView, and ssMultibeamPlanRenderView.


Member Data Documentation

vtkPVRenderModuleUI* ssMultibeamRenderView::RenderModuleUI [protected]

Definition at line 322 of file ssMultibeamRenderView.h.

int ssMultibeamRenderView::EventuallyRenderFlag [protected]

Definition at line 324 of file ssMultibeamRenderView.h.

char* ssMultibeamRenderView::RenderPending [protected]

Definition at line 325 of file ssMultibeamRenderView.h.

vtkKWWidget* ssMultibeamRenderView::TopLevelRenderWindow [protected]

Definition at line 329 of file ssMultibeamRenderView.h.

vtkPVInteractorStyleControl* ssMultibeamRenderView::ManipulatorControl2D [protected]

Definition at line 331 of file ssMultibeamRenderView.h.

vtkPVInteractorStyleControl* ssMultibeamRenderView::ManipulatorControl3D [protected]

Definition at line 332 of file ssMultibeamRenderView.h.

ssMultibeamRenderViewObserver* ssMultibeamRenderView::Observer [protected]

Definition at line 334 of file ssMultibeamRenderView.h.

vtkActor* ssMultibeamRenderView::dataActor [protected]

The Actor used to represent the data of interest entity (e.g.

Plan Bathymetry etc.).

Definition at line 340 of file ssMultibeamRenderView.h.

vtkPolyDataMapper* ssMultibeamRenderView::dataMapper [protected]

The Mapper that maps the data of interest (e.g.

Plan, Bathymetry etc.)

Definition at line 345 of file ssMultibeamRenderView.h.


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