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

#include <vtkContext3D.h>

Inheritance diagram for vtkContext3D:

Collaboration diagram for vtkContext3D:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkContext3D *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

bool	Begin (vtkContextDevice3D *device)

vtkContextDevice3D *	GetDevice ()

bool	End ()

void	DrawLine (const vtkVector3f &start, const vtkVector3f &end)

void	DrawPoly (const float *points, int n)

void	DrawPoint (const vtkVector3f &point)

void	DrawPoints (const float *points, int n)

void	ApplyPen (vtkPen *pen)

void	ApplyBrush (vtkBrush *brush)

void	SetTransform (vtkTransform *transform)

vtkTransform *	GetTransform ()

void	AppendTransform (vtkTransform *transform)


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


void	DrawTriangleMesh (const float mesh, int n, const unsigned char colors, int nc)


void	PushMatrix ()

void	PopMatrix ()


void	EnableClippingPlane (int i, double *planeEquation)

void	DisableClippingPlane (int i)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

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

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)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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

static vtkContext3D *	SafeDownCast (vtkObjectBase *o)

static vtkContext3D *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkContext3D ()

	~vtkContext3D ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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

Protected Attributes
vtkSmartPointer< vtkContextDevice3D >	Device

vtkSmartPointer< vtkTransform >	Transform

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Class for drawing 3D primitives to a graphical context.

This defines the interface for drawing onto a 3D context. The context must be set up with a vtkContextDevice3D derived class that provides the functions to facilitate the low level calls to the context. Currently only an OpenGL based device is provided.

Definition at line 39 of file vtkContext3D.h.

Member Typedef Documentation

typedef vtkObject vtkContext3D::Superclass

Definition at line 42 of file vtkContext3D.h.

Constructor & Destructor Documentation

vtkContext3D::vtkContext3D ( )

protected

vtkContext3D::~vtkContext3D ( )

protected

Member Function Documentation

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

static

virtual int vtkContext3D::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 vtkContext3D* vtkContext3D::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkContext3D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkContext3D* vtkContext3D::NewInstance ( ) const

virtual void vtkContext3D::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 vtkContext3D* vtkContext3D::New ( )

static

Creates a 3D context object.

bool vtkContext3D::Begin ( vtkContextDevice3D * device )

Begin painting on a vtkContextDevice3D, 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.

vtkContextDevice3D* vtkContext3D::GetDevice ( )

Get access to the underlying 3D context.

bool vtkContext3D::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.

void vtkContext3D::DrawLine	(	const vtkVector3f &	start,
		const vtkVector3f &	end
	)

Draw a line between the specified points.

void vtkContext3D::DrawPoly	(	const float *	points,
		int	n
	)

Draw a poly line between the specified points.

void vtkContext3D::DrawPoint ( const vtkVector3f & point )

Draw a point at the point in 3D space.

void vtkContext3D::DrawPoints	(	const float *	points,
		int	n
	)

Draw a sequence of points at the specified locations.

void vtkContext3D::DrawPoints	(	const float *	points,
		int	n,
		unsigned char *	colors,
		int	nc_comps
	)

Draw a sequence of points at the specified locations. The points will be colored by the colors array, which must have nc_comps components (defining a single color).

void vtkContext3D::DrawTriangleMesh	(	const float *	mesh,
		int	n,
		const unsigned char *	colors,
		int	nc
	)

Draw triangles to generate the specified mesh.

void vtkContext3D::ApplyPen ( vtkPen * pen )

Apply the supplied pen which controls the outlines of shapes, as well as lines, points and related primitives. This makes a deep copy of the vtkPen object in the vtkContext2D, it does not hold a pointer to the supplied object.

void vtkContext3D::ApplyBrush ( vtkBrush * brush )

Apply the supplied brush which controls the outlines of shapes, as well as lines, points and related primitives. This makes a deep copy of the vtkBrush object in the vtkContext2D, it does not hold a pointer to the supplied object.

void vtkContext3D::SetTransform ( vtkTransform * transform )

Set the transform for the context, the underlying device will use the matrix of the transform. Note, this is set immediately, later changes to the matrix will have no effect until it is set again.

vtkTransform* vtkContext3D::GetTransform ( )

Compute the current transform applied to the context.

void vtkContext3D::AppendTransform ( vtkTransform * transform )

Append the transform for the context, the underlying device will use the matrix of the transform. Note, this is set immediately, later changes to the matrix will have no effect until it is set again. The matrix of the transform will multiply the current context transform.

void vtkContext3D::PushMatrix ( )

Push/pop the transformation matrix for the painter (sets the underlying matrix for the device when available).

void vtkContext3D::PopMatrix ( )

Push/pop the transformation matrix for the painter (sets the underlying matrix for the device when available).

void vtkContext3D::EnableClippingPlane	(	int	i,
		double *	planeEquation
	)

Enable/Disable the specified clipping plane. i is the index of the clipping plane being enabled or disabled (0 - 5). planeEquation points to the four coefficients of the equation for the clipping plane: Ax + By + Cz + D = 0. This is the equation format expected by glClipPlane.

void vtkContext3D::DisableClippingPlane ( int i )

Enable/Disable the specified clipping plane. i is the index of the clipping plane being enabled or disabled (0 - 5). planeEquation points to the four coefficients of the equation for the clipping plane: Ax + By + Cz + D = 0. This is the equation format expected by glClipPlane.