VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkContext3D Class Reference

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

#include <vtkContext3D.h>

Inheritance diagram for vtkContext3D:
[legend]
Collaboration diagram for vtkContext3D:
[legend]

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. More...
 
vtkContext3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool Begin (vtkContextDevice3D *device)
 Begin painting on a vtkContextDevice3D, no painting can occur before this call has been made. More...
 
vtkContextDevice3DGetDevice ()
 Get access to the underlying 3D context. More...
 
bool End ()
 Ends painting on the device, you would not usually need to call this as it should be called by the destructor. More...
 
void DrawLine (const vtkVector3f &start, const vtkVector3f &end)
 Draw a line between the specified points. More...
 
void DrawPoly (const float *points, int n)
 Draw a poly line between the specified points. More...
 
void DrawPoint (const vtkVector3f &point)
 Draw a point at the point in 3D space. More...
 
void DrawPoints (const float *points, int n)
 Draw a sequence of points at the specified locations. More...
 
void DrawPoints (const float *points, int n, unsigned char *colors, int nc_comps)
 Draw a sequence of points at the specified locations. More...
 
void DrawTriangleMesh (const float *mesh, int n, const unsigned char *colors, int nc)
 Draw triangles to generate the specified mesh. More...
 
void ApplyPen (vtkPen *pen)
 Apply the supplied pen which controls the outlines of shapes, as well as lines, points and related primitives. More...
 
void ApplyBrush (vtkBrush *brush)
 Apply the supplied brush which controls the outlines of shapes, as well as lines, points and related primitives. More...
 
void SetTransform (vtkTransform *transform)
 Set the transform for the context, the underlying device will use the matrix of the transform. More...
 
vtkTransformGetTransform ()
 Compute the current transform applied to the context. More...
 
void AppendTransform (vtkTransform *transform)
 Append the transform for the context, the underlying device will use the matrix of the transform. More...
 
void PushMatrix ()
 Push/pop the transformation matrix for the painter (sets the underlying matrix for the device when available). More...
 
void PopMatrix ()
 
void EnableClippingPlane (int i, double *planeEquation)
 Enable/Disable the specified clipping plane. More...
 
void DisableClippingPlane (int i)
 
- 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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkContext3DSafeDownCast (vtkObjectBase *o)
 
static vtkContext3DNew ()
 Creates a 3D context object. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. 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 &)
 

Protected Attributes

vtkSmartPointer< vtkContextDevice3DDevice
 
vtkSmartPointer< vtkTransformTransform
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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 40 of file vtkContext3D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 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 vtkObject.

◆ 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/2]

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

Draw a sequence of points at the specified locations.

◆ DrawPoints() [2/2]

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

◆ DrawTriangleMesh()

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

Draw triangles to generate the specified mesh.

◆ 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 ( )

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

Member Data Documentation

◆ Device

vtkSmartPointer<vtkContextDevice3D> vtkContext3D::Device
protected

Definition at line 161 of file vtkContext3D.h.

◆ Transform

vtkSmartPointer<vtkTransform> vtkContext3D::Transform
protected

Definition at line 162 of file vtkContext3D.h.


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