vtkOpenGLGL2PSHelper override implementation. More...

#include <vtkOpenGLGL2PSHelperImpl.h>

Inheritance diagram for vtkOpenGLGL2PSHelperImpl:

Collaboration diagram for vtkOpenGLGL2PSHelperImpl:

Public Types
typedef vtkOpenGLGL2PSHelper	Superclass

Public Types inherited from vtkOpenGLGL2PSHelper
enum	State { Inactive = 0, Background, Capture }

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

vtkOpenGLGL2PSHelperImpl *	NewInstance () const

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

virtual void	ProcessTransformFeedback (vtkTransformFeedback tfc, vtkRenderer ren, vtkActor *act)
	Parse the vertex information in tfc and inject primitives into GL2PS. More...

virtual void	ProcessTransformFeedback (vtkTransformFeedback tfc, vtkRenderer ren, unsigned char col[4])

virtual void	ProcessTransformFeedback (vtkTransformFeedback tfc, vtkRenderer ren, float col[4])

virtual void	DrawString (const std::string &str, vtkTextProperty tprop, double pos[3], double backgroundDepth, vtkRenderer ren)
	Format the text in str according to tprop and instruct GL2PS to draw it at pixel coordinate pos. More...

virtual void	DrawPath (vtkPath path, double rasterPos[3], double windowPos[2], unsigned char rgba[4], double scale[2]=NULL, double rotateAngle=0.0, float strokeWidth=-1, const char label=NULL)
	Generate PS, EPS, or SVG markup from a vtkPath object, and then inject it into the output using the gl2psSpecial command. More...

virtual void	Draw3DPath (vtkPath path, vtkMatrix4x4 actorMatrix, double rasterPos[3], unsigned char actorColor[4], vtkRenderer ren, const char label=NULL)
	Transform the path using the actor's matrix and current GL state, then draw it to GL2PS. More...

virtual void	DrawImage (vtkImageData *image, double pos[3])
	Draw the image at pos. More...

Public Member Functions inherited from vtkOpenGLGL2PSHelper
	vtkAbstractTypeMacro (vtkOpenGLGL2PSHelper, vtkObject) virtual void PrintSelf(ostream &os

virtual vtkRenderWindow *	GetRenderWindow ()
	Get the renderwindow that's being exported. More...

virtual State	GetActiveState ()
	Get the current export state. More...

virtual void	SetPointSize (float)
	Set/Get the current point size. More...

virtual float	GetPointSize ()

virtual void	SetLineWidth (float)
	Set/Get the current line width. More...

virtual float	GetLineWidth ()

virtual void	SetLineStipple (unsigned short)
	Set/Get the current line stipple pattern per OpenGL convention. More...

virtual unsigned short	GetLineStipple ()

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

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

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

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

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

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

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

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

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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

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

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

virtual void	Delete ()
	Delete a VTK object. More...

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

void	InitializeObjectBase ()

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

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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

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

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

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

Static Public Member Functions
static vtkOpenGLGL2PSHelperImpl *	New ()

static int	IsTypeOf (const char *type)

static vtkOpenGLGL2PSHelperImpl *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkOpenGLGL2PSHelper
static void	SetLineWidth (float lineWidth)
	Call alongside glLineWidth(lineWidth) to inform GL2PS of the change. More...

static void	SetPointSize (float pointSize)
	Call alongside glPointSize(pointSize) to inform GL2PS of the change. More...

static void	EnableStipple ()
	Call alongside glEnable(GL_LINE_STIPPLE) to inform GL2PS of the change. More...

static void	DisableStipple ()
	Call alongside glDisable(GL_LINE_STIPPLE) to inform GL2PS of the change. More...

static vtkOpenGLGL2PSHelper *	New ()

static vtkOpenGLGL2PSHelper *	GetInstance ()
	The global instance. More...

static void	SetInstance (vtkOpenGLGL2PSHelper *)

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

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

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

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenGLGL2PSHelperImpl ()

	~vtkOpenGLGL2PSHelperImpl ()

void	DrawPathPS (vtkPath *path, double rasterPos[3], double windowPos[2], unsigned char rgba[4], double scale[2], double rotateAngle, float strokeWidth, const std::string &label)

void	DrawPathPDF (vtkPath *path, double rasterPos[3], double windowPos[2], unsigned char rgba[4], double scale[2], double rotateAngle, float strokeWidth, const std::string &label)

void	DrawPathSVG (vtkPath *path, double rasterPos[3], double windowPos[2], unsigned char rgba[4], double scale[2], double rotateAngle, float strokeWidth, const std::string &label)

Protected Member Functions inherited from vtkOpenGLGL2PSHelper
	vtkOpenGLGL2PSHelper ()

	~vtkOpenGLGL2PSHelper ()

virtual void	SetActiveState (State)

virtual void	SetTextAsPath (bool)

virtual void	SetRenderWindow (vtkRenderWindow *)

virtual void	SetPointSizeFactor (float)

virtual void	SetLineWidthFactor (float)

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static const char *	TextPropertyToPSFontName (vtkTextProperty *tprop)
	Translate the tprop's fontname into a Postscript font name. More...

static int	TextPropertyToGL2PSAlignment (vtkTextProperty *tprop)
	Convert the alignment hint in tprop to a GL2PS text alignment constant. More...

static void	GetTransformParameters (vtkRenderer ren, vtkMatrix4x4 actorMatrix, vtkMatrix4x4 *xform, double vpOrigin[2], double halfSize[2], double zfact[2])
	Extracts the information needed for transforming and projecting points from a renderer. More...

static void	ProjectPoint (double point[3], vtkRenderer ren, vtkMatrix4x4 actorMatrix=NULL)
	Project the point from world coordinates into device coordinates. More...

static void	ProjectPoint (double point[4], vtkMatrix4x4 *transformMatrix, double viewportOrigin[2], double halfWidth, double halfHeight, double zfact1, double zfact2)

static void	ProjectPoints (vtkPoints points, vtkRenderer ren, vtkMatrix4x4 *actorMatrix=NULL)

static void	UnprojectPoint (double point[4], vtkMatrix4x4 *invTransformMatrix, double viewportOrigin[2], double halfWidth, double halfHeight, double zfact1, double zfact2)
	Unproject the point from device coordinates into world coordinates. More...

static void	UnprojectPoints (double points3D, vtkIdType numPoints, vtkRenderer ren, vtkMatrix4x4 *actorMatrix=NULL)

Additional Inherited Members
Public Attributes inherited from vtkOpenGLGL2PSHelper
vtkIndent	indent

Protected Attributes inherited from vtkOpenGLGL2PSHelper
vtkRenderWindow *	RenderWindow

State	ActiveState

bool	TextAsPath

float	PointSize

float	LineWidth

float	PointSizeFactor

float	LineWidthFactor

unsigned short	LineStipple

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes inherited from vtkOpenGLGL2PSHelper
static bool	InGL2PSRender

static GLfloat	PointSizeFactor

static GLfloat	LineWidthFactor

static GLfloat	PointSizeToken

static GLfloat	LineWidthToken

static GLfloat	StippleBeginToken

static GLfloat	StippleEndToken

static vtkOpenGLGL2PSHelper *	Instance

Detailed Description

vtkOpenGLGL2PSHelper override implementation.

Definition at line 31 of file vtkOpenGLGL2PSHelperImpl.h.

Member Typedef Documentation

◆ Superclass

typedef vtkOpenGLGL2PSHelper vtkOpenGLGL2PSHelperImpl::Superclass

Definition at line 36 of file vtkOpenGLGL2PSHelperImpl.h.

Constructor & Destructor Documentation

◆ vtkOpenGLGL2PSHelperImpl()

vtkOpenGLGL2PSHelperImpl::vtkOpenGLGL2PSHelperImpl ( )

protected

◆ ~vtkOpenGLGL2PSHelperImpl()

vtkOpenGLGL2PSHelperImpl::~vtkOpenGLGL2PSHelperImpl ( )

protected

Member Function Documentation

◆ New()

static vtkOpenGLGL2PSHelperImpl* vtkOpenGLGL2PSHelperImpl::New ( )

static

◆ IsTypeOf()

static int vtkOpenGLGL2PSHelperImpl::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkOpenGLGL2PSHelperImpl::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 vtkObjectBase.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLGL2PSHelperImpl::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkOpenGLGL2PSHelperImpl* vtkOpenGLGL2PSHelperImpl::NewInstance ( ) const

◆ PrintSelf()

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

◆ ProcessTransformFeedback() [1/3]

virtual void vtkOpenGLGL2PSHelperImpl::ProcessTransformFeedback	(	vtkTransformFeedback *	tfc,
		vtkRenderer *	ren,
		vtkActor *	act
	)

virtual

Parse the vertex information in tfc and inject primitives into GL2PS.

ren is used to obtain viewport information to complete the vertex tranformation into pixel coordinates, and act/col are used to color the vertices when tfc does not contain color information.

Implements vtkOpenGLGL2PSHelper.

◆ ProcessTransformFeedback() [2/3]

virtual void vtkOpenGLGL2PSHelperImpl::ProcessTransformFeedback	(	vtkTransformFeedback *	tfc,
		vtkRenderer *	ren,
		unsigned char	col[4]
	)

virtual

Implements vtkOpenGLGL2PSHelper.

◆ ProcessTransformFeedback() [3/3]

virtual void vtkOpenGLGL2PSHelperImpl::ProcessTransformFeedback	(	vtkTransformFeedback *	tfc,
		vtkRenderer *	ren,
		float	col[4]
	)

virtual

Implements vtkOpenGLGL2PSHelper.

◆ DrawString()

virtual void vtkOpenGLGL2PSHelperImpl::DrawString	(	const std::string &	str,
		vtkTextProperty *	tprop,
		double	pos[3],
		double	backgroundDepth,
		vtkRenderer *	ren
	)

virtual

Format the text in str according to tprop and instruct GL2PS to draw it at pixel coordinate pos.

Background depth is the z value for the background quad, and should be in NDC space. The drawing is always done in the overlay plane.

See also: TextAsPath

Implements vtkOpenGLGL2PSHelper.

◆ DrawPath()

virtual void vtkOpenGLGL2PSHelperImpl::DrawPath	(	vtkPath *	path,
		double	rasterPos[3],
		double	windowPos[2],
		unsigned char	rgba[4],
		double	scale[2] = `NULL`,
		double	rotateAngle = `0.0`,
		float	strokeWidth = `-1`,
		const char *	label = `NULL`
	)

virtual

Generate PS, EPS, or SVG markup from a vtkPath object, and then inject it into the output using the gl2psSpecial command.

The path is translated uniformly in the scene by windowPos. It is scaled by scale and rotated counter-clockwise by rotateAngle. The rasterPos is in world coordinates and determines clipping and depth. If scale is NULL, no scaling is done. If strokeWidth is positive, the path will be stroked with the indicated width. If zero or negative, the path will be filled (default). The label string is inserted into the GL2PS output at the beginning of the path specification as a comment on supported backends.

Implements vtkOpenGLGL2PSHelper.

◆ Draw3DPath()

virtual void vtkOpenGLGL2PSHelperImpl::Draw3DPath	(	vtkPath *	path,
		vtkMatrix4x4 *	actorMatrix,
		double	rasterPos[3],
		unsigned char	actorColor[4],
		vtkRenderer *	ren,
		const char *	label = `NULL`
	)

virtual

Transform the path using the actor's matrix and current GL state, then draw it to GL2PS.

The label string is inserted into the GL2PS output at the beginning of the path specification as a comment on supported backends.

Implements vtkOpenGLGL2PSHelper.

◆ DrawImage()

virtual void vtkOpenGLGL2PSHelperImpl::DrawImage	(	vtkImageData *	image,
		double	pos[3]
	)

virtual

Draw the image at pos.

Image must be RGB or RGBA with float scalars.

Implements vtkOpenGLGL2PSHelper.

◆ TextPropertyToPSFontName()

static const char* vtkOpenGLGL2PSHelperImpl::TextPropertyToPSFontName ( vtkTextProperty * tprop )

staticprotected

Translate the tprop's fontname into a Postscript font name.

◆ TextPropertyToGL2PSAlignment()

static int vtkOpenGLGL2PSHelperImpl::TextPropertyToGL2PSAlignment ( vtkTextProperty * tprop )

staticprotected

Convert the alignment hint in tprop to a GL2PS text alignment constant.

◆ GetTransformParameters()

static void vtkOpenGLGL2PSHelperImpl::GetTransformParameters	(	vtkRenderer *	ren,
		vtkMatrix4x4 *	actorMatrix,
		vtkMatrix4x4 *	xform,
		double	vpOrigin[2],
		double	halfSize[2],
		double	zfact[2]
	)

staticprotected

Extracts the information needed for transforming and projecting points from a renderer.

◆ ProjectPoint() [1/2]

static void vtkOpenGLGL2PSHelperImpl::ProjectPoint	(	double	point[3],
		vtkRenderer *	ren,
		vtkMatrix4x4 *	actorMatrix = `NULL`
	)

staticprotected

Project the point from world coordinates into device coordinates.

◆ ProjectPoint() [2/2]

static void vtkOpenGLGL2PSHelperImpl::ProjectPoint	(	double	point[4],
		vtkMatrix4x4 *	transformMatrix,
		double	viewportOrigin[2],
		double	halfWidth,
		double	halfHeight,
		double	zfact1,
		double	zfact2
	)

staticprotected

◆ ProjectPoints()

static void vtkOpenGLGL2PSHelperImpl::ProjectPoints	(	vtkPoints *	points,
		vtkRenderer *	ren,
		vtkMatrix4x4 *	actorMatrix = `NULL`
	)

staticprotected

◆ UnprojectPoint()

static void vtkOpenGLGL2PSHelperImpl::UnprojectPoint	(	double	point[4],
		vtkMatrix4x4 *	invTransformMatrix,
		double	viewportOrigin[2],
		double	halfWidth,
		double	halfHeight,
		double	zfact1,
		double	zfact2
	)

staticprotected

Unproject the point from device coordinates into world coordinates.

Input Z coordinate should be in NDC space.

◆ UnprojectPoints()

static void vtkOpenGLGL2PSHelperImpl::UnprojectPoints	(	double *	points3D,
		vtkIdType	numPoints,
		vtkRenderer *	ren,
		vtkMatrix4x4 *	actorMatrix = `NULL`
	)

staticprotected

◆ DrawPathPS()

void vtkOpenGLGL2PSHelperImpl::DrawPathPS	(	vtkPath *	path,
		double	rasterPos[3],
		double	windowPos[2],
		unsigned char	rgba[4],
		double	scale[2],
		double	rotateAngle,
		float	strokeWidth,
		const std::string &	label
	)

protected

◆ DrawPathPDF()

void vtkOpenGLGL2PSHelperImpl::DrawPathPDF	(	vtkPath *	path,
		double	rasterPos[3],
		double	windowPos[2],
		unsigned char	rgba[4],
		double	scale[2],
		double	rotateAngle,
		float	strokeWidth,
		const std::string &	label
	)

protected

◆ DrawPathSVG()

void vtkOpenGLGL2PSHelperImpl::DrawPathSVG	(	vtkPath *	path,
		double	rasterPos[3],
		double	windowPos[2],
		unsigned char	rgba[4],
		double	scale[2],
		double	rotateAngle,
		float	strokeWidth,
		const std::string &	label
	)

protected

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

dox/Rendering/GL2PSOpenGL2/vtkOpenGLGL2PSHelperImpl.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOpenGLGL2PSHelperImpl()

◆ ~vtkOpenGLGL2PSHelperImpl()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ ProcessTransformFeedback() [1/3]

◆ ProcessTransformFeedback() [2/3]

◆ ProcessTransformFeedback() [3/3]

◆ DrawString()

◆ DrawPath()

◆ Draw3DPath()

◆ DrawImage()

◆ TextPropertyToPSFontName()

◆ TextPropertyToGL2PSAlignment()

◆ GetTransformParameters()

◆ ProjectPoint() [1/2]

◆ ProjectPoint() [2/2]

◆ ProjectPoints()

◆ UnprojectPoint()

◆ UnprojectPoints()

◆ DrawPathPS()

◆ DrawPathPDF()

◆ DrawPathSVG()