VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImageStack Class Reference

manages a stack of composited images More...

#include <vtkImageStack.h>

Inheritance diagram for vtkImageStack:
Inheritance graph
[legend]
Collaboration diagram for vtkImageStack:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkImageSlice Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void AddImage (vtkImageSlice *prop)
void RemoveImage (vtkImageSlice *prop)
int HasImage (vtkImageSlice *prop)
vtkImageSliceCollectionGetImages ()
vtkImageSliceGetActiveImage ()
vtkImageMapper3DGetMapper ()
vtkImagePropertyGetProperty ()
unsigned long int GetMTime ()
unsigned long GetRedrawMTime ()
void ShallowCopy (vtkProp *prop)
void GetImages (vtkPropCollection *)
virtual int HasTranslucentPolygonalGeometry ()
void ReleaseGraphicsResources (vtkWindow *win)
void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
virtual void SetActiveLayer (int)
int GetActiveLayer ()
doubleGetBounds ()
void GetBounds (double bounds[6])
virtual int RenderOverlay (vtkViewport *viewport)
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
void InitPathTraversal ()
vtkAssemblyPathGetNextPath ()
int GetNumberOfPaths ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkImageStackSafeDownCast (vtkObject *o)
static vtkImageStackNew ()

Protected Member Functions

 vtkImageStack ()
 ~vtkImageStack ()
void SetMapper (vtkImageMapper3D *mapper)
void SetProperty (vtkImageProperty *property)
void PokeMatrices (vtkMatrix4x4 *matrix)
void UpdatePaths ()

Protected Attributes

vtkTimeStamp PathTime
vtkCollectionImageMatrices
vtkImageSliceCollectionImages
int ActiveLayer

Detailed Description

manages a stack of composited images

vtkImageStack manages the compositing of a set of images. Each image is assigned a layer number through its property object, and it is this layer number that determines the compositing order: images with a higher layer number are drawn over top of images with a lower layer number. The image stack has a SetActiveLayer method for controlling which layer to use for interaction and picking.

Thanks:
Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.
See also:
vtkImageMapper3D vtkImageProperty vtkProp3D
Tests:
vtkImageStack (Tests)

Definition at line 44 of file vtkImageStack.h.


Member Typedef Documentation

Reimplemented from vtkImageSlice.

Definition at line 47 of file vtkImageStack.h.


Constructor & Destructor Documentation

vtkImageStack::vtkImageStack ( ) [protected]
vtkImageStack::~vtkImageStack ( ) [protected]

Member Function Documentation

virtual const char* vtkImageStack::GetClassName ( ) [virtual]

Reimplemented from vtkImageSlice.

static int vtkImageStack::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageSlice.

virtual int vtkImageStack::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageSlice.

static vtkImageStack* vtkImageStack::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkImageSlice.

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageSlice.

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

Creates an Image with the following defaults: origin(0,0,0) position=(0,0,0) scale=1 visibility=1 pickable=1 dragable=1 orientation=(0,0,0).

Reimplemented from vtkImageSlice.

void vtkImageStack::AddImage ( vtkImageSlice prop)

Add an image to the stack. If the image is already present, then this method will do nothing.

void vtkImageStack::RemoveImage ( vtkImageSlice prop)

Remove an image from the stack. If the image is not present, then this method will do nothing.

int vtkImageStack::HasImage ( vtkImageSlice prop)

Check if an image is present. The returned value is one or zero.

vtkImageSliceCollection* vtkImageStack::GetImages ( ) [inline]

Get the list of images as a vtkImageSliceCollection.

Definition at line 63 of file vtkImageStack.h.

virtual void vtkImageStack::SetActiveLayer ( int  ) [virtual]

Set the active layer number. This is the layer that will be used for picking and interaction.

int vtkImageStack::GetActiveLayer ( ) [inline]

Set the active layer number. This is the layer that will be used for picking and interaction.

Definition at line 69 of file vtkImageStack.h.

vtkImageSlice* vtkImageStack::GetActiveImage ( )

Get the active image. This will be the topmost image whose LayerNumber is the ActiveLayer. If no image matches, then NULL will be returned.

vtkImageMapper3D* vtkImageStack::GetMapper ( ) [virtual]

Get the mapper for the currently active image.

Reimplemented from vtkImageSlice.

vtkImageProperty* vtkImageStack::GetProperty ( ) [virtual]

Get the property for the currently active image.

Reimplemented from vtkImageSlice.

double* vtkImageStack::GetBounds ( ) [virtual]

Get the combined bounds of all of the images.

Reimplemented from vtkImageSlice.

void vtkImageStack::GetBounds ( double  bounds[6]) [inline]

Get the combined bounds of all of the images.

Reimplemented from vtkImageSlice.

Definition at line 86 of file vtkImageStack.h.

unsigned long int vtkImageStack::GetMTime ( ) [virtual]

Return the max MTime of all the images.

Reimplemented from vtkImageSlice.

unsigned long vtkImageStack::GetRedrawMTime ( ) [virtual]

Return the mtime of anything that would cause the rendered image to appear differently. Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, mappers, etc.

Reimplemented from vtkImageSlice.

void vtkImageStack::ShallowCopy ( vtkProp prop) [virtual]

Shallow copy of this prop. Overloads the virtual vtkProp method.

Reimplemented from vtkImageSlice.

void vtkImageStack::GetImages ( vtkPropCollection )

For some exporters and other other operations we must be able to collect all the actors, volumes, and images. These methods are used in that process.

Reimplemented from vtkImageSlice.

virtual int vtkImageStack::RenderOverlay ( vtkViewport viewport) [virtual]

Support the standard render methods.

Reimplemented from vtkImageSlice.

virtual int vtkImageStack::RenderOpaqueGeometry ( vtkViewport viewport) [virtual]

Support the standard render methods.

Reimplemented from vtkImageSlice.

virtual int vtkImageStack::RenderTranslucentPolygonalGeometry ( vtkViewport viewport) [virtual]

Support the standard render methods.

Reimplemented from vtkImageSlice.

virtual int vtkImageStack::HasTranslucentPolygonalGeometry ( ) [virtual]

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkImageSlice.

void vtkImageStack::ReleaseGraphicsResources ( vtkWindow win) [virtual]

Release any resources held by this prop.

Reimplemented from vtkImageSlice.

void vtkImageStack::InitPathTraversal ( ) [virtual]

Methods for traversing the stack as if it was an assembly. The traversal only gives the view prop for the active layer.

Reimplemented from vtkProp3D.

vtkAssemblyPath* vtkImageStack::GetNextPath ( ) [virtual]

Methods for traversing the stack as if it was an assembly. The traversal only gives the view prop for the active layer.

Reimplemented from vtkProp.

int vtkImageStack::GetNumberOfPaths ( ) [virtual]

Methods for traversing the stack as if it was an assembly. The traversal only gives the view prop for the active layer.

Reimplemented from vtkProp.

void vtkImageStack::BuildPaths ( vtkAssemblyPaths paths,
vtkAssemblyPath path 
) [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.

Reimplemented from vtkProp.

void vtkImageStack::SetMapper ( vtkImageMapper3D mapper) [protected]

Set/Get the mapper.

Reimplemented from vtkImageSlice.

void vtkImageStack::SetProperty ( vtkImageProperty property) [protected]

Set/Get the image display properties.

Reimplemented from vtkImageSlice.

void vtkImageStack::PokeMatrices ( vtkMatrix4x4 matrix) [protected]
void vtkImageStack::UpdatePaths ( ) [protected]

Member Data Documentation

Definition at line 142 of file vtkImageStack.h.

Definition at line 143 of file vtkImageStack.h.

Definition at line 144 of file vtkImageStack.h.

Definition at line 145 of file vtkImageStack.h.


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