vtkContext3D Class Reference

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 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.
vtkContext3D *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
bool	Begin (vtkContextDevice3D *device)
	Begin painting on a vtkContextDevice3D, no painting can occur before this call has been made.
vtkContextDevice3D *	GetDevice ()
	Get access to the underlying 3D context.
bool	End ()
	Ends painting on the device, you would not usually need to call this as it should be called by the destructor.
void	DrawLine (const vtkVector3f &start, const vtkVector3f &end)
	Draw a line between the specified points.
void	DrawPoly (const float *points, int n)
	Draw a poly line between the specified points.
void	DrawPoint (const vtkVector3f &point)
	Draw a point at the point in 3D space.
void	DrawPoints (const float *points, int n)
	Draw a sequence of points at the specified locations.
void	DrawPoints (const float *points, int n, unsigned char *colors, int nc_comps)
	Draw a sequence of points at the specified locations.
void	DrawPoints (vtkDataArray *positions, vtkUnsignedCharArray *colors, std::uintptr_t cacheIdentifier)
void	DrawTriangleMesh (const float *mesh, int n, const unsigned char *colors, int nc)
	Draw triangles to generate the specified mesh.
void	DrawTriangleMesh (vtkDataArray *positions, vtkUnsignedCharArray *colors, std::uintptr_t cacheIdentifier)
void	ApplyPen (vtkPen *pen)
	Apply the supplied pen which controls the outlines of shapes, as well as lines, points and related primitives.
void	ApplyBrush (vtkBrush *brush)
	Apply the supplied brush which controls the outlines of shapes, as well as lines, points and related primitives.
void	SetTransform (vtkTransform *transform)
	Set the transform for the context, the underlying device will use the matrix of the transform.
vtkTransform *	GetTransform ()
	Compute the current transform applied to the context.
void	AppendTransform (vtkTransform *transform)
	Append the transform for the context, the underlying device will use the matrix of the transform.
void	PushMatrix ()
	Push/pop the transformation matrix for the painter (sets the underlying matrix for the device when available).
void	PopMatrix ()
	Push/pop the transformation matrix for the painter (sets the underlying matrix for the device when available).
void	EnableClippingPlane (int i, double *planeEquation)
	Enable/Disable the specified clipping plane.
void	DisableClippingPlane (int i)
	Enable/Disable the specified clipping plane.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
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.
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.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkContext3D *	SafeDownCast (vtkObjectBase *o)
static vtkContext3D *	New ()
	Creates a 3D context object.
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 (vtkTypeBool 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 vtkTypeBool	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
	vtkContext3D ()
	~vtkContext3D () 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 *)
virtual void	ObjectFinalize ()
	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
std::string	ObjectName
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 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.

Online Examples:

LinePlot3D

Definition at line 52 of file vtkContext3D.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkContext3D::Superclass

Definition at line 55 of file vtkContext3D.h.

Constructor & Destructor Documentation

vtkContext3D()

vtkContext3D::vtkContext3D ( )

protected

~vtkContext3D()

vtkContext3D::~vtkContext3D ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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 vtkObjectBase.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkContext3D::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkContext3D * vtkContext3D::NewInstance

(

)

const

PrintSelf()

void vtkContext3D::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 vtkObjectBase.

New()

static vtkContext3D * vtkContext3D::New ( )

static

Creates a 3D context object.

Begin()

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.

GetDevice()

vtkContextDevice3D * vtkContext3D::GetDevice

(

)

Get access to the underlying 3D context.

End()

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.

DrawLine()

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

Draw a line between the specified points.

DrawPoly()

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

Draw a poly line between the specified points.

DrawPoint()

void vtkContext3D::DrawPoint

(

const vtkVector3f &

point

)

Draw a point at the point in 3D space.

DrawPoints() [1/3]

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

Draw a sequence of points at the specified locations.

DrawPoints() [2/3]

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

DrawPoints() [3/3]

void vtkContext3D::DrawPoints	(	vtkDataArray *	positions,
		vtkUnsignedCharArray *	colors,
		std::uintptr_t	cacheIdentifier
	)

DrawTriangleMesh() [1/2]

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

Draw triangles to generate the specified mesh.

DrawTriangleMesh() [2/2]

void vtkContext3D::DrawTriangleMesh	(	vtkDataArray *	positions,
		vtkUnsignedCharArray *	colors,
		std::uintptr_t	cacheIdentifier
	)

ApplyPen()

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.

ApplyBrush()

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.

SetTransform()

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.

GetTransform()

vtkTransform * vtkContext3D::GetTransform

(

)

Compute the current transform applied to the context.

AppendTransform()

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.

PushMatrix()

void vtkContext3D::PushMatrix

(

)

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

PopMatrix()

void vtkContext3D::PopMatrix

(

)

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

EnableClippingPlane()

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.

DisableClippingPlane()

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.

Member Data Documentation

Device

vtkSmartPointer<vtkContextDevice3D> vtkContext3D::Device

protected

Definition at line 177 of file vtkContext3D.h.

Transform

vtkSmartPointer<vtkTransform> vtkContext3D::Transform

protected

Definition at line 178 of file vtkContext3D.h.

---

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

• Rendering/Context2D/vtkContext3D.h