Abstract class for drawing 3D primitives. More...

#include <vtkContextDevice3D.h>

Inheritance diagram for vtkContextDevice3D:

Collaboration diagram for vtkContextDevice3D:

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.

vtkContextDevice3D *	NewInstance () const

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

virtual void	DrawPoly (const float verts, int n, const unsigned char colors=nullptr, int nc=0)=0
	Draw a polyline between the specified points.

virtual void	DrawLines (const float verts, int n, const unsigned char colors=nullptr, int nc=0)=0
	Draw lines defined by specified pair of points.

virtual void	DrawPoints (const float verts, int n, const unsigned char colors=nullptr, int nc=0)=0
	Draw points at the vertex positions specified.

virtual void	DrawPoints (vtkDataArray positions, vtkUnsignedCharArray colors, std::uintptr_t vtkNotUsed(cacheIdentifier))

virtual void	DrawTriangleMesh (const float mesh, int n, const unsigned char colors, int nc)=0
	Draw triangles to generate the specified mesh.

virtual void	DrawTriangleMesh (vtkDataArray positions, vtkUnsignedCharArray colors, std::uintptr_t vtkNotUsed(cacheIdentifier))

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

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

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

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

virtual void	MultiplyMatrix (vtkMatrix4x4 *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 (const vtkRecti &rect)=0
	Supply a float 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	ReleaseCache (std::uintptr_t vtkNotUsed(cacheIdentifier))
	Concrete graphics implementations maintain a cache of heavy-weight buffer objects to achieve higher interactive framerates.


virtual void	EnableClippingPlane (int i, double *planeEquation)=0
	Enable/Disable the specified clipping plane.

virtual void	DisableClippingPlane (int i)=0
	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 vtkContextDevice3D *	SafeDownCast (vtkObjectBase *o)

static vtkContextDevice3D *	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 (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

	vtkContextDevice3D ()

	~vtkContextDevice3D () 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 &)

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Detailed Description

Abstract class for drawing 3D primitives.

This defines the interface for a vtkContextDevice3D. In this sense a ContextDevice is a class used to paint 3D primitives onto a device, such as an OpenGL context.

This is private API, and should not be used outside of the vtkContext3D.

Definition at line 34 of file vtkContextDevice3D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkContextDevice3D::Superclass

Definition at line 37 of file vtkContextDevice3D.h.

Constructor & Destructor Documentation

◆ vtkContextDevice3D()

vtkContextDevice3D::vtkContextDevice3D ( )

protected

◆ ~vtkContextDevice3D()

vtkContextDevice3D::~vtkContextDevice3D ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

Reimplemented in vtkOpenGLContextDevice3D.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkContextDevice3D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkOpenGLContextDevice3D.

◆ NewInstance()

vtkContextDevice3D * vtkContextDevice3D::NewInstance ( ) const

◆ PrintSelf()

void vtkContextDevice3D::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.

Reimplemented in vtkOpenGLContextDevice3D.

◆ New()

static vtkContextDevice3D * vtkContextDevice3D::New ( )

static

◆ DrawPoly()

virtual void vtkContextDevice3D::DrawPoly	(	const float *	verts,
		int	n,
		const unsigned char *	colors = `nullptr`,
		int	nc = `0`
	)

pure virtual

Draw a polyline between the specified points.

See also: DrawLines()

Implemented in vtkOpenGLContextDevice3D.

◆ DrawLines()

virtual void vtkContextDevice3D::DrawLines	(	const float *	verts,
		int	n,
		const unsigned char *	colors = `nullptr`,
		int	nc = `0`
	)

pure virtual

Draw lines defined by specified pair of points.

See also: DrawPoly()

Implemented in vtkOpenGLContextDevice3D.

◆ DrawPoints() [1/2]

virtual void vtkContextDevice3D::DrawPoints	(	const float *	verts,
		int	n,
		const unsigned char *	colors = `nullptr`,
		int	nc = `0`
	)

pure virtual

Draw points at the vertex positions specified.

Implemented in vtkOpenGLContextDevice3D.

◆ DrawPoints() [2/2]

virtual void vtkContextDevice3D::DrawPoints	(	vtkDataArray *	positions,
		vtkUnsignedCharArray *	colors,
		std::uintptr_t	vtkNotUsedcacheIdentifier
	)

virtual

◆ DrawTriangleMesh() [1/2]

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

pure virtual

Draw triangles to generate the specified mesh.

Implemented in vtkOpenGLContextDevice3D.

◆ DrawTriangleMesh() [2/2]

virtual void vtkContextDevice3D::DrawTriangleMesh	(	vtkDataArray *	positions,
		vtkUnsignedCharArray *	colors,
		std::uintptr_t	vtkNotUsedcacheIdentifier
	)

virtual

◆ ApplyPen()

virtual void vtkContextDevice3D::ApplyPen ( vtkPen * pen )

pure virtual

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.

Implemented in vtkOpenGLContextDevice3D.

◆ ApplyBrush()

virtual void vtkContextDevice3D::ApplyBrush ( vtkBrush * brush )

pure virtual

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.

Implemented in vtkOpenGLContextDevice3D.

◆ SetMatrix()

virtual void vtkContextDevice3D::SetMatrix ( vtkMatrix4x4 * m )

pure virtual

Set the model view matrix for the display.

Implemented in vtkOpenGLContextDevice3D.

◆ GetMatrix()

virtual void vtkContextDevice3D::GetMatrix ( vtkMatrix4x4 * m )

pure virtual

Set the model view matrix for the display.

Implemented in vtkOpenGLContextDevice3D.

◆ MultiplyMatrix()

virtual void vtkContextDevice3D::MultiplyMatrix ( vtkMatrix4x4 * m )

pure virtual

Multiply the current model view matrix by the supplied one.

Implemented in vtkOpenGLContextDevice3D.

◆ PushMatrix()

virtual void vtkContextDevice3D::PushMatrix ( )

pure virtual

Push the current matrix onto the stack.

Implemented in vtkOpenGLContextDevice3D.

◆ PopMatrix()

virtual void vtkContextDevice3D::PopMatrix ( )

pure virtual

Pop the current matrix off of the stack.

Implemented in vtkOpenGLContextDevice3D.

◆ SetClipping()

virtual void vtkContextDevice3D::SetClipping ( const vtkRecti & rect )

pure virtual

Supply a float array of length 4 with x1, y1, width, height specifying clipping region for the device in pixels.

Implemented in vtkOpenGLContextDevice3D.

◆ DisableClipping()

virtual void vtkContextDevice3D::DisableClipping ( )

inlinevirtual

Disable clipping of the display.

Remove in a future release - retained for API compatibility.

Definition at line 120 of file vtkContextDevice3D.h.

◆ EnableClipping()

virtual void vtkContextDevice3D::EnableClipping ( bool enable )

pure virtual

Enable or disable the clipping of the scene.

Implemented in vtkOpenGLContextDevice3D.

◆ EnableClippingPlane()

virtual void vtkContextDevice3D::EnableClippingPlane	(	int	i,
		double *	planeEquation
	)

pure virtual

Enable/Disable the specified clipping plane.

Implemented in vtkOpenGLContextDevice3D.

◆ DisableClippingPlane()

virtual void vtkContextDevice3D::DisableClippingPlane ( int i )

pure virtual

Enable/Disable the specified clipping plane.

Implemented in vtkOpenGLContextDevice3D.

◆ ReleaseCache()

virtual void vtkContextDevice3D::ReleaseCache ( std::uintptr_t vtkNotUsedcacheIdentifier )

inlinevirtual

Concrete graphics implementations maintain a cache of heavy-weight buffer objects to achieve higher interactive framerates.

This method requests the devices to release the cached objects for a given cache identifier.

Definition at line 140 of file vtkContextDevice3D.h.

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

Rendering/Context2D/vtkContextDevice3D.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkContextDevice3D()

◆ ~vtkContextDevice3D()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ DrawPoly()

◆ DrawLines()

◆ DrawPoints() [1/2]

◆ DrawPoints() [2/2]

◆ DrawTriangleMesh() [1/2]

◆ DrawTriangleMesh() [2/2]

◆ ApplyPen()

◆ ApplyBrush()

◆ SetMatrix()

◆ GetMatrix()

◆ MultiplyMatrix()

◆ PushMatrix()

◆ PopMatrix()

◆ SetClipping()

◆ DisableClipping()

◆ EnableClipping()

◆ EnableClippingPlane()

◆ DisableClippingPlane()

◆ ReleaseCache()