CarpetViewer Class Reference
[Gui/ThreeD/Carpet/Mechanization]

A class used to present a visible display of a "carpet plot". More...

#include <CarpetViewer.h>

Inheritance diagram for CarpetViewer:

Inheritance graph
[legend]
Collaboration diagram for CarpetViewer:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeMacro (CarpetViewer, vtkObject)
void PrintSelf (ostream &os, vtkIndent indent)
 Print the state of this object.
void renderWindow (vtkRenderWindow *window)
 Specify the Vtk RenderWindow that this viewer is to work with.
vtkRenderWindowrenderWindow () const
 Give the Vtk RenderWindow that this viewer is working with.
void initializeInteractor ()
 Initialize the Render Window Interactor.
vtkRenderWindowInteractorrenderWindowInteractor () const
 Give the Interactor associated with the Render Window.
vtkRendererrenderer () const
 Give the renderer in use.
void addActor (const std::string filename, float decimate=0.0)
 Add a new dataflow to the scene.
void addActor (const char *filename, float decimate=0.0)
 Add a new dataflow to the scene.
void removeActor (const std::string key)
 Remove a dataflow from the scene.
void removeActor (const char *key)
 Remove a dataflow from the scene.
const char * name (int index) const
 Give the name of a FiletoActor.
int numberOfActors () const
 Give the number of FiletoActors currently opened.
const ssFiletoActorContaineractors () const
 Give the list of actors.
void clear ()
 Delete all actors.
void axesOn ()
 Make a set of axes.
void axesOff ()
 Remove the axes from the display (if they exist).
void wireOn ()
 Convert all actors to wire frame display.
void wireOff ()
 Convert all actors to surface display.
void start ()
 Start the internal vtkRenderWindowInteractor.
void notify ()
 Implement the Observer notify() function.
void DebugOn ()
 Set debugging for this object, and selected contained objects, on.
void DebugOff ()
 Set debbuging off in those objects that it is set on by DebugOn().

Static Public Member Functions

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

Protected Member Functions

 CarpetViewer ()
 Ctor.
 ~CarpetViewer ()
 Dtor.

Detailed Description

A class used to present a visible display of a "carpet plot".

The plot is rendered on an externally supplied vtkRenderWindow. This class contains an initialized vtkRenderWindowInteractor which may be actived with the start() method.

This class is thread safe.

Definition at line 38 of file CarpetViewer.h.


Constructor & Destructor Documentation

CarpetViewer::CarpetViewer (  )  [protected]

Ctor.

CarpetViewer::~CarpetViewer (  )  [protected]

Dtor.


Member Function Documentation

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

Reimplemented in CarpetViewerSingleton.

CarpetViewer::vtkTypeMacro ( CarpetViewer  ,
vtkObject   
)

void CarpetViewer::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 vtkObject.

Reimplemented in CarpetViewerSingleton.

void CarpetViewer::renderWindow ( vtkRenderWindow window  ) 

Specify the Vtk RenderWindow that this viewer is to work with.

Parameters:
window The render window.

vtkRenderWindow* CarpetViewer::renderWindow (  )  const

Give the Vtk RenderWindow that this viewer is working with.

Returns:
The renderer. If it has not yet been specified then 0.

void CarpetViewer::initializeInteractor (  ) 

Initialize the Render Window Interactor.

The semantics of the Interactor mandate that this function should not be called until after the Render Window has been realized.

vtkRenderWindowInteractor* CarpetViewer::renderWindowInteractor (  )  const

Give the Interactor associated with the Render Window.

Returns:
The Interactor. If none then 0.

vtkRenderer* CarpetViewer::renderer (  )  const

Give the renderer in use.

Returns:
The renderer.

void CarpetViewer::addActor ( const std::string  filename,
float  decimate = 0.0 
)

Add a new dataflow to the scene.

Parameters:
filename The FQFN of the data.
decimate A value, 0.0 <= decimate < 1.0, that represents the decimation factor. A value of 0.0 represents no decimation and 1.0 represents maximum (i.e. 100%) decimation. Note that maximum decimation may produce unusual results.

void CarpetViewer::addActor ( const char *  filename,
float  decimate = 0.0 
)

Add a new dataflow to the scene.

Parameters:
filename The FQFN of the data.
decimate A value, 0.0 <= decimate < 1.0, that represents the decimation factor. A value of 0.0 represents no decimation and 1.0 represents maximum (i.e. 100%) decimation. Note that maximum decimation may produce unusual results.

void CarpetViewer::removeActor ( const std::string  key  ) 

Remove a dataflow from the scene.

Parameters:
key The key used to add the dataflow.

void CarpetViewer::removeActor ( const char *  key  ) 

Remove a dataflow from the scene.

Parameters:
key The key used to add the dataflow.

const char* CarpetViewer::name ( int  index  )  const

Give the name of a FiletoActor.

Parameters:
index The index number of the row.
Returns:
The name of the row.

int CarpetViewer::numberOfActors (  )  const

Give the number of FiletoActors currently opened.

Returns:
Number of FiletoActors.

const ssFiletoActorContainer* CarpetViewer::actors (  )  const

Give the list of actors.

Returns:
A reference to the list of actors.

void CarpetViewer::clear (  ) 

Delete all actors.

void CarpetViewer::axesOn (  ) 

Make a set of axes.

An attempt is made to place the axes in such a manner so that they are reasonable and visible.

void CarpetViewer::axesOff (  ) 

Remove the axes from the display (if they exist).

void CarpetViewer::wireOn (  ) 

Convert all actors to wire frame display.

void CarpetViewer::wireOff (  ) 

Convert all actors to surface display.

void CarpetViewer::start (  ) 

Start the internal vtkRenderWindowInteractor.

This function does not return so the thread containing this call is blocked.

void CarpetViewer::notify (  )  [virtual]

Implement the Observer notify() function.

This function will generate notify()s to those Observer objects that are registered with with this object.

Reimplemented from Observer.

void CarpetViewer::DebugOn (  )  [virtual]

Set debugging for this object, and selected contained objects, on.

Reimplemented from vtkObject.

void CarpetViewer::DebugOff (  )  [virtual]

Set debbuging off in those objects that it is set on by DebugOn().

Reimplemented from vtkObject.


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