Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

vtkXImageWindow Class Reference

2D display window for X. More...

#include <vtkXImageWindow.h>

Inheritance diagram for vtkXImageWindow:

[legend]Collaboration diagram for vtkXImageWindow:

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetWindowName (char *name)
void	SwapBuffers ()
void	Frame ()
virtual int	GetDesiredDepth ()
virtual Colormap	GetDesiredColormap ()
virtual Visual *	GetDesiredVisual ()
Visual *	GetVisualId ()
void	SetBackgroundColor (float r, float g, float b)
void	EraseWindow ()
unsigned char *	GetPixelData (int x1, int y1, int x2, int y2, int)
void	SetWindowInfo (char *info)
void	SetParentInfo (char *info)

virtual int	GetNumberOfColors ()

virtual int	GetVisualDepth ()

virtual int	GetVisualClass ()

Window	GetParentId ()
void	SetParentId (Window)
void	SetParentId (void *)
void	SetDisplayId (Display *)
void	SetDisplayId (void *)
void	SetWindowId (Window)
void	SetWindowId (void *)
Window	GetWindowId ()
Display *	GetDisplayId ()
GC	GetGC ()

int *	GetPosition ()
void	GetPosition (int x, int y)
void	SetPosition (int, int)
void	SetPosition (int a[2])

int *	GetSize ()
void	GetSize (int x, int y)
void	SetSize (int x, int y)
void	SetSize (int a[2])

void *	GetGenericDisplayId ()
void *	GetGenericWindowId ()
void *	GetGenericParentId ()
void *	GetGenericContext ()
void *	GetGenericDrawable ()
Static Public Methods
vtkXImageWindow *	New ()
int	IsTypeOf (const char *type)
vtkXImageWindow *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkXImageWindow ()
	~vtkXImageWindow ()
void	MakeDefaultWindow ()
void	GetDefaultVisualInfo (XVisualInfo *info)
Colormap	MakeColorMap (Visual *visual)
void	AllocateDirectColorMap ()
void	GetShiftsScalesAndMasks (int &rshift, int &gshift, int &bshift, int &rscale, int &gscale, int &bscale, unsigned long &rmask, unsigned long &gmask, unsigned long &bmask)
Protected Attributes
Window	ParentId
Window	WindowId
Display *	DisplayId
Visual *	VisualId
int	VisualDepth
int	VisualClass
Colormap	ColorMap
GC	Gc
int	Offset
XColor	Colors [256]
int	NumberOfColors
Pixmap	Drawable
int	OwnDisplay
int	PixmapWidth
int	PixmapHeight

Detailed Description

2D display window for X.

Date:: 2001/11/13 14:17:36

Revision:: 1.27

Thanks:: Thanks to Matt Turek who developed this class.

vtkXImageWindow is a concrete subclass of vtkImageWindow to support 2D rendering in vtk.

See also:: vtkImageWindow

Definition at line 65 of file vtkXImageWindow.h.

Constructor & Destructor Documentation

vtkXImageWindow::vtkXImageWindow ( ) [protected]

vtkXImageWindow::~vtkXImageWindow ( ) [protected]

Member Function Documentation

vtkXImageWindow* vtkXImageWindow::New ( ) [static]

Creates a vtkImageWindow with background erasing disabled and gray scale hint off
Reimplemented from vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

virtual const char* vtkXImageWindow::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 vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

int vtkXImageWindow::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 vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

virtual int vtkXImageWindow::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 vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

vtkXImageWindow* vtkXImageWindow::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 vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

void vtkXImageWindow::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 vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

void vtkXImageWindow::SetWindowName ( char * name ) [virtual]

Implements SetWindowName for a X window
Reimplemented from vtkWindow.

virtual int vtkXImageWindow::GetNumberOfColors ( ) [virtual]

Gets the number of colors in the pseudo color map.

virtual int vtkXImageWindow::GetVisualDepth ( ) [virtual]

Gets the windows depth. For the templated function.

virtual int vtkXImageWindow::GetVisualClass ( ) [virtual]

Gets the windows visual class. For the templated function.

Window vtkXImageWindow::GetParentId ( )

These are here for using a tk window.

void vtkXImageWindow::SetParentId ( Window )

These are here for using a tk window.

void vtkXImageWindow::SetParentId ( void * foo ) [virtual]

These are here for using a tk window.
Reimplemented from vtkImageWindow.

void vtkXImageWindow::SetDisplayId ( Display * )

These are here for using a tk window.

void vtkXImageWindow::SetDisplayId ( void * foo ) [virtual]

These are here for using a tk window.
Reimplemented from vtkImageWindow.

void vtkXImageWindow::SetWindowId ( Window )

These are here for using a tk window.

void vtkXImageWindow::SetWindowId ( void * foo ) [virtual]

These are here for using a tk window.
Reimplemented from vtkImageWindow.

Window vtkXImageWindow::GetWindowId ( )

These are here for using a tk window.

Display* vtkXImageWindow::GetDisplayId ( )

These are here for using a tk window.

GC vtkXImageWindow::GetGC ( )

These are here for using a tk window.

int* vtkXImageWindow::GetPosition ( ) [virtual]

Set/Get the position of the window.
Reimplemented from vtkImageWindow.

void vtkXImageWindow::GetPosition ( int * x,

int * y

) [inline, virtual]

Set/Get the position of the window.
Reimplemented from vtkImageWindow.
Definition at line 107 of file vtkXImageWindow.h.

void vtkXImageWindow::SetPosition ( int x,

int y

) [virtual]

Set/Get the position of the window.
Reimplemented from vtkImageWindow.

void vtkXImageWindow::SetPosition ( int a[2] ) [inline, virtual]

Set/Get the position of the window.
Reimplemented from vtkImageWindow.
Definition at line 109 of file vtkXImageWindow.h.

int* vtkXImageWindow::GetSize ( ) [virtual]

Set/Get the size of the window.
Reimplemented from vtkImageWindow.

void vtkXImageWindow::GetSize ( int * x,

int * y

) [inline, virtual]

Set/Get the size of the window.
Reimplemented from vtkImageWindow.
Definition at line 115 of file vtkXImageWindow.h.

void vtkXImageWindow::SetSize ( int x,

int y

) [virtual]

Set/Get the size of the window.
Reimplemented from vtkImageWindow.

void vtkXImageWindow::SetSize ( int a[2] ) [inline, virtual]

Set/Get the size of the window.
Reimplemented from vtkImageWindow.
Definition at line 117 of file vtkXImageWindow.h.

void* vtkXImageWindow::GetGenericDisplayId ( ) [inline, virtual]

The GetGenericXXX functions are necessary to draw into a VTKWindow.
Reimplemented from vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.
Definition at line 122 of file vtkXImageWindow.h.

void* vtkXImageWindow::GetGenericWindowId ( ) [inline, virtual]

The GetGenericXXX functions are necessary to draw into a VTKWindow.
Reimplemented from vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.
Definition at line 123 of file vtkXImageWindow.h.

void* vtkXImageWindow::GetGenericParentId ( ) [inline, virtual]

The GetGenericXXX functions are necessary to draw into a VTKWindow.
Reimplemented from vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.
Definition at line 124 of file vtkXImageWindow.h.

void* vtkXImageWindow::GetGenericContext ( ) [inline, virtual]

The GetGenericXXX functions are necessary to draw into a VTKWindow.
Reimplemented from vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.
Definition at line 125 of file vtkXImageWindow.h.

void* vtkXImageWindow::GetGenericDrawable ( ) [virtual]

The GetGenericXXX functions are necessary to draw into a VTKWindow.
Reimplemented from vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

void vtkXImageWindow::SwapBuffers ( ) [virtual]

Swaps the 2D drawing buffers. The user should not need to use this call. To invoke double buffering, call DoubleBufferOn
Reimplemented from vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

void vtkXImageWindow::Frame ( void ) [virtual]

Flush the buffer and swap buffers if necessary.
Reimplemented from vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

virtual int vtkXImageWindow::GetDesiredDepth ( ) [virtual]

Determine the desired depth of the window.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

virtual Colormap vtkXImageWindow::GetDesiredColormap ( ) [virtual]

Determine the desired colormap of the window.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

virtual Visual* vtkXImageWindow::GetDesiredVisual ( ) [virtual]

Determine the desired visual for the window
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

Visual* vtkXImageWindow::GetVisualId ( ) [inline]

Return the id of the visual we are using
Definition at line 146 of file vtkXImageWindow.h.

void vtkXImageWindow::SetBackgroundColor ( float r,

float g,

float b

)

Set the background color of the window.

void vtkXImageWindow::EraseWindow ( ) [virtual]

Erase the contents of the window.
Reimplemented from vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

unsigned char* vtkXImageWindow::GetPixelData ( int x,

int y,

int x2,

int y2,

int front

) [virtual]

Get the pixel data of an image, transmitted as RGBRGBRGB. It is the caller's responsibility to delete the resulting array. It is very important to realize that the memory in this array is organized from the bottom of the window to the top. The origin of the screen is in the lower left corner. The y axis increases as you go up the screen. So the storage of pixels is from left to right and from bottom to top. To maintain the same prototype as in vtkRenderWindow, the last argument is provided, but currently not used.
Reimplemented from vtkWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

void vtkXImageWindow::SetWindowInfo ( char * info ) [virtual]

Set this ImageWindow's X window id to a pre-existing window.
Reimplemented from vtkImageWindow.

void vtkXImageWindow::SetParentInfo ( char * info ) [virtual]

Sets the X window id of the window that WILL BE created.
Reimplemented from vtkImageWindow.

void vtkXImageWindow::MakeDefaultWindow ( ) [protected, virtual]

Reimplemented from vtkImageWindow.
Reimplemented in vtkMesaImageWindow, and vtkOpenGLImageWindow.

void vtkXImageWindow::GetDefaultVisualInfo ( XVisualInfo * info ) [protected]

Colormap vtkXImageWindow::MakeColorMap ( Visual * visual ) [protected]

void vtkXImageWindow::AllocateDirectColorMap ( ) [protected]

void vtkXImageWindow::GetShiftsScalesAndMasks ( int & rshift,

int & gshift,

int & bshift,

int & rscale,

int & gscale,

int & bscale,

unsigned long & rmask,

unsigned long & gmask,

unsigned long & bmask

) [protected]

Member Data Documentation

Window vtkXImageWindow::ParentId [protected]

Definition at line 175 of file vtkXImageWindow.h.

Window vtkXImageWindow::WindowId [protected]

Definition at line 176 of file vtkXImageWindow.h.

Display* vtkXImageWindow::DisplayId [protected]

Definition at line 177 of file vtkXImageWindow.h.

Visual* vtkXImageWindow::VisualId [protected]

Definition at line 178 of file vtkXImageWindow.h.

int vtkXImageWindow::VisualDepth [protected]

Definition at line 179 of file vtkXImageWindow.h.

int vtkXImageWindow::VisualClass [protected]

Definition at line 180 of file vtkXImageWindow.h.

Colormap vtkXImageWindow::ColorMap [protected]

Definition at line 181 of file vtkXImageWindow.h.

GC vtkXImageWindow::Gc [protected]

Definition at line 182 of file vtkXImageWindow.h.

int vtkXImageWindow::Offset [protected]

Definition at line 183 of file vtkXImageWindow.h.

XColor vtkXImageWindow::Colors[256] [protected]

Definition at line 184 of file vtkXImageWindow.h.

int vtkXImageWindow::NumberOfColors [protected]

Definition at line 185 of file vtkXImageWindow.h.

Pixmap vtkXImageWindow::Drawable [protected]

Definition at line 186 of file vtkXImageWindow.h.

int vtkXImageWindow::OwnDisplay [protected]

Definition at line 187 of file vtkXImageWindow.h.

int vtkXImageWindow::PixmapWidth [protected]

Definition at line 188 of file vtkXImageWindow.h.

int vtkXImageWindow::PixmapHeight [protected]

Definition at line 189 of file vtkXImageWindow.h.

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

Rendering/vtkXImageWindow.h

Generated on Thu Mar 28 14:48:35 2002 for VTK by

vtkXImageWindow Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation