Helper functions for using GL2PS within VTK. More...

#include <vtkGL2PSUtilities.h>

Inheritance diagram for vtkGL2PSUtilities:

Collaboration diagram for vtkGL2PSUtilities:

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkGL2PSUtilities *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
Static Public Member Functions
static vtkGL2PSUtilities *	New ()
static int	IsTypeOf (const char *type)
static vtkGL2PSUtilities *	SafeDownCast (vtkObjectBase *o)
static const char *	TextPropertyToPSFontName (vtkTextProperty *tprop)
static int	TextPropertyToGL2PSAlignment (vtkTextProperty *tprop)

static void	DrawString (const char str, vtkTextProperty tprop, double pos[3], double backgroundDepth)

static vtkRenderWindow *	GetRenderWindow ()

static void	Draw3DPath (vtkPath path, vtkMatrix4x4 actorMatrix, double rasterPos[3], unsigned char actorColor[4], const char *label=NULL)

static 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)

static bool	GetTextAsPath ()

static float	GetPointSizeFactor ()
static float	GetLineWidthFactor ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGL2PSUtilities ()
	~vtkGL2PSUtilities ()
Static Protected Member Functions
static void	StartExport ()
static void	FinishExport ()
static void	SetPointSizeFactor (float f)
static void	SetLineWidthFactor (float f)
static void	SetTextAsPath (bool b)
static void	SetRenderWindow (vtkRenderWindow *renWin)
static void	DrawPathPS (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)
static void	DrawPathPDF (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)
static void	DrawPathSVG (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)
Friends
class	vtkGL2PSExporter

Detailed Description

Helper functions for using GL2PS within VTK.

vtkGL2PSUtilities implements some static helper function that simplify calling GL2PS routines on VTK objects. This class is meant for internal use only and is subject to change.

Definition at line 36 of file vtkGL2PSUtilities.h.

Member Typedef Documentation

typedef vtkObject vtkGL2PSUtilities::Superclass

Reimplemented from vtkObject.

Definition at line 40 of file vtkGL2PSUtilities.h.

Constructor & Destructor Documentation

vtkGL2PSUtilities::vtkGL2PSUtilities ( ) [inline, protected]

Definition at line 147 of file vtkGL2PSUtilities.h.

vtkGL2PSUtilities::~vtkGL2PSUtilities ( ) [inline, protected]

Definition at line 148 of file vtkGL2PSUtilities.h.

Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkGL2PSUtilities::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 vtkGL2PSUtilities::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 vtkGL2PSUtilities* vtkGL2PSUtilities::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

vtkGL2PSUtilities* vtkGL2PSUtilities::NewInstance ( ) const

Reimplemented from vtkObject.

void vtkGL2PSUtilities::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[inline, 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.

Definition at line 41 of file vtkGL2PSUtilities.h.

static void vtkGL2PSUtilities::DrawString	(	const char *	str,
		vtkTextProperty *	tprop,
		double	pos[3],
		double	backgroundDepth
	)		`[static]`

Format the text in str according to tprop and instruct GL2PS to draw it at world coordinate pos. Background depth is the z value for the background quad, and should be in NDC space.

static const char* vtkGL2PSUtilities::TextPropertyToPSFontName ( vtkTextProperty * tprop ) [static]

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

static int vtkGL2PSUtilities::TextPropertyToGL2PSAlignment ( vtkTextProperty * tprop ) [static]

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

static vtkRenderWindow* vtkGL2PSUtilities::GetRenderWindow ( ) [inline, static]

Get the current RenderWindow that is being exported

Definition at line 63 of file vtkGL2PSUtilities.h.

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

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.

static void vtkGL2PSUtilities::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`
	)		`[static]`

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.

static bool vtkGL2PSUtilities::GetTextAsPath ( ) [inline, static]

Get whether all text will be exported as paths.

Definition at line 97 of file vtkGL2PSUtilities.h.

static float vtkGL2PSUtilities::GetPointSizeFactor ( ) [inline, static]

Get a scaling factor for the point size or line width used by GL2PS. Default value: 5/7.

Definition at line 106 of file vtkGL2PSUtilities.h.

static float vtkGL2PSUtilities::GetLineWidthFactor ( ) [inline, static]

Get a scaling factor for the point size or line width used by GL2PS. Default value: 5/7.

Definition at line 108 of file vtkGL2PSUtilities.h.

static void vtkGL2PSUtilities::StartExport ( ) [static, protected]

static void vtkGL2PSUtilities::FinishExport ( ) [static, protected]

static void vtkGL2PSUtilities::SetPointSizeFactor ( float f ) [inline, static, protected]

Definition at line 118 of file vtkGL2PSUtilities.h.

static void vtkGL2PSUtilities::SetLineWidthFactor ( float f ) [inline, static, protected]

Definition at line 121 of file vtkGL2PSUtilities.h.

static void vtkGL2PSUtilities::SetTextAsPath ( bool b ) [inline, static, protected]

Definition at line 124 of file vtkGL2PSUtilities.h.

static void vtkGL2PSUtilities::SetRenderWindow ( vtkRenderWindow * renWin ) [inline, static, protected]

Definition at line 129 of file vtkGL2PSUtilities.h.

static void vtkGL2PSUtilities::DrawPathPS	(	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`
	)		`[static, protected]`

static void vtkGL2PSUtilities::DrawPathPDF	(	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`
	)		`[static, protected]`

static void vtkGL2PSUtilities::DrawPathSVG	(	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`
	)		`[static, protected]`

Friends And Related Function Documentation

friend class vtkGL2PSExporter [friend]

Definition at line 113 of file vtkGL2PSUtilities.h.

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

/Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Rendering/GL2PS/vtkGL2PSUtilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation