ssMultibeamRenderModule Class Reference
[Gui/Plan/Aquisition]

#include <ssMultibeamRenderModule.h>

Inheritance diagram for ssMultibeamRenderModule:

Inheritance graph
[legend]
Collaboration diagram for ssMultibeamRenderModule:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (ssMultibeamRenderModule, vtkObject)
void PrintSelf (ostream &os, vtkIndent indent)
 Print the state of this object.
virtual void Application (ssMultibeamApplication *app)
 Specify the application right after construction.
ssMultibeamApplicationApplication () const
 Give the application.
void ComputeVisiblePropBounds (double bounds[6])
 Compute the bounding box of all the visibile props Used in ResetCamera() and ResetCameraClippingRange().
void AddPVSource (vtkPVSource *pvs)
 This method is executed in all processes.
void RemovePVSource (vtkPVSource *pvs)
virtual void StillRender ()
 Renders using Still/FullRes.
virtual void InteractiveRender ()
 Renders using interactive/LODs.
vtkRendererGetRenderer ()
 Give the Plan Renderer.
vtkRendererGetPlanRenderer () const
 Give the Plan Renderer.
vtkRendererGetAcrossRenderer () const
 Give the Across Bathymetry Renderer.
vtkRendererGetAlongRenderer () const
 Give the Along Bathymetry Renderer.
vtkRenderWindowGetPlanRenderWindow () const
 Give the Plan Render Window.
vtkRenderWindowGetAcrossRenderWindow () const
 Give the Across Bathymetry Render Window.
vtkRenderWindowGetAlongRenderWindow () const
 Give the Along Bathymetry Render Window.
void SetBackgroundColor (float r, float g, float b)
 Change the background color.
virtual void SetBackgroundColor (float *c)
 Change the background color.
 vtkGetStringMacro (PlanRendererTclName)
 Give the Tcl name of the Plan Renderer.
 vtkGetStringMacro (AcrossRendererTclName)
 Give the Tcl name of the Across Bathymetry Renderer.
 vtkGetStringMacro (AlongRendererTclName)
 Give the Tcl name of the Along Bathymetry Renderer.
 vtkGetStringMacro (PlanRenderWindowTclName)
 Give the Tcl name of the Plan Render Window.
 vtkGetStringMacro (AcrossRenderWindowTclName)
 Give the Tcl name of the Across Render Window.
 vtkGetStringMacro (AlongRenderWindowTclName)
 Give the Tcl name of the Along Render Window.
void SetUseTriangleStrips (int val)
 Callback for the triangle strips check button.
void SetUseImmediateMode (int val)
 Callback for the immediate mode rendering check button.
void SetUseParallelProjection (int val)
 Change between parallel or perspective camera.
 vtkSetMacro (RenderInterruptsEnabled, int)
 Specify whether the render module invokes abort check events.
 vtkGetMacro (RenderInterruptsEnabled, int)
 Give the state of the abort checks interrupt flag.
 vtkBooleanMacro (RenderInterruptsEnabled, int)
virtual float GetZBufferValue (int x, int y)
 Give the value of the z buffer at a position.
 vtkSetMacro (TotalVisibleMemorySizeValid, int)
 Specify whether the visible memory size is valid.
 vtkGetMacro (TotalVisibleMemorySizeValid, int)
 Give whether the visible memory size is valid.

Static Public Member Functions

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

Protected Member Functions

 ssMultibeamRenderModule ()
 ~ssMultibeamRenderModule ()
virtual void UpdateAllPVData ()
 This is used before a render to make sure all visible sources have been updated.
 vtkSetStringMacro (PlanRendererTclName)
 vtkSetStringMacro (AcrossRendererTclName)
 vtkSetStringMacro (AlongRendererTclName)
 vtkSetStringMacro (PlanRenderWindowTclName)
 Specify the Plan Render Window name.
 vtkSetStringMacro (AcrossRenderWindowTclName)
 Specify the Across Render Window name.
 vtkSetStringMacro (AlongRenderWindowTclName)
 Specify the Along Render Window name.

Protected Attributes

ssMultibeamApplicationapplication
vtkRendererPlanRenderer
vtkRendererAcrossRenderer
vtkRendererAlongRenderer
vtkRenderWindowPlanRenderWindow
vtkRenderWindowAcrossRenderWindow
vtkRenderWindowAlongRenderWindow
int TotalVisibleMemorySizeValid
char * PlanRendererTclName
char * AcrossRendererTclName
char * AlongRendererTclName
char * PlanRenderWindowTclName
char * AcrossRenderWindowTclName
char * AlongRenderWindowTclName
double StillRenderTime
double InteractiveRenderTime
int DisableRenderingFlag
int RenderInterruptsEnabled
unsigned long ResetCameraClippingRangeTag

Detailed Description

Definition at line 74 of file ssMultibeamRenderModule.h.


Constructor & Destructor Documentation

ssMultibeamRenderModule::ssMultibeamRenderModule (  )  [protected]

ssMultibeamRenderModule::~ssMultibeamRenderModule (  )  [protected]


Member Function Documentation

static ssMultibeamRenderModule* ssMultibeamRenderModule::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 vtkObject.

ssMultibeamRenderModule::vtkTypeRevisionMacro ( ssMultibeamRenderModule  ,
vtkObject   
)

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

Print the state of this object.

Parameters:
os The The output stream.
indent The indentation - for formating.

Reimplemented from vtkObject.

virtual void ssMultibeamRenderModule::Application ( ssMultibeamApplication app  )  [virtual]

Specify the application right after construction.

Parameters:
app The Multibeam application.

ssMultibeamApplication* ssMultibeamRenderModule::Application (  )  const

Give the application.

Returns:
The application.

void ssMultibeamRenderModule::ComputeVisiblePropBounds ( double  bounds[6]  ) 

Compute the bounding box of all the visibile props Used in ResetCamera() and ResetCameraClippingRange().

Parameters:
bounds The returned bounds.

void ssMultibeamRenderModule::AddPVSource ( vtkPVSource *  pvs  ) 

This method is executed in all processes.

void ssMultibeamRenderModule::RemovePVSource ( vtkPVSource *  pvs  ) 

virtual void ssMultibeamRenderModule::StillRender (  )  [virtual]

Renders using Still/FullRes.

virtual void ssMultibeamRenderModule::InteractiveRender (  )  [virtual]

Renders using interactive/LODs.

vtkRenderer* ssMultibeamRenderModule::GetRenderer (  ) 

Give the Plan Renderer.

Returns:
The Renderer in use.

vtkRenderer* ssMultibeamRenderModule::GetPlanRenderer (  )  const

Give the Plan Renderer.

Returns:
The Renderer in use.

vtkRenderer* ssMultibeamRenderModule::GetAcrossRenderer (  )  const

Give the Across Bathymetry Renderer.

Returns:
The Renderer in use.

vtkRenderer* ssMultibeamRenderModule::GetAlongRenderer (  )  const

Give the Along Bathymetry Renderer.

Returns:
The Renderer in use.

vtkRenderWindow* ssMultibeamRenderModule::GetPlanRenderWindow (  )  const

Give the Plan Render Window.

Returns:
The RenderWindow in use.

vtkRenderWindow* ssMultibeamRenderModule::GetAcrossRenderWindow (  )  const

Give the Across Bathymetry Render Window.

Returns:
The RenderWindow in use.

vtkRenderWindow* ssMultibeamRenderModule::GetAlongRenderWindow (  )  const

Give the Along Bathymetry Render Window.

Returns:
The RenderWindow in use.

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

Change the background color.

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

virtual void ssMultibeamRenderModule::SetBackgroundColor ( float *  c  )  [inline, virtual]

Change the background color.

Parameters:
c The rgb values.

Definition at line 195 of file ssMultibeamRenderModule.h.

ssMultibeamRenderModule::vtkGetStringMacro ( PlanRendererTclName   ) 

Give the Tcl name of the Plan Renderer.

This is still used in a couple of cases (cube axes ...) This will eventually be removed.

Returns:
The name of the Renderer.

ssMultibeamRenderModule::vtkGetStringMacro ( AcrossRendererTclName   ) 

Give the Tcl name of the Across Bathymetry Renderer.

This is still used in a couple of cases (cube axes ...) This will eventually be removed.

Returns:
The name of the Renderer.

ssMultibeamRenderModule::vtkGetStringMacro ( AlongRendererTclName   ) 

Give the Tcl name of the Along Bathymetry Renderer.

This is still used in a couple of cases (cube axes ...) This will eventually be removed.

Returns:
The name of the Renderer.

ssMultibeamRenderModule::vtkGetStringMacro ( PlanRenderWindowTclName   ) 

Give the Tcl name of the Plan Render Window.

This is still used in a couple of cases (cube axes ...) This will eventually be removed.

Returns:
The name of the Render Window.

ssMultibeamRenderModule::vtkGetStringMacro ( AcrossRenderWindowTclName   ) 

Give the Tcl name of the Across Render Window.

This is still used in a couple of cases (cube axes ...) This will eventually be removed.

Returns:
The name of the Render Window.

ssMultibeamRenderModule::vtkGetStringMacro ( AlongRenderWindowTclName   ) 

Give the Tcl name of the Along Render Window.

This is still used in a couple of cases (cube axes ...) This will eventually be removed.

Returns:
The name of the Render Window.

void ssMultibeamRenderModule::SetUseTriangleStrips ( int  val  ) 

Callback for the triangle strips check button.

Parameters:
val Non zero if to use triangle strips, zero otherwise.

void ssMultibeamRenderModule::SetUseImmediateMode ( int  val  ) 

Callback for the immediate mode rendering check button.

Parameters:
val Non zero if to be immediate mode, zero otherwise.

void ssMultibeamRenderModule::SetUseParallelProjection ( int  val  ) 

Change between parallel or perspective camera.

Since this is a camera manipulation, it does not have to be here.

Parameters:
val Non zero to enable parrallel projection, zero otherwise.

ssMultibeamRenderModule::vtkSetMacro ( RenderInterruptsEnabled  ,
int   
)

Specify whether the render module invokes abort check events.

Parameters:
val Non zero if interrupts enabled, zero otherwise.

ssMultibeamRenderModule::vtkGetMacro ( RenderInterruptsEnabled  ,
int   
)

Give the state of the abort checks interrupt flag.

Returns:
Non zero if interrupts enabled, zero otherwise.

ssMultibeamRenderModule::vtkBooleanMacro ( RenderInterruptsEnabled  ,
int   
)

virtual float ssMultibeamRenderModule::GetZBufferValue ( int  x,
int  y 
) [virtual]

Give the value of the z buffer at a position.

This is necessary for picking the center of rotation.

Returns:
The z buffer position.

ssMultibeamRenderModule::vtkSetMacro ( TotalVisibleMemorySizeValid  ,
int   
)

Specify whether the visible memory size is valid.

This is just a convenient spot to keep this flag. Render view uses this to descide whether to recompute the total memory size of visible geometry. This is necessary to decide between collection vs. distributed rendering. When we create rendering modules, the render view will be integrated with the ssMultibeamProcessModule and vtkPVParts and this flag can be moved.

ssMultibeamRenderModule::vtkGetMacro ( TotalVisibleMemorySizeValid  ,
int   
)

Give whether the visible memory size is valid.

This is just a convenient spot to keep this flag. Render view uses this to descide whether to recompute the total memory size of visible geometry. This is necessary to decide between collection vs. distributed rendering. When we create rendering modules, the render view will be integrated with the ssMultibeamProcessModule and vtkPVParts and this flag can be moved.

virtual void ssMultibeamRenderModule::UpdateAllPVData (  )  [protected, virtual]

This is used before a render to make sure all visible sources have been updated.

ssMultibeamRenderModule::vtkSetStringMacro ( PlanRendererTclName   )  [protected]

ssMultibeamRenderModule::vtkSetStringMacro ( AcrossRendererTclName   )  [protected]

ssMultibeamRenderModule::vtkSetStringMacro ( AlongRendererTclName   )  [protected]

ssMultibeamRenderModule::vtkSetStringMacro ( PlanRenderWindowTclName   )  [protected]

Specify the Plan Render Window name.

Parameters:
arg Than name.

ssMultibeamRenderModule::vtkSetStringMacro ( AcrossRenderWindowTclName   )  [protected]

Specify the Across Render Window name.

Parameters:
arg Than name.

ssMultibeamRenderModule::vtkSetStringMacro ( AlongRenderWindowTclName   )  [protected]

Specify the Along Render Window name.

Parameters:
arg Than name.


Member Data Documentation

ssMultibeamApplication* ssMultibeamRenderModule::application [protected]

Definition at line 321 of file ssMultibeamRenderModule.h.

vtkRenderer* ssMultibeamRenderModule::PlanRenderer [protected]

Definition at line 322 of file ssMultibeamRenderModule.h.

vtkRenderer* ssMultibeamRenderModule::AcrossRenderer [protected]

Definition at line 323 of file ssMultibeamRenderModule.h.

vtkRenderer* ssMultibeamRenderModule::AlongRenderer [protected]

Definition at line 324 of file ssMultibeamRenderModule.h.

vtkRenderWindow* ssMultibeamRenderModule::PlanRenderWindow [protected]

Definition at line 325 of file ssMultibeamRenderModule.h.

vtkRenderWindow* ssMultibeamRenderModule::AcrossRenderWindow [protected]

Definition at line 326 of file ssMultibeamRenderModule.h.

vtkRenderWindow* ssMultibeamRenderModule::AlongRenderWindow [protected]

Definition at line 327 of file ssMultibeamRenderModule.h.

int ssMultibeamRenderModule::TotalVisibleMemorySizeValid [protected]

Definition at line 330 of file ssMultibeamRenderModule.h.

char* ssMultibeamRenderModule::PlanRendererTclName [protected]

Definition at line 332 of file ssMultibeamRenderModule.h.

char* ssMultibeamRenderModule::AcrossRendererTclName [protected]

Definition at line 333 of file ssMultibeamRenderModule.h.

char* ssMultibeamRenderModule::AlongRendererTclName [protected]

Definition at line 334 of file ssMultibeamRenderModule.h.

char* ssMultibeamRenderModule::PlanRenderWindowTclName [protected]

Definition at line 339 of file ssMultibeamRenderModule.h.

char* ssMultibeamRenderModule::AcrossRenderWindowTclName [protected]

Definition at line 340 of file ssMultibeamRenderModule.h.

char* ssMultibeamRenderModule::AlongRenderWindowTclName [protected]

Definition at line 341 of file ssMultibeamRenderModule.h.

double ssMultibeamRenderModule::StillRenderTime [protected]

Definition at line 361 of file ssMultibeamRenderModule.h.

double ssMultibeamRenderModule::InteractiveRenderTime [protected]

Definition at line 362 of file ssMultibeamRenderModule.h.

int ssMultibeamRenderModule::DisableRenderingFlag [protected]

Definition at line 364 of file ssMultibeamRenderModule.h.

int ssMultibeamRenderModule::RenderInterruptsEnabled [protected]

Definition at line 365 of file ssMultibeamRenderModule.h.

unsigned long ssMultibeamRenderModule::ResetCameraClippingRangeTag [protected]

Definition at line 367 of file ssMultibeamRenderModule.h.


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