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

2D array of ids stored in VRAM. More...

#include <vtkOpenGLContextBufferId.h>

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

Public Types

typedef vtkAbstractContextBufferId Superclass
 
typedef vtkAbstractContextBufferId Superclass
 
- Public Types inherited from vtkAbstractContextBufferId
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...
 
vtkOpenGLContextBufferIdNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void ReleaseGraphicsResources ()
 Release any graphics resources that are being consumed by this object. More...
 
virtual bool IsSupported ()
 Returns if the context supports the required extensions. More...
 
virtual void Allocate ()
 Allocate the memory for at least Width*Height elements. More...
 
virtual bool IsAllocated () const
 Tell if the buffer has been allocated. More...
 
virtual void SetValues (int srcXmin, int srcYmin)
 Copy the contents of the current read buffer to the internal texture starting at lower left corner of the framebuffer (srcXmin,srcYmin). More...
 
virtual vtkIdType GetPickedItem (int x, int y)
 Return item under abscissa x and ordinate y. More...
 
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkOpenGLContextBufferIdNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void ReleaseGraphicsResources ()
 Release any graphics resources that are being consumed by this object. More...
 
virtual bool IsSupported ()
 Returns if the context supports the required extensions. More...
 
virtual void Allocate ()
 Allocate the memory for at least Width*Height elements. More...
 
virtual bool IsAllocated () const
 Tell if the buffer has been allocated. More...
 
virtual void SetValues (int srcXmin, int srcYmin)
 Copy the contents of the current read buffer to the internal texture starting at lower left corner of the framebuffer (srcXmin,srcYmin). More...
 
virtual vtkIdType GetPickedItem (int x, int y)
 Return item under abscissa x and ordinate y. More...
 
virtual void SetContext (vtkRenderWindow *context)
 Set/Get the OpenGL context owning the texture object resource. More...
 
virtual vtkRenderWindowGetContext ()
 Set/Get the OpenGL context owning the texture object resource. More...
 
virtual void SetContext (vtkRenderWindow *context)
 Set/Get the OpenGL context owning the texture object resource. More...
 
virtual vtkRenderWindowGetContext ()
 Set/Get the OpenGL context owning the texture object resource. More...
 
- Public Member Functions inherited from vtkAbstractContextBufferId
vtkAbstractContextBufferIdNewInstance () const
 
virtual int GetWidth ()
 Number of columns. More...
 
virtual void SetWidth (int)
 Set the number of columns. More...
 
virtual int GetHeight ()
 Number of rows. More...
 
virtual void SetHeight (int)
 Set the number of rows. 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkOpenGLContextBufferIdSafeDownCast (vtkObjectBase *o)
 
static vtkOpenGLContextBufferIdNew ()
 Creates a 2D Painter object. More...
 
static int IsTypeOf (const char *type)
 
static vtkOpenGLContextBufferIdSafeDownCast (vtkObjectBase *o)
 
static vtkOpenGLContextBufferIdNew ()
 Creates a 2D Painter object. More...
 
- Static Public Member Functions inherited from vtkAbstractContextBufferId
static int IsTypeOf (const char *type)
 
static vtkAbstractContextBufferIdSafeDownCast (vtkObjectBase *o)
 
static vtkAbstractContextBufferIdNew ()
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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
 
 vtkOpenGLContextBufferId ()
 
virtual ~vtkOpenGLContextBufferId ()
 
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenGLContextBufferId ()
 
virtual ~vtkOpenGLContextBufferId ()
 
- Protected Member Functions inherited from vtkAbstractContextBufferId
 vtkAbstractContextBufferId ()
 
virtual ~vtkAbstractContextBufferId ()
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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

vtkOpenGLRenderWindowContext
 
vtkTextureObjectTexture
 
- Protected Attributes inherited from vtkAbstractContextBufferId
int Width
 
int Height
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

2D array of ids stored in VRAM.

An 2D array where each element is the id of an entity drawn at the given pixel.

Definition at line 34 of file vtkOpenGLContextBufferId.h.

Member Typedef Documentation

Definition at line 37 of file vtkOpenGLContextBufferId.h.

Definition at line 37 of file vtkOpenGLContextBufferId.h.

Constructor & Destructor Documentation

vtkOpenGLContextBufferId::vtkOpenGLContextBufferId ( )
protected
virtual vtkOpenGLContextBufferId::~vtkOpenGLContextBufferId ( )
protectedvirtual
vtkOpenGLContextBufferId::vtkOpenGLContextBufferId ( )
protected
virtual vtkOpenGLContextBufferId::~vtkOpenGLContextBufferId ( )
protectedvirtual

Member Function Documentation

static int vtkOpenGLContextBufferId::IsTypeOf ( const char *  type)
static
virtual int vtkOpenGLContextBufferId::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 vtkAbstractContextBufferId.

static vtkOpenGLContextBufferId* vtkOpenGLContextBufferId::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkOpenGLContextBufferId::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractContextBufferId.

vtkOpenGLContextBufferId* vtkOpenGLContextBufferId::NewInstance ( ) const
virtual void vtkOpenGLContextBufferId::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 vtkAbstractContextBufferId.

static vtkOpenGLContextBufferId* vtkOpenGLContextBufferId::New ( )
static

Creates a 2D Painter object.

virtual void vtkOpenGLContextBufferId::ReleaseGraphicsResources ( )
virtual

Release any graphics resources that are being consumed by this object.

Reimplemented from vtkAbstractContextBufferId.

virtual void vtkOpenGLContextBufferId::SetContext ( vtkRenderWindow context)
virtual

Set/Get the OpenGL context owning the texture object resource.

Implements vtkAbstractContextBufferId.

virtual vtkRenderWindow* vtkOpenGLContextBufferId::GetContext ( )
virtual

Set/Get the OpenGL context owning the texture object resource.

Implements vtkAbstractContextBufferId.

virtual bool vtkOpenGLContextBufferId::IsSupported ( )
virtual

Returns if the context supports the required extensions.

Precondition
context_is_set: this->GetContext()!=0

Implements vtkAbstractContextBufferId.

virtual void vtkOpenGLContextBufferId::Allocate ( )
virtual

Allocate the memory for at least Width*Height elements.

Precondition
positive_width: GetWidth()>0
positive_height: GetHeight()>0
context_is_set: this->GetContext()!=0

Implements vtkAbstractContextBufferId.

virtual bool vtkOpenGLContextBufferId::IsAllocated ( ) const
virtual

Tell if the buffer has been allocated.

Implements vtkAbstractContextBufferId.

virtual void vtkOpenGLContextBufferId::SetValues ( int  srcXmin,
int  srcYmin 
)
virtual

Copy the contents of the current read buffer to the internal texture starting at lower left corner of the framebuffer (srcXmin,srcYmin).

Precondition
is_allocated: this->IsAllocated()

Implements vtkAbstractContextBufferId.

virtual vtkIdType vtkOpenGLContextBufferId::GetPickedItem ( int  x,
int  y 
)
virtual

Return item under abscissa x and ordinate y.

Abscissa go from left to right. Ordinate go from bottom to top. The return value is -1 if there is no item.

Precondition
is_allocated: IsAllocated()
Postcondition
valid_result: result>=-1

Implements vtkAbstractContextBufferId.

static int vtkOpenGLContextBufferId::IsTypeOf ( const char *  type)
static
virtual int vtkOpenGLContextBufferId::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 vtkAbstractContextBufferId.

static vtkOpenGLContextBufferId* vtkOpenGLContextBufferId::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkOpenGLContextBufferId::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractContextBufferId.

vtkOpenGLContextBufferId* vtkOpenGLContextBufferId::NewInstance ( ) const
virtual void vtkOpenGLContextBufferId::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 vtkAbstractContextBufferId.

static vtkOpenGLContextBufferId* vtkOpenGLContextBufferId::New ( )
static

Creates a 2D Painter object.

virtual void vtkOpenGLContextBufferId::ReleaseGraphicsResources ( )
virtual

Release any graphics resources that are being consumed by this object.

Reimplemented from vtkAbstractContextBufferId.

virtual void vtkOpenGLContextBufferId::SetContext ( vtkRenderWindow context)
virtual

Set/Get the OpenGL context owning the texture object resource.

Implements vtkAbstractContextBufferId.

virtual vtkRenderWindow* vtkOpenGLContextBufferId::GetContext ( )
virtual

Set/Get the OpenGL context owning the texture object resource.

Implements vtkAbstractContextBufferId.

virtual bool vtkOpenGLContextBufferId::IsSupported ( )
virtual

Returns if the context supports the required extensions.

Precondition
context_is_set: this->GetContext()!=0

Implements vtkAbstractContextBufferId.

virtual void vtkOpenGLContextBufferId::Allocate ( )
virtual

Allocate the memory for at least Width*Height elements.

Precondition
positive_width: GetWidth()>0
positive_height: GetHeight()>0
context_is_set: this->GetContext()!=0

Implements vtkAbstractContextBufferId.

virtual bool vtkOpenGLContextBufferId::IsAllocated ( ) const
virtual

Tell if the buffer has been allocated.

Implements vtkAbstractContextBufferId.

virtual void vtkOpenGLContextBufferId::SetValues ( int  srcXmin,
int  srcYmin 
)
virtual

Copy the contents of the current read buffer to the internal texture starting at lower left corner of the framebuffer (srcXmin,srcYmin).

Precondition
is_allocated: this->IsAllocated()

Implements vtkAbstractContextBufferId.

virtual vtkIdType vtkOpenGLContextBufferId::GetPickedItem ( int  x,
int  y 
)
virtual

Return item under abscissa x and ordinate y.

Abscissa go from left to right. Ordinate go from bottom to top. The return value is -1 if there is no item.

Precondition
is_allocated: IsAllocated()
Postcondition
valid_result: result>=-1

Implements vtkAbstractContextBufferId.

Member Data Documentation

vtkOpenGLRenderWindow * vtkOpenGLContextBufferId::Context
protected

Definition at line 99 of file vtkOpenGLContextBufferId.h.

vtkTextureObject * vtkOpenGLContextBufferId::Texture
protected

Definition at line 100 of file vtkOpenGLContextBufferId.h.


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