Class for drawing 2D primitives using OpenGL 1.1+. More...

#include <vtkOpenGLContextDevice2D.h>

Inheritance diagram for vtkOpenGLContextDevice2D:

Collaboration diagram for vtkOpenGLContextDevice2D:

Classes
class	CellArrayHelper

class	Private

Public Types
typedef vtkContextDevice2D	Superclass

Public Types inherited from vtkContextDevice2D
enum	TextureProperty { Nearest = 0x01 , Linear = 0x02 , Stretch = 0x04 , Repeat = 0x08 }

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkOpenGLContextDevice2D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	DrawPoly (float f, int n, unsigned char colors=nullptr, int nc_comps=0) override
	Draw a poly line using the points - fastest code path due to memory layout of the coordinates.

void	DrawLines (float f, int n, unsigned char colors=nullptr, int nc_comps=0) override
	Draw lines using the points - memory layout is as follows: l1p1,l1p2,l2p1,l2p2... The lines will be colored by colors array which has nc_comps components.

void	DrawPoints (float points, int n, unsigned char colors=nullptr, int nc_comps=0) override
	Draw a series of points - fastest code path due to memory layout of the coordinates.

void	DrawPointSprites (vtkImageData sprite, float points, int n, unsigned char *colors=nullptr, int nc_comps=0) override
	Draw a series of point sprites, images centred at the points supplied.

void	DrawMarkers (int shape, bool highlight, float points, int n, unsigned char colors=nullptr, int nc_comps=0) override
	Draw a series of markers centered at the points supplied.

void	DrawQuad (float *points, int n) override
	Draws a rectangle.

void	DrawQuadStrip (float *points, int n) override
	Draws a rectangle.

void	DrawPolygon (float *, int) override
	Draw a polygon using the specified number of points.

void	DrawColoredPolygon (float points, int numPoints, unsigned char colors=nullptr, int nc_comps=0) override
	Draw a polygon using the specified number of points.

void	DrawEllipseWedge (float x, float y, float outRx, float outRy, float inRx, float inRy, float startAngle, float stopAngle) override
	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).

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

void	DrawString (float *point, const vtkStdString &string) override
	Draw some text to the screen!

void	ComputeStringBounds (const vtkStdString &string, float bounds[4]) override
	Compute the bounds of the supplied string.

void	DrawString (float *point, const vtkUnicodeString &string) override
	Draw some text to the screen.

void	ComputeStringBounds (const vtkUnicodeString &string, float bounds[4]) override
	Compute the bounds of the supplied string.

void	ComputeJustifiedStringBounds (const char *string, float bounds[4]) override
	Compute the bounds of the supplied string while taking into account the justification of the currently applied text property.

void	DrawMathTextString (float point[2], const vtkStdString &string) override
	Draw text using MathText markup for mathematical equations.

void	DrawImage (float p[2], float scale, vtkImageData *image) override
	Draw the supplied image at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1.0 would match the image).

void	DrawImage (const vtkRectf &pos, vtkImageData *image) override
	Draw the supplied image at the given position.

void	DrawPolyData (float p[2], float scale, vtkPolyData polyData, vtkUnsignedCharArray colors, int scalarMode) override
	Draw the supplied PolyData at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1.0 would match the actual dataset).

void	SetColor4 (unsigned char color[4]) override
	Set the color for the device using unsigned char of length 4, RGBA.

virtual void	SetColor (unsigned char color[3])
	Set the color for the device using unsigned char of length 3, RGB.

void	SetTexture (vtkImageData *image, int properties=0) override
	Set the texture for the device, it is used to fill the polygons.

void	SetPointSize (float size) override
	Set the point size for glyphs/sprites.

void	SetLineWidth (float width) override
	Set the line width for glyphs/sprites.

void	SetLineType (int type) override
	Set the line type type (using anonymous enum in vtkPen).

void	MultiplyMatrix (vtkMatrix3x3 *m) override
	Multiply the current model view matrix by the supplied one.

void	SetMatrix (vtkMatrix3x3 *m) override
	Set the model view matrix for the display.

void	GetMatrix (vtkMatrix3x3 *m) override
	Set the model view matrix for the display.

void	PushMatrix () override
	Push the current matrix onto the stack.

void	PopMatrix () override
	Pop the current matrix off of the stack.

void	SetClipping (int *x) override
	Supply an int array of length 4 with x1, y1, width, height specifying clipping region for the device in pixels.

void	EnableClipping (bool enable) override
	Disable clipping of the display.

void	Begin (vtkViewport *viewport) override
	Begin drawing, pass in the viewport to set up the view.

void	End () override
	End drawing, clean up the view.

void	BufferIdModeBegin (vtkAbstractContextBufferId *bufferId) override
	Start BufferId creation Mode.

void	BufferIdModeEnd () override
	Finalize BufferId creation Mode.

bool	SetStringRendererToFreeType ()
	Force the use of the freetype based render strategy.

bool	SetStringRendererToQt ()
	Force the use of the Qt based string render strategy.

bool	HasGLSL ()
	Check whether the current context device has support for GLSL.

virtual void	ReleaseGraphicsResources (vtkWindow *window)
	Release any graphics resources that are being consumed by this device.


virtual void	SetMaximumMarkerCacheSize (int)
	Adjust the size of the MarkerCache.

virtual int	GetMaximumMarkerCacheSize ()
	Adjust the size of the MarkerCache.


virtual vtkOpenGLRenderWindow *	GetRenderWindow ()
	Get the active RenderWindow of the device.


vtkMatrix4x4 *	GetProjectionMatrix ()
	Get the projection matrix this is needed.

vtkMatrix4x4 *	GetModelMatrix ()
	Get the projection matrix this is needed.

Public Member Functions inherited from vtkContextDevice2D
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkContextDevice2D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	DrawPoly (float points, int n, unsigned char colors=nullptr, int nc_comps=0)=0
	Draw a poly line using the points - fastest code path due to memory layout of the coordinates.

virtual void	DrawLines (float f, int n, unsigned char colors=nullptr, int nc_comps=0)=0
	Draw lines using the points - memory layout is as follows: l1p1,l1p2,l2p1,l2p2... The lines will be colored by colors array which has nc_comps components (defining a single color).

virtual void	DrawPoints (float points, int n, unsigned char colors=nullptr, int nc_comps=0)=0
	Draw a series of points - fastest code path due to memory layout of the coordinates.

virtual void	DrawPointSprites (vtkImageData sprite, float points, int n, unsigned char *colors=nullptr, int nc_comps=0)=0
	Draw a series of point sprites, images centred at the points supplied.

virtual void	DrawMarkers (int shape, bool highlight, float points, int n, unsigned char colors=nullptr, int nc_comps=0)
	Draw a series of markers centered at the points supplied.

virtual void	DrawQuad (float *, int)
	Draw a quad using the specified number of points.

virtual void	DrawQuadStrip (float *, int)
	Draw a quad using the specified number of points.

virtual void	DrawEllipseWedge (float x, float y, float outRx, float outRy, float inRx, float inRy, float startAngle, float stopAngle)=0
	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).

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

virtual void	DrawString (float *point, const vtkStdString &string)=0
	Draw some text to the screen.

virtual void	ComputeStringBounds (const vtkStdString &string, float bounds[4])=0
	Compute the bounds of the supplied string.

virtual void	DrawString (float *point, const vtkUnicodeString &string)=0
	Draw some text to the screen.

virtual void	ComputeStringBounds (const vtkUnicodeString &string, float bounds[4])=0
	Compute the bounds of the supplied string.

virtual void	ComputeJustifiedStringBounds (const char *string, float bounds[4])=0
	Compute the bounds of the supplied string while taking into account the justification of the currently applied text property.

virtual void	DrawMathTextString (float *point, const vtkStdString &string)=0
	Draw text using MathText markup for mathematical equations.

virtual bool	MathTextIsSupported ()
	Return true if MathText rendering available on this device.

virtual void	DrawImage (float p[2], float scale, vtkImageData *image)=0
	Draw the supplied image at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1.0 would match the image).

virtual void	DrawImage (const vtkRectf &pos, vtkImageData *image)=0
	Draw the supplied image at the given position.

virtual void	DrawPolyData (float p[2], float scale, vtkPolyData polyData, vtkUnsignedCharArray colors, int scalarMode)
	Draw the supplied PolyData at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1.0 would match the actual dataset).

virtual void	ApplyPen (vtkPen *pen)
	Apply the supplied pen which controls the outlines of shapes, as well as lines, points and related primitives.

virtual void	ApplyBrush (vtkBrush *brush)
	Apply the supplied brush which controls the outlines of shapes, as well as lines, points and related primitives.

virtual void	ApplyTextProp (vtkTextProperty *prop)
	Apply the supplied text property which controls how text is rendered.

virtual void	SetColor4 (unsigned char color[4])=0
	Set the color for the device using unsigned char of length 4, RGBA.

virtual void	SetTexture (vtkImageData *image, int properties)=0
	Set the texture for the device, it is used to fill the polygons.

virtual void	SetPointSize (float size)=0
	Set the point size for glyphs/sprites.

virtual void	SetLineWidth (float width)=0
	Set the line width.

virtual void	SetLineType (int type)=0
	Set the line type type (using anonymous enum in vtkPen).

virtual int	GetWidth ()
	Get the width of the device in pixels.

virtual int	GetHeight ()
	Get the width of the device in pixels.

virtual void	SetMatrix (vtkMatrix3x3 *m)=0
	Set the model view matrix for the display.

virtual void	GetMatrix (vtkMatrix3x3 *m)=0
	Set the model view matrix for the display.

virtual void	MultiplyMatrix (vtkMatrix3x3 *m)=0
	Multiply the current model view matrix by the supplied one.

virtual void	PushMatrix ()=0
	Push the current matrix onto the stack.

virtual void	PopMatrix ()=0
	Pop the current matrix off of the stack.

virtual void	SetClipping (int *x)=0
	Supply an int array of length 4 with x1, y1, width, height specifying clipping region for the device in pixels.

virtual void	DisableClipping ()
	Disable clipping of the display.

virtual void	EnableClipping (bool enable)=0
	Enable or disable the clipping of the scene.

virtual void	Begin (vtkViewport *)
	Begin drawing, pass in the viewport to set up the view.

virtual void	End ()
	End drawing, clean up the view.

virtual bool	GetBufferIdMode () const
	Tell if the device context is in BufferId creation mode.

virtual void	BufferIdModeBegin (vtkAbstractContextBufferId *bufferId)
	Start BufferId creation Mode.

virtual void	BufferIdModeEnd ()
	Finalize BufferId creation Mode.

virtual void	SetViewportSize (const vtkVector2i &size)

virtual vtkVector2i	GetViewportSize ()

virtual void	SetViewportRect (const vtkRecti &rect)

virtual vtkRecti	GetViewportRect ()

virtual vtkPen *	GetPen ()
	Get the pen which controls the outlines of shapes, as well as lines, points and related primitives.

virtual vtkBrush *	GetBrush ()
	Get the pen which controls the outlines of shapes as well as lines, points and related primitives.

virtual vtkTextProperty *	GetTextProp ()
	Get the text properties object for the vtkContext2D.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenGLContextDevice2D *	SafeDownCast (vtkObjectBase *o)

static vtkOpenGLContextDevice2D *	New ()
	Creates a 2D Painter object.

Static Public Member Functions inherited from vtkContextDevice2D
static vtkTypeBool	IsTypeOf (const char *type)

static vtkContextDevice2D *	SafeDownCast (vtkObjectBase *o)

static vtkContextDevice2D *	New ()

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenGLContextDevice2D ()

	~vtkOpenGLContextDevice2D () override

int	GetNumberOfArcIterations (float rX, float rY, float startAngle, float stopAngle)
	Factorized code called by DrawEllipseWedge() and DrawEllipticArc() to figure out the number of iterations required to make an arc smooth.

void	ReadyLinesCBOProgram ()

void	ReadyLinesBOProgram ()

void	ReadyVCBOProgram ()

void	ReadyVBOProgram ()

void	ReadyVTBOProgram ()

void	ReadySCBOProgram ()

void	ReadySBOProgram ()

void	SetMatrices (vtkShaderProgram *prog)

void	BuildVBO (vtkOpenGLHelper cbo, float v, int nv, unsigned char coolors, int nc, float tcoords)

void	CoreDrawTriangles (std::vector< float > &tverts, unsigned char *colors=nullptr, int numComp=0)

void	AddEllipseToPath (vtkPath *path, float x, float y, float rx, float ry, bool reverse)
	Add an ellipse to a vtkPath.

void	TransformPath (vtkPath *path) const
	Transform the path using the current modelview matrix.

void	TransformPoint (float &x, float &y) const
	Transform the 2D point using the current modelview matrix.

void	TransformSize (float &dx, float &dy) const
	Transform the width and height from pixels to data units.


void	DrawMarkersGL2PS (int shape, bool highlight, float points, int n, unsigned char colors, int nc_comps)
	Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.

void	DrawCrossMarkersGL2PS (bool highlight, float points, int n, unsigned char colors, int nc_comps)
	Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.

void	DrawPlusMarkersGL2PS (bool highlight, float points, int n, unsigned char colors, int nc_comps)
	Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.

void	DrawSquareMarkersGL2PS (bool highlight, float points, int n, unsigned char colors, int nc_comps)
	Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.

void	DrawCircleMarkersGL2PS (bool highlight, float points, int n, unsigned char colors, int nc_comps)
	Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.

void	DrawDiamondMarkersGL2PS (bool highlight, float points, int n, unsigned char colors, int nc_comps)
	Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.


void	DrawImageGL2PS (float p[2], vtkImageData *image)
	Embed an RGBA image in the GL2PS output at the supplied point.

void	DrawImageGL2PS (float p[2], float scale, vtkImageData *image)
	Embed an RGBA image in the GL2PS output at the supplied point.

void	DrawImageGL2PS (const vtkRectf &rect, vtkImageData *image)
	Embed an RGBA image in the GL2PS output at the supplied point.


void	DrawCircleGL2PS (float x, float y, float rX, float rY)
	Inject smooth primitives into the GL2PS stream.

void	DrawWedgeGL2PS (float x, float y, float outRx, float outRy, float inRx, float inRy)
	Inject smooth primitives into the GL2PS stream.

Protected Member Functions inherited from vtkContextDevice2D
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkContextDevice2D ()

	~vtkContextDevice2D () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkRenderer *	Renderer
	We need to store a pointer to the renderer for the text rendering.

bool	InRender
	Is the device currently rendering? Prevent multiple End() calls.

vtkOpenGLRenderWindow *	RenderWindow
	The OpenGL render window being used by the device.

vtkOpenGLHelper *	LinesCBO

vtkOpenGLHelper *	LinesBO

vtkOpenGLHelper *	VCBO

vtkOpenGLHelper *	VBO

vtkOpenGLHelper *	VTBO

vtkOpenGLHelper *	SCBO

vtkOpenGLHelper *	SBO

unsigned short	LinePattern


Private *	Storage

CellArrayHelper *	PolyDataImpl

Protected Attributes inherited from vtkContextDevice2D
int	Geometry [2]
	Store the width and height of the device in pixels.

vtkVector2i	ViewportSize
	Store the size of the total viewport.

vtkRecti	ViewportRect
	Store our origin and size in the total viewport.

vtkAbstractContextBufferId *	BufferId

vtkPen *	Pen

vtkBrush *	Brush

vtkTextProperty *	TextProp

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Class for drawing 2D primitives using OpenGL 1.1+.

This class takes care of drawing the 2D primitives for the vtkContext2D class. In general this class should not be used directly, but called by vtkContext2D which takes care of many of the higher level details.

See also: vtkOpenGL2ContextDevice2D

Online Examples:

Diagram

Definition at line 70 of file vtkOpenGLContextDevice2D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkContextDevice2D vtkOpenGLContextDevice2D::Superclass

Definition at line 73 of file vtkOpenGLContextDevice2D.h.

Constructor & Destructor Documentation

◆ vtkOpenGLContextDevice2D()

vtkOpenGLContextDevice2D::vtkOpenGLContextDevice2D ( )

protected

◆ ~vtkOpenGLContextDevice2D()

vtkOpenGLContextDevice2D::~vtkOpenGLContextDevice2D ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkOpenGLContextDevice2D::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkOpenGLContextDevice2D::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 vtkContextDevice2D.

◆ SafeDownCast()

static vtkOpenGLContextDevice2D * vtkOpenGLContextDevice2D::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOpenGLContextDevice2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkContextDevice2D.

◆ NewInstance()

vtkOpenGLContextDevice2D * vtkOpenGLContextDevice2D::NewInstance ( ) const

◆ PrintSelf()

void vtkOpenGLContextDevice2D::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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

◆ New()

static vtkOpenGLContextDevice2D * vtkOpenGLContextDevice2D::New ( )

static

Creates a 2D Painter object.

◆ DrawPoly()

void vtkOpenGLContextDevice2D::DrawPoly	(	float *	f,
		int	n,
		unsigned char *	colors = `nullptr`,
		int	nc_comps = `0`
	)

overridevirtual

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

The line will be colored by colors array which has nc_comps components

Implements vtkContextDevice2D.

◆ DrawLines()

void vtkOpenGLContextDevice2D::DrawLines	(	float *	f,
		int	n,
		unsigned char *	colors = `nullptr`,
		int	nc_comps = `0`
	)

overridevirtual

Draw lines using the points - memory layout is as follows: l1p1,l1p2,l2p1,l2p2... The lines will be colored by colors array which has nc_comps components.

See also: DrawPoly()

Implements vtkContextDevice2D.

◆ DrawPoints()

void vtkOpenGLContextDevice2D::DrawPoints	(	float *	points,
		int	n,
		unsigned char *	colors = `nullptr`,
		int	nc_comps = `0`
	)

overridevirtual

Draw a series of points - fastest code path due to memory layout of the coordinates.

Points are colored by colors array which has nc_comps components

Implements vtkContextDevice2D.

◆ DrawPointSprites()

void vtkOpenGLContextDevice2D::DrawPointSprites	(	vtkImageData *	sprite,
		float *	points,
		int	n,
		unsigned char *	colors = `nullptr`,
		int	nc_comps = `0`
	)

overridevirtual

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 are colored by colors array which has nc_comps components - this part is optional.

Implements vtkContextDevice2D.

◆ DrawMarkers()

void vtkOpenGLContextDevice2D::DrawMarkers	(	int	shape,
		bool	highlight,
		float *	points,
		int	n,
		unsigned char *	colors = `nullptr`,
		int	nc_comps = `0`
	)

overridevirtual

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

Parameters

shape	the shape of the marker
highlight	whether to highlight the marker or not
points	where to draw the sprites
n	the number of points
colors	is an optional array of colors.
nc_comps	is the number of components for the color.

Reimplemented from vtkContextDevice2D.

◆ SetMaximumMarkerCacheSize()

virtual void vtkOpenGLContextDevice2D::SetMaximumMarkerCacheSize ( int )

virtual

Adjust the size of the MarkerCache.

This implementation generates point sprites for each mark size/shape and uses DrawPointSprites to render them. The number of cached markers can be accessed with this function.

◆ GetMaximumMarkerCacheSize()

virtual int vtkOpenGLContextDevice2D::GetMaximumMarkerCacheSize ( )

virtual

Adjust the size of the MarkerCache.

This implementation generates point sprites for each mark size/shape and uses DrawPointSprites to render them. The number of cached markers can be accessed with this function.

◆ DrawQuad()

void vtkOpenGLContextDevice2D::DrawQuad	(	float *	points,
		int	n
	)

overridevirtual

Draws a rectangle.

Reimplemented from vtkContextDevice2D.

◆ DrawQuadStrip()

void vtkOpenGLContextDevice2D::DrawQuadStrip	(	float *	points,
		int	n
	)

overridevirtual

Draws a rectangle.

Reimplemented from vtkContextDevice2D.

◆ DrawPolygon()

void vtkOpenGLContextDevice2D::DrawPolygon	(	float *	,
		int
	)

overridevirtual

Draw a polygon using the specified number of points.

Reimplemented from vtkContextDevice2D.

◆ DrawColoredPolygon()

void vtkOpenGLContextDevice2D::DrawColoredPolygon	(	float *	points,
		int	numPoints,
		unsigned char *	colors = `nullptr`,
		int	nc_comps = `0`
	)

overridevirtual

Draw a polygon using the specified number of points.

Reimplemented from vtkContextDevice2D.

◆ DrawEllipseWedge()

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

overridevirtual

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

Implements vtkContextDevice2D.

◆ DrawEllipticArc()

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

overridevirtual

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

Implements vtkContextDevice2D.

◆ DrawString() [1/2]

void vtkOpenGLContextDevice2D::DrawString	(	float *	point,
		const vtkStdString &	string
	)

overridevirtual

Draw some text to the screen!

Implements vtkContextDevice2D.

◆ ComputeStringBounds() [1/2]

void vtkOpenGLContextDevice2D::ComputeStringBounds	(	const vtkStdString &	string,
		float	bounds[4]
	)

overridevirtual

Compute the bounds of the supplied string.

The bounds will be copied to the supplied bounds variable, the first two elements are the bottom corner of the string, and the second two elements are the width and height of the bounding box. An empty bounding box (0, 0, 0, 0) is returned for an empty string or string with only characters that cannot be rendered. NOTE: This function does not take account of the text rotation.

Implements vtkContextDevice2D.

◆ DrawString() [2/2]

void vtkOpenGLContextDevice2D::DrawString	(	float *	point,
		const vtkUnicodeString &	string
	)

overridevirtual

Draw some text to the screen.

Implements vtkContextDevice2D.

◆ ComputeStringBounds() [2/2]

void vtkOpenGLContextDevice2D::ComputeStringBounds	(	const vtkUnicodeString &	string,
		float	bounds[4]
	)

overridevirtual

Compute the bounds of the supplied string.

The bounds will be copied to the supplied bounds variable, the first two elements are the bottom corner of the string, and the second two elements are the width and height of the bounding box. An empty bounding box (0, 0, 0, 0) is returned for an empty string or string with only characters that cannot be rendered. NOTE: This function does not take account of the text rotation.

Implements vtkContextDevice2D.

◆ ComputeJustifiedStringBounds()

void vtkOpenGLContextDevice2D::ComputeJustifiedStringBounds	(	const char *	string,
		float	bounds[4]
	)

overridevirtual

Compute the bounds of the supplied string while taking into account the justification of the currently applied text property.

Simple rotations (0, 90, 180, 270 degrees) are also properly taken into account.

Implements vtkContextDevice2D.

◆ DrawMathTextString()

void vtkOpenGLContextDevice2D::DrawMathTextString	(	float	point[2],
		const vtkStdString &	string
	)

override

Draw text using MathText markup for mathematical equations.

See http://matplotlib.sourceforge.net/users/mathtext.html for more information.

◆ DrawImage() [1/2]

void vtkOpenGLContextDevice2D::DrawImage	(	float	p[2],
		float	scale,
		vtkImageData *	image
	)

overridevirtual

Draw the supplied image at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1.0 would match the image).

Implements vtkContextDevice2D.

◆ DrawImage() [2/2]

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

overridevirtual

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.

Implements vtkContextDevice2D.

◆ DrawPolyData()

void vtkOpenGLContextDevice2D::DrawPolyData	(	float	p[2],
		float	scale,
		vtkPolyData *	polyData,
		vtkUnsignedCharArray *	colors,
		int	scalarMode
	)

overridevirtual

Draw the supplied PolyData at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1.0 would match the actual dataset).

Reimplemented from vtkContextDevice2D.

◆ SetColor4()

void vtkOpenGLContextDevice2D::SetColor4 ( unsigned char color[4] )

overridevirtual

Set the color for the device using unsigned char of length 4, RGBA.

Implements vtkContextDevice2D.

◆ SetColor()

virtual void vtkOpenGLContextDevice2D::SetColor ( unsigned char color[3] )

virtual

Set the color for the device using unsigned char of length 3, RGB.

◆ SetTexture()

void vtkOpenGLContextDevice2D::SetTexture	(	vtkImageData *	image,
		int	properties = `0`
	)

overridevirtual

End drawing, clean up the view.

Reimplemented from vtkContextDevice2D.

◆ BufferIdModeBegin()

void vtkOpenGLContextDevice2D::BufferIdModeBegin ( vtkAbstractContextBufferId * bufferId )

overridevirtual

Start BufferId creation Mode.

The default implementation is empty.

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

Postcondition: started: GetBufferIdMode()

Reimplemented from vtkContextDevice2D.

◆ BufferIdModeEnd()

void vtkOpenGLContextDevice2D::BufferIdModeEnd ( )

overridevirtual

Finalize BufferId creation Mode.

It makes sure that the content of the bufferId passed in argument of BufferIdModeBegin() is correctly set. The default implementation is empty.

Precondition: started: GetBufferIdMode()

Postcondition: done: !GetBufferIdMode()

Reimplemented from vtkContextDevice2D.

◆ SetStringRendererToFreeType()

bool vtkOpenGLContextDevice2D::SetStringRendererToFreeType ( )

Force the use of the freetype based render strategy.

If Qt is available then freetype will be used preferentially, otherwise this has no effect. Returns true on success.

◆ SetStringRendererToQt()

bool vtkOpenGLContextDevice2D::SetStringRendererToQt ( )

Force the use of the Qt based string render strategy.

If Qt is not available then freetype will be used and this will return false.

◆ HasGLSL()

bool vtkOpenGLContextDevice2D::HasGLSL ( )

Check whether the current context device has support for GLSL.

◆ GetRenderWindow()

virtual vtkOpenGLRenderWindow * vtkOpenGLContextDevice2D::GetRenderWindow ( )

virtual

Get the active RenderWindow of the device.

Will return null if not active.

◆ ReleaseGraphicsResources()

virtual void vtkOpenGLContextDevice2D::ReleaseGraphicsResources ( vtkWindow * window )

virtual

Release any graphics resources that are being consumed by this device.

The parameter window could be used to determine which graphic resources to release.

◆ GetProjectionMatrix()

vtkMatrix4x4 * vtkOpenGLContextDevice2D::GetProjectionMatrix ( )

Get the projection matrix this is needed.

◆ GetModelMatrix()

vtkMatrix4x4 * vtkOpenGLContextDevice2D::GetModelMatrix ( )

Get the projection matrix this is needed.

◆ GetNumberOfArcIterations()

int vtkOpenGLContextDevice2D::GetNumberOfArcIterations	(	float	rX,
		float	rY,
		float	startAngle,
		float	stopAngle
	)

protected

Factorized code called by DrawEllipseWedge() and DrawEllipticArc() to figure out the number of iterations required to make an arc smooth.

Precondition: positive_rX: rX>=0.0f; positive_rY: rY>=0.0f; not_both_null: rX>0.0 || rY>0.0

◆ BuildVBO()

void vtkOpenGLContextDevice2D::BuildVBO	(	vtkOpenGLHelper *	cbo,
		float *	v,
		int	nv,
		unsigned char *	coolors,
		int	nc,
		float *	tcoords
	)

protected

◆ CoreDrawTriangles()

void vtkOpenGLContextDevice2D::CoreDrawTriangles	(	std::vector< float > &	tverts,
		unsigned char *	colors = `nullptr`,
		int	numComp = `0`
	)

protected