---

vtkImager Class Reference

Renders into part of a ImageWindow. More...

#include <vtkImager.h>

Inheritance diagram for vtkImager:

[legend]Collaboration diagram for vtkImager:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual vtkAssemblyPath *	PickProp (float selectionX, float selectionY)
virtual float	GetPickedZ ()
virtual int	RenderOpaqueGeometry ()
virtual int	RenderTranslucentGeometry ()
virtual int	RenderOverlay ()
vtkImageWindow *	GetImageWindow ()
vtkWindow *	GetVTKWindow ()
void	SetImageWindow (vtkImageWindow *win)
void	SetVTKWindow (vtkWindow *win)
virtual void	Erase ()
Static Public Methods
vtkImager *	New ()
int	IsTypeOf (const char *type)
vtkImager *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImager ()
	~vtkImager ()
virtual void	StartPick (unsigned int pickFromSize)
virtual void	UpdatePickId ()
virtual void	DonePick ()
virtual unsigned int	GetPickedId ()
virtual void	DevicePickRender ()

---

Detailed Description

Renders into part of a ImageWindow.

Date:

2001/10/11 13:38:10

Revision:

1.22

Thanks:

Thanks to Matt Turek who developed this class.

vtkImager is the 2D counterpart to vtkRenderer. An Imager renders 2D actors into a viewport of an image window.

See also:

vtkImageWindow vtkViewport

Events:

vtkCommand::StartEvent vtkCommand::EndEvent

Tests:

vtkImager (Tests)

Definition at line 71 of file vtkImager.h.

---

Constructor & Destructor Documentation

vtkImager::vtkImager (    )  [protected]

vtkImager::~vtkImager (    )  [protected]

---

Member Function Documentation

vtkImager* vtkImager::New (    )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkObject. Reimplemented in vtkMesaImager, and vtkOpenGLImager.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkViewport. Reimplemented in vtkMesaImager, and vtkOpenGLImager.

int vtkImager::IsTypeOf (  const char *    type )  [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 vtkViewport. Reimplemented in vtkMesaImager, and vtkOpenGLImager.

virtual int vtkImager::IsA (  const char *    type )  [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 vtkViewport. Reimplemented in vtkMesaImager, and vtkOpenGLImager.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkViewport. Reimplemented in vtkMesaImager, and vtkOpenGLImager.

virtual int vtkImager::RenderOpaqueGeometry (    )  [virtual]

Renders an imager. Passes Render message on the the imager's actor2D collection. Reimplemented in vtkMesaImager, and vtkOpenGLImager.

virtual int vtkImager::RenderTranslucentGeometry (    )  [virtual]

Renders an imager. Passes Render message on the the imager's actor2D collection.

virtual int vtkImager::RenderOverlay (    )  [virtual]

Renders an imager. Passes Render message on the the imager's actor2D collection.

vtkImageWindow* vtkImager::GetImageWindow (    )

Get the image window that an imager is attached to.

vtkWindow* vtkImager::GetVTKWindow (    )  [inline, virtual]

Get the image window that an imager is attached to. Reimplemented from vtkViewport. Definition at line 88 of file vtkImager.h.

void vtkImager::SetImageWindow (  vtkImageWindow *    win )

These set methods are used by the image window, and should not be used by anyone else. They do not reference count the window.

void vtkImager::SetVTKWindow (  vtkWindow *    win )

These set methods are used by the image window, and should not be used by anyone else. They do not reference count the window.

virtual void vtkImager::Erase (    )  [inline, virtual]

Erase the contents of the imager in the window. Reimplemented in vtkMesaImager, and vtkOpenGLImager. Definition at line 103 of file vtkImager.h.

virtual vtkAssemblyPath* vtkImager::PickProp (  float    selectionX, float    selectionY )  [virtual]

Return the Prop that has the highest z value at the given x, y position in the viewport. Basically, the top most prop that renders the pixel at selectionX, selectionY will be returned. If no Props are there NULL is returned. This method selects from the Viewports Prop list. Reimplemented from vtkViewport.

virtual float vtkImager::GetPickedZ (    )  [virtual]

Return the Z value for the last picked Prop. Reimplemented from vtkViewport.

virtual void vtkImager::StartPick (  unsigned int    pickFromSize )  [protected, virtual]

Reimplemented from vtkViewport.

virtual void vtkImager::UpdatePickId (    )  [protected, virtual]

Reimplemented from vtkViewport.

virtual void vtkImager::DonePick (    )  [protected, virtual]

Reimplemented from vtkViewport.

virtual unsigned int vtkImager::GetPickedId (    )  [protected, virtual]

Reimplemented from vtkViewport.

virtual void vtkImager::DevicePickRender (    )  [protected, virtual]

Reimplemented from vtkViewport.

---

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

• Rendering/vtkImager.h

---