vtkImageCanvasSource2D Class Reference

Paints on a canvas. More...

#include <vtkImageCanvasSource2D.h>

Inheritance diagram for vtkImageCanvasSource2D:

Collaboration diagram for vtkImageCanvasSource2D:

List of all members.

Public Types
typedef vtkImageAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkImageCanvasSource2D *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetDrawColor (double a)
void	SetDrawColor (double a, double b)
void	FillPixel (int x, int y)
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, double b, double c)
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	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])
virtual void	SetNumberOfScalarComponents (int i)
virtual int	GetNumberOfScalarComponents () const
void	SetScalarTypeToFloat ()
void	SetScalarTypeToDouble ()
void	SetScalarTypeToInt ()
void	SetScalarTypeToUnsignedInt ()
void	SetScalarTypeToLong ()
void	SetScalarTypeToUnsignedLong ()
void	SetScalarTypeToShort ()
void	SetScalarTypeToUnsignedShort ()
void	SetScalarTypeToUnsignedChar ()
void	SetScalarTypeToChar ()
void	SetScalarType (int)
int	GetScalarType () const
Static Public Member Functions
static vtkImageCanvasSource2D *	New ()
static int	IsTypeOf (const char *type)
static vtkImageCanvasSource2D *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageCanvasSource2D ()
	~vtkImageCanvasSource2D ()
int	ClipSegment (int &a0, int &a1, int &b0, int &b1)
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Attributes
vtkImageData *	ImageData
int	WholeExtent [6]
double	DrawColor [4]
int	DefaultZ
double	Ratio [3]

---

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.

Examples:

vtkImageCanvasSource2D (Examples)

Tests:

vtkImageCanvasSource2D (Tests)

Definition at line 35 of file vtkImageCanvasSource2D.h.

---

Member Typedef Documentation

typedef vtkImageAlgorithm vtkImageCanvasSource2D::Superclass

Reimplemented from vtkImageAlgorithm.

Definition at line 41 of file vtkImageCanvasSource2D.h.

---

Constructor & Destructor Documentation

vtkImageCanvasSource2D::vtkImageCanvasSource2D

(

)

[protected]

vtkImageCanvasSource2D::~vtkImageCanvasSource2D

(

)

[protected]

---

Member Function Documentation

static vtkImageCanvasSource2D* vtkImageCanvasSource2D::New

(

)

[static]

Construct an instance of vtkImageCanvasSource2D with no data.

Reimplemented from vtkAlgorithm.

static int vtkImageCanvasSource2D::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 vtkImageAlgorithm.

virtual int vtkImageCanvasSource2D::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 vtkImageAlgorithm.

static vtkImageCanvasSource2D* vtkImageCanvasSource2D::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkImageAlgorithm.

virtual vtkObjectBase* vtkImageCanvasSource2D::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkImageAlgorithm.

vtkImageCanvasSource2D* vtkImageCanvasSource2D::NewInstance

(

)

const

Reimplemented from vtkImageAlgorithm.

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 vtkImageAlgorithm.

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

Set/Get DrawColor. This is the value that is used when filling data or drawing lines. Default is (0,0,0,0)

virtual void vtkImageCanvasSource2D::SetDrawColor

(

double

[4]

)

[virtual]

Set/Get DrawColor. This is the value that is used when filling data or drawing lines. Default is (0,0,0,0)

virtual double* vtkImageCanvasSource2D::GetDrawColor

(

)

[virtual]

Set/Get DrawColor. This is the value that is used when filling data or drawing lines. Default is (0,0,0,0)

virtual void vtkImageCanvasSource2D::GetDrawColor	(	double &	,
		double &	,
		double &	,
		double &
	)		[virtual]

Set/Get DrawColor. This is the value that is used when filling data or drawing lines. Default is (0,0,0,0)

virtual void vtkImageCanvasSource2D::GetDrawColor

(

double

[4]

)

[virtual]

Set/Get DrawColor. This is the value that is used when filling data or drawing lines. Default is (0,0,0,0)

void vtkImageCanvasSource2D::SetDrawColor

(

double

a

)

[inline]

Set DrawColor to (a, 0, 0, 0)

Definition at line 52 of file vtkImageCanvasSource2D.h.

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

Set DrawColor to (a, b, 0, 0)

Definition at line 55 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetDrawColor	(	double	a,
		double	b,
		double	c
	)		[inline]

Set DrawColor to (a, b, c, 0)

Definition at line 59 of file vtkImageCanvasSource2D.h.

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

Set the pixels inside the box (min0, max0, min1, max1) to the current DrawColor

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

Set the pixels inside the box (min0, max0, min1, max1) to the current DrawColor

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

Set the pixels inside the box (min0, max0, min1, max1) to the current DrawColor

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

Set the pixels inside the box (min0, max0, min1, max1) to the current DrawColor

void vtkImageCanvasSource2D::DrawPoint	(	int	p0,
		int	p1
	)

Set the pixels inside the box (min0, max0, min1, max1) to the current DrawColor

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

Set the pixels inside the box (min0, max0, min1, max1) to the current DrawColor

void vtkImageCanvasSource2D::DrawSegment3D	(	double *	p0,
		double *	p1
	)

Set the pixels inside the box (min0, max0, min1, max1) to the current DrawColor

void vtkImageCanvasSource2D::DrawSegment3D	(	double	x1,
		double	y1,
		double	z1,
		double	x2,
		double	y2,
		double	z2
	)		[inline]

Set the pixels inside the box (min0, max0, min1, max1) to the current DrawColor

Definition at line 73 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 83 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".

void vtkImageCanvasSource2D::SetExtent

(

int *

extent

)

These methods set the WholeExtent of the output 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 set the WholeExtent of the output It sets the size of the canvas. Extent is a min max 3D box. Minimums and maximums are inclusive.

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. The default is 0.

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. The default is 0.

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). The default is (1, 1, 1)

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). The default is (1, 1, 1)

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). The default is (1, 1, 1)

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). The default is (1, 1, 1)

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). The default is (1, 1, 1)

virtual void vtkImageCanvasSource2D::SetNumberOfScalarComponents

(

int

i

)

[virtual]

Set the number of scalar components

virtual int vtkImageCanvasSource2D::GetNumberOfScalarComponents

(

)

const [virtual]

Set the number of scalar components

void vtkImageCanvasSource2D::SetScalarTypeToFloat

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 130 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetScalarTypeToDouble

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 131 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetScalarTypeToInt

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 132 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetScalarTypeToUnsignedInt

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 133 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetScalarTypeToLong

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 135 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetScalarTypeToUnsignedLong

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 136 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetScalarTypeToShort

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 138 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetScalarTypeToUnsignedShort

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 139 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetScalarTypeToUnsignedChar

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 141 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetScalarTypeToChar

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 143 of file vtkImageCanvasSource2D.h.

void vtkImageCanvasSource2D::SetScalarType

(

int

)

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

int vtkImageCanvasSource2D::GetScalarType

(

)

const

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

int vtkImageCanvasSource2D::ClipSegment	(	int &	a0,
		int &	a1,
		int &	b0,
		int &	b1
	)		[protected]

virtual int vtkImageCanvasSource2D::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		[protected, virtual]

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

virtual int vtkImageCanvasSource2D::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		[protected, virtual]

This is called in response to a REQUEST_DATA request from the executive. Subclasses should override either this method or the ExecuteDataWithInformation method in order to generate data for their outputs. For images, the output arrays will already be allocated, so all that is necessary is to fill in the voxel values.

Reimplemented from vtkImageAlgorithm.

---

Member Data Documentation

vtkImageData* vtkImageCanvasSource2D::ImageData [protected]

Definition at line 156 of file vtkImageCanvasSource2D.h.

int vtkImageCanvasSource2D::WholeExtent[6] [protected]

Definition at line 157 of file vtkImageCanvasSource2D.h.

double vtkImageCanvasSource2D::DrawColor[4] [protected]

Definition at line 158 of file vtkImageCanvasSource2D.h.

int vtkImageCanvasSource2D::DefaultZ [protected]

Definition at line 159 of file vtkImageCanvasSource2D.h.

double vtkImageCanvasSource2D::Ratio[3] [protected]

Definition at line 160 of file vtkImageCanvasSource2D.h.

---

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

• dox/Imaging/Sources/vtkImageCanvasSource2D.h