Class for drawing 2D primitives to a graphical context. More...

#include <vtkContext2D.h>

Inheritance diagram for vtkContext2D:

Collaboration diagram for vtkContext2D:

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkContext2D *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
bool	Begin (vtkContextDevice2D *device)
virtual vtkContextDevice2D *	GetDevice ()
bool	End ()
bool	GetBufferIdMode () const
void	BufferIdModeBegin (vtkAbstractContextBufferId *bufferId)
void	BufferIdModeEnd ()
void	DrawLine (float x1, float y1, float x2, float y2)
void	DrawLine (float p[4])
void	DrawLine (vtkPoints2D *points)
void	DrawPoly (float x, float y, int n)
void	DrawPoly (vtkPoints2D *points)
void	DrawPoly (float *points, int n)
void	DrawPoint (float x, float y)
void	DrawPoints (float x, float y, int n)
void	DrawPoints (vtkPoints2D *points)
void	DrawPoints (float *points, int n)
void	DrawPointSprites (vtkImageData sprite, vtkPoints2D points)
void	DrawPointSprites (vtkImageData sprite, float points, int n)
void	DrawRect (float x, float y, float w, float h)
void	DrawPolygon (float x, float y, int n)
void	DrawPolygon (vtkPoints2D *points)
void	DrawPolygon (float *points, int n)
void	DrawEllipse (float x, float y, float rx, float ry)
void	DrawImage (float x, float y, vtkImageData *image)
void	DrawImage (float x, float y, float scale, vtkImageData *image)
void	DrawImage (const vtkRectf &pos, vtkImageData *image)
bool	MathTextIsSupported ()
void	ApplyPen (vtkPen *pen)
vtkPen *	GetPen ()
void	ApplyBrush (vtkBrush *brush)
vtkBrush *	GetBrush ()
void	ApplyTextProp (vtkTextProperty *prop)
vtkTextProperty *	GetTextProp ()
void	SetTransform (vtkTransform2D *transform)
vtkTransform2D *	GetTransform ()
void	AppendTransform (vtkTransform2D *transform)
void	ApplyId (vtkIdType id)

void	DrawPoly (float points, int n, unsigned char colors, int nc_comps)

void	DrawPointSprites (vtkImageData sprite, vtkPoints2D points, vtkUnsignedCharArray *colors)
void	DrawPointSprites (vtkImageData sprite, float points, int n, unsigned char *colors, int nc_comps)

virtual void	DrawMarkers (int shape, bool highlight, float points, int n, unsigned char colors, int nc_comps)
virtual void	DrawMarkers (int shape, bool highlight, float *points, int n)
virtual void	DrawMarkers (int shape, bool highlight, vtkPoints2D *points)
virtual void	DrawMarkers (int shape, bool highlight, vtkPoints2D points, vtkUnsignedCharArray colors)

void	DrawQuad (float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4)
void	DrawQuad (float *p)

void	DrawQuadStrip (vtkPoints2D *points)
void	DrawQuadStrip (float *p, int n)

void	DrawWedge (float x, float y, float outRadius, float inRadius, float startAngle, float stopAngle)

void	DrawEllipseWedge (float x, float y, float outRx, float outRy, float inRx, float inRy, float startAngle, float stopAngle)

void	DrawArc (float x, float y, float r, float startAngle, float stopAngle)

void	DrawEllipticArc (float x, float y, float rX, float rY, float startAngle, float stopAngle)

void	DrawStringRect (vtkPoints2D *rect, const vtkStdString &string)
void	DrawStringRect (vtkPoints2D *rect, const vtkUnicodeString &string)
void	DrawStringRect (vtkPoints2D rect, const char string)

void	DrawString (vtkPoints2D *point, const vtkStdString &string)
void	DrawString (float x, float y, const vtkStdString &string)
void	DrawString (vtkPoints2D *point, const vtkUnicodeString &string)
void	DrawString (float x, float y, const vtkUnicodeString &string)
void	DrawString (vtkPoints2D point, const char string)
void	DrawString (float x, float y, const char *string)

void	ComputeStringBounds (const vtkStdString &string, vtkPoints2D *bounds)
void	ComputeStringBounds (const vtkStdString &string, float bounds[4])
void	ComputeStringBounds (const vtkUnicodeString &string, vtkPoints2D *bounds)
void	ComputeStringBounds (const vtkUnicodeString &string, float bounds[4])
void	ComputeStringBounds (const char string, vtkPoints2D bounds)
void	ComputeStringBounds (const char *string, float bounds[4])

void	DrawMathTextString (vtkPoints2D *point, const vtkStdString &string)
void	DrawMathTextString (float x, float y, const vtkStdString &string)
void	DrawMathTextString (vtkPoints2D point, const char string)
void	DrawMathTextString (float x, float y, const char *string)

void	DrawMathTextString (vtkPoints2D *point, const vtkStdString &string, const vtkStdString &fallback)
void	DrawMathTextString (float x, float y, const vtkStdString &string, const vtkStdString &fallback)
void	DrawMathTextString (vtkPoints2D point, const char string, const char *fallback)
void	DrawMathTextString (float x, float y, const char string, const char fallback)

void	PushMatrix ()
void	PopMatrix ()

virtual vtkContext3D *	GetContext3D ()
virtual void	SetContext3D (vtkContext3D *context)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkContext2D *	SafeDownCast (vtkObjectBase *o)
static vtkContext2D *	New ()
static int	FloatToInt (float x)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkContext2D ()
	~vtkContext2D ()
Protected Attributes
vtkContextDevice2D *	Device
vtkTransform2D *	Transform
vtkAbstractContextBufferId *	BufferId
vtkContext3D *	Context3D

Detailed Description

Class for drawing 2D primitives to a graphical context.

This defines the interface for drawing onto a 2D context. The context must be set up with a vtkContextDevice2D derived class that provides the functions to facilitate the low level calls to the context. Currently only an OpenGL based device is provided, but this could be extended in the future.

Examples:: vtkContext2D (Examples)

Tests:: vtkContext2D (Tests)

Definition at line 56 of file vtkContext2D.h.

Member Typedef Documentation

typedef vtkObject vtkContext2D::Superclass

Reimplemented from vtkObject.

Definition at line 59 of file vtkContext2D.h.

Constructor & Destructor Documentation

vtkContext2D::vtkContext2D ( ) [protected]

vtkContext2D::~vtkContext2D ( ) [protected]

Member Function Documentation

static int vtkContext2D::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 vtkObject.

virtual int vtkContext2D::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 vtkObject.

static vtkContext2D* vtkContext2D::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkContext2D::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkContext2D* vtkContext2D::NewInstance ( ) const

Reimplemented from vtkObject.

virtual void vtkContext2D::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 vtkObject.

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

Creates a 2D Painter object.

Reimplemented from vtkObject.

bool vtkContext2D::Begin ( vtkContextDevice2D * device )

Begin painting on a vtkContextDevice2D, no painting can occur before this call has been made. Only one painter is allowed at a time on any given paint device. Returns true if successful, otherwise false.

virtual vtkContextDevice2D* vtkContext2D::GetDevice ( ) [virtual]

bool vtkContext2D::End ( )

Ends painting on the device, you would not usually need to call this as it should be called by the destructor. Returns true if the painter is no longer active, otherwise false.

bool vtkContext2D::GetBufferIdMode ( ) const

Tell if the context is in BufferId creation mode. Initial value is false.

void vtkContext2D::BufferIdModeBegin ( vtkAbstractContextBufferId * bufferId )

Start BufferId creation Mode.

Precondition:: not_yet: !GetBufferIdMode(); bufferId_exists: bufferId!=0

Postcondition:: started: GetBufferIdMode()

void vtkContext2D::BufferIdModeEnd ( )

Finalize BufferId creation Mode. It makes sure that the content of the bufferId passed in argument of BufferIdModeBegin() is correctly set.

Precondition:: started: GetBufferIdMode()

Postcondition:: done: !GetBufferIdMode()

void vtkContext2D::DrawLine	(	float	x1,
		float	y1,
		float	x2,
		float	y2
	)

Draw a line between the specified points.

void vtkContext2D::DrawLine ( float p[4] )

Draw a line between the specified points.

void vtkContext2D::DrawLine ( vtkPoints2D * points )

Draw a line between the specified points. Note: Fastest path - points packed in x and y.

void vtkContext2D::DrawPoly	(	float *	x,
		float *	y,
		int	n
	)

Draw a poly line between the specified points.

void vtkContext2D::DrawPoly ( vtkPoints2D * points )

Draw a poly line between the specified points - fastest code path due to memory layout of the coordinates.

void vtkContext2D::DrawPoly	(	float *	points,
		int	n
	)

Draw a poly line between the specified points, where the float array is of size 2*n and the points are packed x1, y1, x2, y2 etc. Note: Fastest code path - points packed in x and y.

void vtkContext2D::DrawPoly	(	float *	points,
		int	n,
		unsigned char *	colors,
		int	nc_comps
	)

Draw a poly line between the specified points, where the float array is of size 2*n and the points are packed x1, y1, x2, y2 etc. The line will be colored by the colors array, which must have nc_comps components (defining a single color). Note: Fastest code path - points packed in x and y.

void vtkContext2D::DrawPoint	(	float	x,
		float	y
	)

Draw a point at the supplied x and y coordinate

void vtkContext2D::DrawPoints	(	float *	x,
		float *	y,
		int	n
	)

Draw the specified number of points using the x and y arrays supplied

void vtkContext2D::DrawPoints ( vtkPoints2D * points )

Draw a poly line between the specified points - fastest code path due to memory layout of the coordinates.

void vtkContext2D::DrawPoints	(	float *	points,
		int	n
	)

Draw a poly line between the specified points, where the float array is of size 2*n and the points are packed x1, y1, x2, y2 etc. Note: Fastest code path - points packed in x and y.

void vtkContext2D::DrawPointSprites	(	vtkImageData *	sprite,
		vtkPoints2D *	points
	)

Draw a series of point sprites, images centred at the points supplied. The supplied vtkImageData is the sprite to be drawn, only squares will be drawn and the size is set using SetPointSize.

void vtkContext2D::DrawPointSprites	(	vtkImageData *	sprite,
		vtkPoints2D *	points,
		vtkUnsignedCharArray *	colors
	)

Draw a series of point sprites, images centred at the points supplied. The supplied vtkImageData is the sprite to be drawn, only squares will be drawn and the size is set using SetPointSize. Points will be colored by the colors array, which must be the same length as points.

void vtkContext2D::DrawPointSprites	(	vtkImageData *	sprite,
		float *	points,
		int	n,
		unsigned char *	colors,
		int	nc_comps
	)

Draw a series of point sprites, images centred at the points supplied. The supplied vtkImageData is the sprite to be drawn, only squares will be drawn and the size is set using SetPointSize. Points will be colored by the colors array, which must be the same length as points.

void vtkContext2D::DrawPointSprites	(	vtkImageData *	sprite,
		float *	points,
		int	n
	)

Draw a series of point sprites, images centred at the points supplied. The supplied vtkImageData is the sprite to be drawn, only squares will be drawn and the size is set using SetPointSize.

virtual void vtkContext2D::DrawMarkers	(	int	shape,
		bool	highlight,
		float *	points,
		int	n,
		unsigned char *	colors,
		int	nc_comps
	)		`[virtual]`

Draw a series of markers centered at the points supplied. The shape argument controls the marker shape, and can be one of - VTK_MARKER_CROSS - VTK_MARKER_PLUS - VTK_MARKER_SQUARE - VTK_MARKER_CIRCLE - VTK_MARKER_DIAMOND Marker size is determined by the current pen width.

Parameters:

colors	is an optional array of colors.
nc_comps	is the number of components for the color.

virtual void vtkContext2D::DrawMarkers	(	int	shape,
		bool	highlight,
		float *	points,
		int	n
	)		`[virtual]`

Draw a series of markers centered at the points supplied. The shape argument controls the marker shape, and can be one of - VTK_MARKER_CROSS - VTK_MARKER_PLUS - VTK_MARKER_SQUARE - VTK_MARKER_CIRCLE - VTK_MARKER_DIAMOND Marker size is determined by the current pen width.

Parameters:

colors	is an optional array of colors.
nc_comps	is the number of components for the color.

virtual void vtkContext2D::DrawMarkers	(	int	shape,
		bool	highlight,
		vtkPoints2D *	points
	)		`[virtual]`

Draw a series of markers centered at the points supplied. The shape argument controls the marker shape, and can be one of - VTK_MARKER_CROSS - VTK_MARKER_PLUS - VTK_MARKER_SQUARE - VTK_MARKER_CIRCLE - VTK_MARKER_DIAMOND Marker size is determined by the current pen width.

Parameters:

colors	is an optional array of colors.
nc_comps	is the number of components for the color.

virtual void vtkContext2D::DrawMarkers	(	int	shape,
		bool	highlight,
		vtkPoints2D *	points,
		vtkUnsignedCharArray *	colors
	)		`[virtual]`

Draw a series of markers centered at the points supplied. The shape argument controls the marker shape, and can be one of - VTK_MARKER_CROSS - VTK_MARKER_PLUS - VTK_MARKER_SQUARE - VTK_MARKER_CIRCLE - VTK_MARKER_DIAMOND Marker size is determined by the current pen width.

Parameters:

colors	is an optional array of colors.
nc_comps	is the number of components for the color.

void vtkContext2D::DrawRect	(	float	x,
		float	y,
		float	w,
		float	h
	)

Draw a rectangle with origin at x, y and width w, height h

void vtkContext2D::DrawQuad	(	float	x1,
		float	y1,
		float	x2,
		float	y2,
		float	x3,
		float	y3,
		float	x4,
		float	y4
	)

Draw a quadrilateral at the specified points (4 points, 8 floats in x, y).

void vtkContext2D::DrawQuad ( float * p )

Draw a quadrilateral at the specified points (4 points, 8 floats in x, y).

void vtkContext2D::DrawQuadStrip ( vtkPoints2D * points )

Draw a strip of quads

void vtkContext2D::DrawQuadStrip	(	float *	p,
		int	n
	)

Draw a strip of quads

void vtkContext2D::DrawPolygon	(	float *	x,
		float *	y,
		int	n
	)

Draw a polygon specified specified by the points using the x and y arrays supplied

void vtkContext2D::DrawPolygon ( vtkPoints2D * points )

Draw a polygon defined by the specified points - fastest code path due to memory layout of the coordinates.

void vtkContext2D::DrawPolygon	(	float *	points,
		int	n
	)

Draw a polygon defined by the specified points, where the float array is of size 2*n and the points are packed x1, y1, x2, y2 etc. Note: Fastest code path - points packed in x and y.

void vtkContext2D::DrawEllipse	(	float	x,
		float	y,
		float	rx,
		float	ry
	)

Draw an ellipse with center at x, y and radii rx, ry.

Precondition:: positive_rx: rx>=0; positive_ry: ry>=0

void vtkContext2D::DrawWedge	(	float	x,
		float	y,
		float	outRadius,
		float	inRadius,
		float	startAngle,
		float	stopAngle
	)

Draw a circular wedge with center at x, y, outer radius outRadius, inner radius inRadius between angles startAngle and stopAngle (expressed in degrees).

Precondition:: positive_outRadius: outRadius>=0; positive_inRadius: inRadius>=0; ordered_radii: inRadius<=outRadius

void vtkContext2D::DrawEllipseWedge	(	float	x,
		float	y,
		float	outRx,
		float	outRy,
		float	inRx,
		float	inRy,
		float	startAngle,
		float	stopAngle
	)

Draw an elliptic wedge with center at x, y, outer radii outRx, outRy, inner radii inRx, inRy between angles startAngle and stopAngle (expressed in degrees).

Precondition:: positive_outRx: outRx>=0; positive_outRy: outRy>=0; positive_inRx: inRx>=0; positive_inRy: inRy>=0; ordered_rx: inRx<=outRx; ordered_ry: inRy<=outRy

void vtkContext2D::DrawArc	(	float	x,
		float	y,
		float	r,
		float	startAngle,
		float	stopAngle
	)

Draw a circular arc with center at x,y with radius r between angles startAngle and stopAngle (expressed in degrees).

Precondition:: positive_radius: r>=0

void vtkContext2D::DrawEllipticArc	(	float	x,
		float	y,
		float	rX,
		float	rY,
		float	startAngle,
		float	stopAngle
	)

Draw an elliptic arc with center at x,y with radii rX and rY between angles startAngle and stopAngle (expressed in degrees).

Precondition:: positive_rX: rX>=0; positive_rY: rY>=0

void vtkContext2D::DrawImage	(	float	x,
		float	y,
		vtkImageData *	image
	)

Draw the supplied image at the given x, y location (bottom corner).

void vtkContext2D::DrawImage	(	float	x,
		float	y,
		float	scale,
		vtkImageData *	image
	)

Draw the supplied image at the given x, y location (bottom corner). Scale the supplied image by scale.

void vtkContext2D::DrawImage	(	const vtkRectf &	pos,
		vtkImageData *	image
	)

Draw the supplied image at the given position. The origin, width, and height are specified by the supplied vtkRectf variable pos. The image will be drawn scaled to that size.

void vtkContext2D::DrawStringRect	(	vtkPoints2D *	rect,
		const vtkStdString &	string
	)

Draw some text to the screen in a bounding rectangle with the alignment of the text properties respecting the rectangle. The points should be supplied as bottom corner (x, y), width, height.

void vtkContext2D::DrawStringRect	(	vtkPoints2D *	rect,
		const vtkUnicodeString &	string
	)

Draw some text to the screen in a bounding rectangle with the alignment of the text properties respecting the rectangle. The points should be supplied as bottom corner (x, y), width, height.

void vtkContext2D::DrawStringRect	(	vtkPoints2D *	rect,
		const char *	string
	)

Draw some text to the screen in a bounding rectangle with the alignment of the text properties respecting the rectangle. The points should be supplied as bottom corner (x, y), width, height.

void vtkContext2D::DrawString	(	vtkPoints2D *	point,
		const vtkStdString &	string
	)

Draw some text to the screen.

void vtkContext2D::DrawString	(	float	x,
		float	y,
		const vtkStdString &	string
	)

Draw some text to the screen.

void vtkContext2D::DrawString	(	vtkPoints2D *	point,
		const vtkUnicodeString &	string
	)

Draw some text to the screen.

void vtkContext2D::DrawString	(	float	x,
		float	y,
		const vtkUnicodeString &	string
	)

Draw some text to the screen.

void vtkContext2D::DrawString	(	vtkPoints2D *	point,
		const char *	string
	)

Draw some text to the screen.

void vtkContext2D::DrawString	(	float	x,
		float	y,
		const char *	string
	)

Draw some text to the screen.

void vtkContext2D::ComputeStringBounds	(	const vtkStdString &	string,
		vtkPoints2D *	bounds
	)