vtkImageCanvasSource2D Class Reference

#include <vtkImageCanvasSource2D.h>

Inheritance diagram for vtkImageCanvasSource2D:

[legend]Collaboration diagram for vtkImageCanvasSource2D:

[legend]List of all members.

Detailed Description

Paints on a canvas.

vtkImageCanvasSource2D is a source that starts as a blank image. you may add to the image with two-dimensional drawing routines. It can paint multi-spectral images. This object is unusual because it is a data object itself and not a source.

Created by:

Law, Charles

CVS contributions (if > 5%):

Law, Charles (55%)
Martin, Ken (20%)
Barre, Sebastien (8%)
Lorensen, Bill (7%)
Cedilnik, Andy (6%)

CVS logs (CVSweb):

.h (/Imaging/vtkImageCanvasSource2D.h)
.cxx (/Imaging/vtkImageCanvasSource2D.cxx)

Examples:: vtkImageCanvasSource2D (Examples)

Tests:: vtkImageCanvasSource2D (Tests)

Definition at line 68 of file vtkImageCanvasSource2D.h.

Public Types

typedef vtkStructuredPoints Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void FillBox (int min0, int max0, int min1, int max1)

void FillTube (int x0, int y0, int x1, int y1, double radius)

void FillTriangle (int x0, int y0, int x1, int y1, int x2, int y2)

void DrawCircle (int c0, int c1, double radius)

void DrawPoint (int p0, int p1)

void DrawSegment (int x0, int y0, int x1, int y1)

void DrawSegment3D (double *p0, double *p1)

void DrawSegment3D (double x1, double y1, double z1, double x2, double y2, double z2)

void FillPixel (int x, int y)

vtkImageData * GetOutput ()

void SetImageData (vtkImageData *image)

virtual vtkImageData * GetImageData ()

virtual void SetDrawColor (double, double, double, double)

virtual void SetDrawColor (double[4])

virtual double * GetDrawColor ()

virtual void GetDrawColor (double &, double &, double &, double &)

virtual void GetDrawColor (double[4])

void SetDrawColor (double a)

void SetDrawColor (double a, double b)

void SetDrawColor (double a, double b, double c)

void DrawImage (int x0, int y0, vtkImageData *i)

void DrawImage (int x0, int y0, vtkImageData *, int sx, int sy, int width, int height)

void SetExtent (int *extent)

void SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)

virtual void SetDefaultZ (int)

virtual int GetDefaultZ ()

virtual void SetRatio (double, double, double)

virtual void SetRatio (double[3])

virtual double * GetRatio ()

virtual void GetRatio (double &, double &, double &)

virtual void GetRatio (double[3])

Static Public Member Functions

vtkImageCanvasSource2D * New ()

int IsTypeOf (const char *type)

vtkImageCanvasSource2D * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkImageCanvasSource2D ()

~vtkImageCanvasSource2D ()

int ClipSegment (int &a0, int &a1, int &b0, int &b1)

Protected Attributes

vtkImageData * ImageData

double DrawColor [4]

int DefaultZ

double Ratio [3]

Member Typedef Documentation

typedef vtkStructuredPoints vtkImageCanvasSource2D::Superclass

Reimplemented from vtkStructuredPoints.
Definition at line 74 of file vtkImageCanvasSource2D.h.

Constructor & Destructor Documentation

vtkImageCanvasSource2D::vtkImageCanvasSource2D ( ) [protected]

vtkImageCanvasSource2D::~vtkImageCanvasSource2D ( ) [protected]

Member Function Documentation

vtkImageCanvasSource2D* vtkImageCanvasSource2D::New ( ) [static]

Construct an instance of vtkImageCanvasSource2D with no data.
Reimplemented from vtkStructuredPoints.

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

Reimplemented from vtkStructuredPoints.

int vtkImageCanvasSource2D::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkStructuredPoints.

virtual int vtkImageCanvasSource2D::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkStructuredPoints.

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

Reimplemented from vtkStructuredPoints.

void vtkImageCanvasSource2D::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 vtkImageData.

void vtkImageCanvasSource2D::SetImageData ( vtkImageData * image )

To draw into a different image, set it with this method.

virtual vtkImageData* vtkImageCanvasSource2D::GetImageData ( ) [virtual]

To draw into a different image, set it with this method.

virtual void vtkImageCanvasSource2D::SetDrawColor ( double ,

double ,

double ,

double

) [virtual]

Set/Get DrawValue. This is the value that is used when filling data or drawing lines.

virtual void vtkImageCanvasSource2D::SetDrawColor ( double [4] ) [virtual]

Set/Get DrawValue. This is the value that is used when filling data or drawing lines.

virtual double* vtkImageCanvasSource2D::GetDrawColor ( ) [virtual]

Set/Get DrawValue. This is the value that is used when filling data or drawing lines.

virtual void vtkImageCanvasSource2D::GetDrawColor ( double & ,

double & ,

double & ,

double &

) [virtual]

Set/Get DrawValue. This is the value that is used when filling data or drawing lines.

virtual void vtkImageCanvasSource2D::GetDrawColor ( double [4] ) [virtual]

Set/Get DrawValue. This is the value that is used when filling data or drawing lines.

void vtkImageCanvasSource2D::SetDrawColor ( double a ) [inline]

Set/Get DrawValue. This is the value that is used when filling data or drawing lines.
Definition at line 88 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetDrawColor ( double a,

double b

) [inline]

Set/Get DrawValue. This is the value that is used when filling data or drawing lines.
Definition at line 89 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetDrawColor ( double a,

double b,

double c

) [inline]

Set/Get DrawValue. This is the value that is used when filling data or drawing lines.
Definition at line 90 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::FillBox ( int min0,

int max0,

int min1,

int max1

)

void vtkImageCanvasSource2D::FillTube ( int x0,

int y0,

int x1,

int y1,

double radius

)

void vtkImageCanvasSource2D::FillTriangle ( int x0,

int y0,

int x1,

int y1,

int x2,

int y2

)

void vtkImageCanvasSource2D::DrawCircle ( int c0,

int c1,

double radius

)

void vtkImageCanvasSource2D::DrawPoint ( int p0,

int p1

)

void vtkImageCanvasSource2D::DrawSegment ( int x0,

int y0,

int x1,

int y1

)

void vtkImageCanvasSource2D::DrawSegment3D ( double * p0,

double * p1

)

void vtkImageCanvasSource2D::DrawSegment3D ( double x1,

double y1,

double z1,

double x2,

double y2,

double z2

) [inline]

Definition at line 101 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::DrawImage ( int x0,

int y0,

vtkImageData * i

) [inline]

Draw subimage of the input image in the canvas at position x0 and y0. The subimage is defined with sx, sy, width, and height.
Definition at line 110 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::DrawImage ( int x0,

int y0,

vtkImageData * ,

int sx,

int sy,

int width,

int height

)

Draw subimage of the input image in the canvas at position x0 and y0. The subimage is defined with sx, sy, width, and height.

void vtkImageCanvasSource2D::FillPixel ( int x,

int y

)

Fill a colored area with another color. (like connectivity) All pixels connected (and with the same value) to pixel (x, y) get replaced by the current "DrawColor".

vtkImageData* vtkImageCanvasSource2D::GetOutput ( ) [inline]

To make Canvas source more like other sources, this get output method should be used.
Definition at line 123 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetExtent ( int * extent )

These methods also set the WholeExtent of this "DataObject". This is just like vtkImageData. It sets the size of the canvas. Extent is a min max 3D box. Minimums and maximums are inclusive.

void vtkImageCanvasSource2D::SetExtent ( int x1,

int x2,

int y1,

int y2,

int z1,

int z2

)

These methods also set the WholeExtent of this "DataObject". This is just like vtkImageData. It sets the size of the canvas. Extent is a min max 3D box. Minimums and maximums are inclusive.
Reimplemented from vtkImageData.

virtual void vtkImageCanvasSource2D::SetDefaultZ ( int ) [virtual]

The drawing operations can only draw into one 2D XY plane at a time. If the canvas is a 3D volume, then this z value is used as the default for 2D operations.

virtual int vtkImageCanvasSource2D::GetDefaultZ ( ) [virtual]

The drawing operations can only draw into one 2D XY plane at a time. If the canvas is a 3D volume, then this z value is used as the default for 2D operations.

virtual void vtkImageCanvasSource2D::SetRatio ( double ,

double ,

double

) [virtual]

Set/Get Ratio. This is the value that is used to pre-multiply each (x, y, z) drawing coordinates (including DefaultZ).

virtual void vtkImageCanvasSource2D::SetRatio ( double [3] ) [virtual]

Set/Get Ratio. This is the value that is used to pre-multiply each (x, y, z) drawing coordinates (including DefaultZ).

virtual double* vtkImageCanvasSource2D::GetRatio ( ) [virtual]

Set/Get Ratio. This is the value that is used to pre-multiply each (x, y, z) drawing coordinates (including DefaultZ).

virtual void vtkImageCanvasSource2D::GetRatio ( double & ,

double & ,

double &

) [virtual]

Set/Get Ratio. This is the value that is used to pre-multiply each (x, y, z) drawing coordinates (including DefaultZ).

virtual void vtkImageCanvasSource2D::GetRatio ( double [3] ) [virtual]

Set/Get Ratio. This is the value that is used to pre-multiply each (x, y, z) drawing coordinates (including DefaultZ).

int vtkImageCanvasSource2D::ClipSegment ( int & a0,

int & a1,

int & b0,

int & b1

) [protected]

Member Data Documentation

vtkImageData* vtkImageCanvasSource2D::ImageData [protected]

Definition at line 155 of file vtkImageCanvasSource2D.h.

double vtkImageCanvasSource2D::DrawColor[4] [protected]

Definition at line 156 of file vtkImageCanvasSource2D.h.

int vtkImageCanvasSource2D::DefaultZ [protected]

Definition at line 157 of file vtkImageCanvasSource2D.h.

double vtkImageCanvasSource2D::Ratio[3] [protected]

Definition at line 158 of file vtkImageCanvasSource2D.h.

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

dox/Imaging/vtkImageCanvasSource2D.h


Public Types
typedef vtkStructuredPoints	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	FillBox (int min0, int max0, int min1, int max1)
void	FillTube (int x0, int y0, int x1, int y1, double radius)
void	FillTriangle (int x0, int y0, int x1, int y1, int x2, int y2)
void	DrawCircle (int c0, int c1, double radius)
void	DrawPoint (int p0, int p1)
void	DrawSegment (int x0, int y0, int x1, int y1)
void	DrawSegment3D (double p0, double p1)
void	DrawSegment3D (double x1, double y1, double z1, double x2, double y2, double z2)
void	FillPixel (int x, int y)
vtkImageData *	GetOutput ()

void	SetImageData (vtkImageData *image)
virtual vtkImageData *	GetImageData ()

virtual void	SetDrawColor (double, double, double, double)
virtual void	SetDrawColor (double[4])
virtual double *	GetDrawColor ()
virtual void	GetDrawColor (double &, double &, double &, double &)
virtual void	GetDrawColor (double[4])
void	SetDrawColor (double a)
void	SetDrawColor (double a, double b)
void	SetDrawColor (double a, double b, double c)

void	DrawImage (int x0, int y0, vtkImageData *i)
void	DrawImage (int x0, int y0, vtkImageData *, int sx, int sy, int width, int height)

void	SetExtent (int *extent)
void	SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)

virtual void	SetDefaultZ (int)
virtual int	GetDefaultZ ()

virtual void	SetRatio (double, double, double)
virtual void	SetRatio (double[3])
virtual double *	GetRatio ()
virtual void	GetRatio (double &, double &, double &)
virtual void	GetRatio (double[3])
Static Public Member Functions
vtkImageCanvasSource2D *	New ()
int	IsTypeOf (const char *type)
vtkImageCanvasSource2D *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageCanvasSource2D ()
	~vtkImageCanvasSource2D ()
int	ClipSegment (int &a0, int &a1, int &b0, int &b1)
Protected Attributes
vtkImageData *	ImageData
double	DrawColor [4]
int	DefaultZ
double	Ratio [3]