VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkContextDevice3D Class Referenceabstract

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

#include <vtkContextDevice3D.h>

Inheritance diagram for vtkContextDevice3D:
[legend]
Collaboration diagram for vtkContextDevice3D:
[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...
 
vtkContextDevice3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void DrawPoly (const float *verts, int n, const unsigned char *colors=nullptr, int nc=0)=0
 Draw a polyline between the specified points. More...
 
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. More...
 
virtual void DrawPoints (const float *verts, int n, const unsigned char *colors=nullptr, int nc=0)=0
 Draw points at the vertex positions specified. More...
 
virtual void DrawTriangleMesh (const float *mesh, int n, const unsigned char *colors, int nc)=0
 Draw triangles to generate the specified mesh. More...
 
virtual void ApplyPen (vtkPen *pen)=0
 Apply the supplied pen which controls the outlines of shapes, as well as lines, points and related primitives. More...
 
virtual void ApplyBrush (vtkBrush *brush)=0
 Apply the supplied brush which controls the outlines of shapes, as well as lines, points and related primitives. More...
 
virtual void SetMatrix (vtkMatrix4x4 *m)=0
 Set the model view matrix for the display. More...
 
virtual void GetMatrix (vtkMatrix4x4 *m)=0
 Set the model view matrix for the display. More...
 
virtual void MultiplyMatrix (vtkMatrix4x4 *m)=0
 Multiply the current model view matrix by the supplied one. More...
 
virtual void PushMatrix ()=0
 Push the current matrix onto the stack. More...
 
virtual void PopMatrix ()=0
 Pop the current matrix off of the stack. More...
 
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. More...
 
virtual void DisableClipping ()
 Disable clipping of the display. More...
 
virtual void EnableClipping (bool enable)=0
 Enable or disable the clipping of the scene. More...
 
virtual void EnableClippingPlane (int i, double *planeEquation)=0
 Enable/Disable the specified clipping plane. More...
 
virtual void DisableClippingPlane (int i)=0
 
- 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 vtkContextDevice3DSafeDownCast (vtkObjectBase *o)
 
static vtkContextDevice3DNew ()
 
- 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
 
 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. 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 &)
 

Additional Inherited Members

- 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

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 41 of file vtkContextDevice3D.h.

Member Typedef Documentation

◆ Superclass

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

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

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.

◆ DrawTriangleMesh()

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.

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

Implemented in vtkOpenGLContextDevice3D.


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