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

An adapter between a vtkPainter and a rendering device. More...

#include <vtkOpenGLPainterDeviceAdapter.h>

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

Public Types

typedef vtkPainterDeviceAdapter Superclass
 
- Public Types inherited from vtkPainterDeviceAdapter
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkOpenGLPainterDeviceAdapterNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void BeginPrimitive (int mode)
 Converts mode from VTK_* to GL_* and calls glBegin. More...
 
virtual void EndPrimitive ()
 Calls glEnd. More...
 
virtual int IsAttributesSupported (int attribute)
 Returns if the given attribute type is supported by the device. More...
 
virtual void SendAttribute (int index, int components, int type, const void *attribute, vtkIdType offset=0)
 Calls one of glVertex*, glNormal*, glColor*, or glTexCoord*. More...
 
virtual void SendMultiTextureCoords (int numcomp, int type, const void *attribute, int idx, vtkIdType offset)
 Calls glMultiTex. More...
 
virtual void SetAttributePointer (int index, int numcomponents, int type, int stride, const void *pointer)
 Calls one of glVertexPointer, glNormalPointer, glColorPointer, or glTexCoordPointer. More...
 
virtual void EnableAttributeArray (int index)
 Calls glEnableClientState or glDisableClientState. More...
 
virtual void DisableAttributeArray (int index)
 
virtual void DrawArrays (int mode, vtkIdType first, vtkIdType count)
 Calls glDrawArrays. More...
 
virtual void DrawElements (int mode, vtkIdType count, int type, void *indices)
 Calls glDrawElements. More...
 
virtual int Compatible (vtkRenderer *renderer)
 Returns true if renderer is a vtkOpenGLRenderer. More...
 
virtual void MakeVertexEmphasis (bool mode)
 Turns emphasis of vertices on or off for vertex selection. More...
 
virtual void Stencil (int on)
 Control use of the stencil buffer (for vertex selection). More...
 
virtual void WriteStencil (vtkIdType value)
 
virtual void TestStencil (vtkIdType value)
 
- Public Member Functions inherited from vtkPainterDeviceAdapter
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPainterDeviceAdapterNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void BeginPrimitive (int mode)=0
 Signals the start of sending a primitive to the graphics card. More...
 
virtual void EndPrimitive ()=0
 Signals the end of sending a primitive to the graphics card. More...
 
virtual int IsAttributesSupported (int attribute)=0
 Returns if the given attribute type is supported by the device. More...
 
virtual void SendMultiTextureCoords (int numcomp, int type, const void *attribute, int idx, vtkIdType offset)=0
 Calls glMultiTex. More...
 
virtual void SendAttribute (int index, int components, int type, const void *attribute, vtkIdType offset=0)=0
 Sends a single attribute to the graphics card. More...
 
void SetAttributePointer (int index, vtkDataArray *attributeArray)
 Sets an array of attributes. More...
 
virtual void SetAttributePointer (int index, int numcomponents, int type, int stride, const void *pointer)=0
 Sets an array of attributes. More...
 
virtual void EnableAttributeArray (int index)=0
 Enable/disable the attribute array set with SetAttributePointer. More...
 
virtual void DisableAttributeArray (int index)=0
 
virtual void DrawArrays (int mode, vtkIdType first, vtkIdType count)=0
 Send a section of the enabled attribute pointers to the graphics card to define a primitive. More...
 
virtual void DrawElements (int mode, vtkIdType count, int type, void *indices)=0
 Send items in the attribute pointers to the graphics card to define a primitive. More...
 
virtual int Compatible (vtkRenderer *renderer)=0
 Returns true if this device adapter is compatible with the given vtkRenderer. More...
 
virtual void MakeVertexEmphasis (bool mode)=0
 Turns emphasis of vertices on or off for vertex selection. More...
 
virtual void Stencil (int on)=0
 Control use of the stencil buffer (for vertex selection). More...
 
virtual void WriteStencil (vtkIdType value)=0
 
virtual void TestStencil (vtkIdType value)=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...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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 vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. 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 PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. 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 int IsTypeOf (const char *type)
 
static vtkOpenGLPainterDeviceAdapterSafeDownCast (vtkObjectBase *o)
 
static vtkOpenGLPainterDeviceAdapterNew ()
 
- Static Public Member Functions inherited from vtkPainterDeviceAdapter
static vtkPainterDeviceAdapterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPainterDeviceAdapterSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkOpenGLPainterDeviceAdapter ()
 
 ~vtkOpenGLPainterDeviceAdapter ()
 
- Protected Member Functions inherited from vtkPainterDeviceAdapter
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPainterDeviceAdapter ()
 
 ~vtkPainterDeviceAdapter ()
 
- 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=NULL)
 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 RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double PointSize
 
double RangeNear
 
double RangeFar
 
int MaxStencil
 
bool Initialized
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

An adapter between a vtkPainter and a rendering device.

An adapter between vtkPainter and the OpenGL rendering system. Only a handful of attributes with special meaning are supported. The OpenGL attribute used for each attribute is given below.

* vtkDataSetAttributes::NORMALS          glNormal
* vtkDataSetAttributes:::SCALARS         glColor
* vtkDataSetAttributes::TCOORDS          glTexCoord
* vtkDataSetAttributes::NUM_ATTRIBUTES   glVertex
* 

Definition at line 56 of file vtkOpenGLPainterDeviceAdapter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 60 of file vtkOpenGLPainterDeviceAdapter.h.

Constructor & Destructor Documentation

◆ vtkOpenGLPainterDeviceAdapter()

vtkOpenGLPainterDeviceAdapter::vtkOpenGLPainterDeviceAdapter ( )
protected

◆ ~vtkOpenGLPainterDeviceAdapter()

vtkOpenGLPainterDeviceAdapter::~vtkOpenGLPainterDeviceAdapter ( )
protected

Member Function Documentation

◆ IsTypeOf()

static int vtkOpenGLPainterDeviceAdapter::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkOpenGLPainterDeviceAdapter::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 vtkPainterDeviceAdapter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOpenGLPainterDeviceAdapter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPainterDeviceAdapter.

◆ NewInstance()

vtkOpenGLPainterDeviceAdapter * vtkOpenGLPainterDeviceAdapter::NewInstance ( ) const

◆ New()

static vtkOpenGLPainterDeviceAdapter * vtkOpenGLPainterDeviceAdapter::New ( )
static

◆ PrintSelf()

virtual void vtkOpenGLPainterDeviceAdapter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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

◆ BeginPrimitive()

virtual void vtkOpenGLPainterDeviceAdapter::BeginPrimitive ( int  mode)
virtual

Converts mode from VTK_* to GL_* and calls glBegin.

Implements vtkPainterDeviceAdapter.

◆ EndPrimitive()

virtual void vtkOpenGLPainterDeviceAdapter::EndPrimitive ( )
virtual

Calls glEnd.

Implements vtkPainterDeviceAdapter.

◆ IsAttributesSupported()

virtual int vtkOpenGLPainterDeviceAdapter::IsAttributesSupported ( int  attribute)
virtual

Returns if the given attribute type is supported by the device.

Returns 1 is supported, 0 otherwise.

Implements vtkPainterDeviceAdapter.

◆ SendAttribute()

virtual void vtkOpenGLPainterDeviceAdapter::SendAttribute ( int  index,
int  components,
int  type,
const void *  attribute,
vtkIdType  offset = 0 
)
virtual

Calls one of glVertex*, glNormal*, glColor*, or glTexCoord*.

Implements vtkPainterDeviceAdapter.

◆ SendMultiTextureCoords()

virtual void vtkOpenGLPainterDeviceAdapter::SendMultiTextureCoords ( int  numcomp,
int  type,
const void *  attribute,
int  idx,
vtkIdType  offset 
)
virtual

Calls glMultiTex.

Implements vtkPainterDeviceAdapter.

◆ SetAttributePointer()

virtual void vtkOpenGLPainterDeviceAdapter::SetAttributePointer ( int  index,
int  numcomponents,
int  type,
int  stride,
const void *  pointer 
)
virtual

Calls one of glVertexPointer, glNormalPointer, glColorPointer, or glTexCoordPointer.

Implements vtkPainterDeviceAdapter.

◆ EnableAttributeArray()

virtual void vtkOpenGLPainterDeviceAdapter::EnableAttributeArray ( int  index)
virtual

Calls glEnableClientState or glDisableClientState.

Implements vtkPainterDeviceAdapter.

◆ DisableAttributeArray()

virtual void vtkOpenGLPainterDeviceAdapter::DisableAttributeArray ( int  index)
virtual

◆ DrawArrays()

virtual void vtkOpenGLPainterDeviceAdapter::DrawArrays ( int  mode,
vtkIdType  first,
vtkIdType  count 
)
virtual

Calls glDrawArrays.

Mode is converted from VTK_* to GL_*.

Implements vtkPainterDeviceAdapter.

◆ DrawElements()

virtual void vtkOpenGLPainterDeviceAdapter::DrawElements ( int  mode,
vtkIdType  count,
int  type,
void *  indices 
)
virtual

Calls glDrawElements.

Mode and type are converted from VTK_* to GL_*.

Implements vtkPainterDeviceAdapter.

◆ Compatible()

virtual int vtkOpenGLPainterDeviceAdapter::Compatible ( vtkRenderer renderer)
virtual

Returns true if renderer is a vtkOpenGLRenderer.

Implements vtkPainterDeviceAdapter.

◆ MakeVertexEmphasis()

virtual void vtkOpenGLPainterDeviceAdapter::MakeVertexEmphasis ( bool  mode)
virtual

Turns emphasis of vertices on or off for vertex selection.

When emphasized verts are drawn nearer to the camera and are drawn larger than normal to make selection of them more reliable.

Implements vtkPainterDeviceAdapter.

◆ Stencil()

virtual void vtkOpenGLPainterDeviceAdapter::Stencil ( int  on)
virtual

Control use of the stencil buffer (for vertex selection).

Implements vtkPainterDeviceAdapter.

◆ WriteStencil()

virtual void vtkOpenGLPainterDeviceAdapter::WriteStencil ( vtkIdType  value)
virtual

◆ TestStencil()

virtual void vtkOpenGLPainterDeviceAdapter::TestStencil ( vtkIdType  value)
virtual

Member Data Documentation

◆ PointSize

double vtkOpenGLPainterDeviceAdapter::PointSize
protected

Definition at line 142 of file vtkOpenGLPainterDeviceAdapter.h.

◆ RangeNear

double vtkOpenGLPainterDeviceAdapter::RangeNear
protected

Definition at line 143 of file vtkOpenGLPainterDeviceAdapter.h.

◆ RangeFar

double vtkOpenGLPainterDeviceAdapter::RangeFar
protected

Definition at line 144 of file vtkOpenGLPainterDeviceAdapter.h.

◆ MaxStencil

int vtkOpenGLPainterDeviceAdapter::MaxStencil
protected

Definition at line 145 of file vtkOpenGLPainterDeviceAdapter.h.

◆ Initialized

bool vtkOpenGLPainterDeviceAdapter::Initialized
protected

Definition at line 146 of file vtkOpenGLPainterDeviceAdapter.h.


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