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

OpenGL class drawing 3D primitives. More...

#include <vtkOpenGLContextDevice3D.h>

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

Public Types

typedef vtkContextDevice3D Superclass
 
- Public Types inherited from vtkContextDevice3D
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...
 
vtkOpenGLContextDevice3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void DrawPoly (const float *verts, int n, const unsigned char *colors, int nc) override
 Draw a polyline between the specified points. More...
 
void DrawLines (const float *verts, int n, const unsigned char *colors, int nc) override
 Draw lines defined by specified pair of points. More...
 
void DrawPoints (const float *verts, int n, const unsigned char *colors, int nc) override
 Draw points at the vertex positions specified. More...
 
void DrawTriangleMesh (const float *mesh, int n, const unsigned char *colors, int nc) override
 Draw triangles to generate the specified mesh. More...
 
void ApplyPen (vtkPen *pen) override
 Apply the supplied pen which controls the outlines of shapes, as well as lines, points and related primitives. More...
 
void ApplyBrush (vtkBrush *brush) override
 Apply the supplied brush which controls the outlines of shapes, as well as lines, points and related primitives. More...
 
void SetMatrix (vtkMatrix4x4 *m) override
 Set the model view matrix for the display. More...
 
void GetMatrix (vtkMatrix4x4 *m) override
 Set the model view matrix for the display. More...
 
void MultiplyMatrix (vtkMatrix4x4 *m) override
 Multiply the current model view matrix by the supplied one. More...
 
void PushMatrix () override
 Push the current matrix onto the stack. More...
 
void PopMatrix () override
 Pop the current matrix off of the stack. More...
 
void SetClipping (const vtkRecti &rect) override
 Supply a float array of length 4 with x1, y1, width, height specifying clipping region for the device in pixels. More...
 
void EnableClipping (bool enable) override
 Enable or disable the clipping of the scene. More...
 
void EnableClippingPlane (int i, double *planeEquation) override
 Enable/Disable the specified clipping plane. More...
 
void DisableClippingPlane (int i) override
 
void Initialize (vtkRenderer *, vtkOpenGLContextDevice2D *)
 This must be set during initialization. More...
 
virtual void Begin (vtkViewport *viewport)
 Begin drawing, pass in the viewport to set up the view. More...
 
- Public Member Functions inherited from vtkContextDevice3D
vtkContextDevice3DNewInstance () const
 
virtual void DisableClipping ()
 Disable clipping of the display. More...
 
- 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 vtkOpenGLContextDevice3DSafeDownCast (vtkObjectBase *o)
 
static vtkOpenGLContextDevice3DNew ()
 
- Static Public Member Functions inherited from vtkContextDevice3D
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
 
 vtkOpenGLContextDevice3D ()
 
 ~vtkOpenGLContextDevice3D () override
 
virtual void EnableDepthBuffer ()
 Begin drawing, turn on the depth buffer. More...
 
virtual void DisableDepthBuffer ()
 End drawing, turn off the depth buffer. More...
 
void ReadyVCBOProgram ()
 
void ReadyVBOProgram ()
 
void SetMatrices (vtkShaderProgram *prog)
 
void BuildVBO (vtkOpenGLHelper *cbo, const float *v, int nv, const unsigned char *coolors, int nc, float *tcoords)
 
void CoreDrawTriangles (std::vector< float > &tverts)
 
virtual bool HaveWideLines ()
 
- Protected Member Functions inherited from vtkContextDevice3D
 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 &)
 

Protected Attributes

vtkOpenGLHelperVCBO
 
vtkOpenGLHelperVBO
 
vtkTransformModelMatrix
 
vtkOpenGLRenderWindowRenderWindow
 The OpenGL render window being used by the device. More...
 
vtkRendererRenderer
 We need to store a pointer to get the camera mats. More...
 
std::vector< bool > ClippingPlaneStates
 
std::vector< doubleClippingPlaneValues
 
- 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

OpenGL class drawing 3D primitives.

This defines the implementation of a 3D context device for drawing simple primitives.

Definition at line 42 of file vtkOpenGLContextDevice3D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkOpenGLContextDevice3D.h.

Constructor & Destructor Documentation

◆ vtkOpenGLContextDevice3D()

vtkOpenGLContextDevice3D::vtkOpenGLContextDevice3D ( )
protected

◆ ~vtkOpenGLContextDevice3D()

vtkOpenGLContextDevice3D::~vtkOpenGLContextDevice3D ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLContextDevice3D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContextDevice3D.

◆ NewInstance()

vtkOpenGLContextDevice3D* vtkOpenGLContextDevice3D::NewInstance ( ) const

◆ PrintSelf()

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

◆ New()

static vtkOpenGLContextDevice3D* vtkOpenGLContextDevice3D::New ( )
static

◆ DrawPoly()

void vtkOpenGLContextDevice3D::DrawPoly ( const float verts,
int  n,
const unsigned char *  colors,
int  nc 
)
overridevirtual

Draw a polyline between the specified points.

Implements vtkContextDevice3D.

◆ DrawLines()

void vtkOpenGLContextDevice3D::DrawLines ( const float verts,
int  n,
const unsigned char *  colors,
int  nc 
)
overridevirtual

Draw lines defined by specified pair of points.

See also
DrawPoly()

Implements vtkContextDevice3D.

◆ DrawPoints()

void vtkOpenGLContextDevice3D::DrawPoints ( const float verts,
int  n,
const unsigned char *  colors,
int  nc 
)
overridevirtual

Draw points at the vertex positions specified.

Implements vtkContextDevice3D.

◆ DrawTriangleMesh()

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

Draw triangles to generate the specified mesh.

Implements vtkContextDevice3D.

◆ ApplyPen()

void vtkOpenGLContextDevice3D::ApplyPen ( vtkPen pen)
overridevirtual

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.

Implements vtkContextDevice3D.

◆ ApplyBrush()

void vtkOpenGLContextDevice3D::ApplyBrush ( vtkBrush brush)
overridevirtual

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.

Implements vtkContextDevice3D.

◆ SetMatrix()

void vtkOpenGLContextDevice3D::SetMatrix ( vtkMatrix4x4 m)
overridevirtual

Set the model view matrix for the display.

Implements vtkContextDevice3D.

◆ GetMatrix()

void vtkOpenGLContextDevice3D::GetMatrix ( vtkMatrix4x4 m)
overridevirtual

Set the model view matrix for the display.

Implements vtkContextDevice3D.

◆ MultiplyMatrix()

void vtkOpenGLContextDevice3D::MultiplyMatrix ( vtkMatrix4x4 m)
overridevirtual

Multiply the current model view matrix by the supplied one.

Implements vtkContextDevice3D.

◆ PushMatrix()

void vtkOpenGLContextDevice3D::PushMatrix ( )
overridevirtual

Push the current matrix onto the stack.

Implements vtkContextDevice3D.

◆ PopMatrix()

void vtkOpenGLContextDevice3D::PopMatrix ( )
overridevirtual

Pop the current matrix off of the stack.

Implements vtkContextDevice3D.

◆ SetClipping()

void vtkOpenGLContextDevice3D::SetClipping ( const vtkRecti rect)
overridevirtual

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

Implements vtkContextDevice3D.

◆ EnableClipping()

void vtkOpenGLContextDevice3D::EnableClipping ( bool  enable)
overridevirtual

Enable or disable the clipping of the scene.

Implements vtkContextDevice3D.

◆ EnableClippingPlane()

void vtkOpenGLContextDevice3D::EnableClippingPlane ( int  i,
double planeEquation 
)
overridevirtual

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.

Implements vtkContextDevice3D.

◆ DisableClippingPlane()

void vtkOpenGLContextDevice3D::DisableClippingPlane ( int  i)
overridevirtual

Implements vtkContextDevice3D.

◆ Initialize()

void vtkOpenGLContextDevice3D::Initialize ( vtkRenderer ,
vtkOpenGLContextDevice2D  
)

This must be set during initialization.

◆ Begin()

virtual void vtkOpenGLContextDevice3D::Begin ( vtkViewport viewport)
virtual

Begin drawing, pass in the viewport to set up the view.

◆ EnableDepthBuffer()

virtual void vtkOpenGLContextDevice3D::EnableDepthBuffer ( )
protectedvirtual

Begin drawing, turn on the depth buffer.

◆ DisableDepthBuffer()

virtual void vtkOpenGLContextDevice3D::DisableDepthBuffer ( )
protectedvirtual

End drawing, turn off the depth buffer.

◆ ReadyVCBOProgram()

void vtkOpenGLContextDevice3D::ReadyVCBOProgram ( )
protected

◆ ReadyVBOProgram()

void vtkOpenGLContextDevice3D::ReadyVBOProgram ( )
protected

◆ SetMatrices()

void vtkOpenGLContextDevice3D::SetMatrices ( vtkShaderProgram prog)
protected

◆ BuildVBO()

void vtkOpenGLContextDevice3D::BuildVBO ( vtkOpenGLHelper cbo,
const float v,
int  nv,
const unsigned char *  coolors,
int  nc,
float tcoords 
)
protected

◆ CoreDrawTriangles()

void vtkOpenGLContextDevice3D::CoreDrawTriangles ( std::vector< float > &  tverts)
protected

◆ HaveWideLines()

virtual bool vtkOpenGLContextDevice3D::HaveWideLines ( )
protectedvirtual

Member Data Documentation

◆ VCBO

vtkOpenGLHelper* vtkOpenGLContextDevice3D::VCBO
protected

Definition at line 159 of file vtkOpenGLContextDevice3D.h.

◆ VBO

vtkOpenGLHelper* vtkOpenGLContextDevice3D::VBO
protected

Definition at line 161 of file vtkOpenGLContextDevice3D.h.

◆ ModelMatrix

vtkTransform* vtkOpenGLContextDevice3D::ModelMatrix
protected

Definition at line 174 of file vtkOpenGLContextDevice3D.h.

◆ RenderWindow

vtkOpenGLRenderWindow* vtkOpenGLContextDevice3D::RenderWindow
protected

The OpenGL render window being used by the device.

Definition at line 179 of file vtkOpenGLContextDevice3D.h.

◆ Renderer

vtkRenderer* vtkOpenGLContextDevice3D::Renderer
protected

We need to store a pointer to get the camera mats.

Definition at line 184 of file vtkOpenGLContextDevice3D.h.

◆ ClippingPlaneStates

std::vector<bool> vtkOpenGLContextDevice3D::ClippingPlaneStates
protected

Definition at line 186 of file vtkOpenGLContextDevice3D.h.

◆ ClippingPlaneValues

std::vector<double> vtkOpenGLContextDevice3D::ClippingPlaneValues
protected

Definition at line 187 of file vtkOpenGLContextDevice3D.h.


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