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

2D array of ids, used for picking. More...

#include <vtkAbstractContextBufferId.h>

Inheritance diagram for vtkAbstractContextBufferId:
[legend]
Collaboration diagram for vtkAbstractContextBufferId:
[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...
 
vtkAbstractContextBufferIdNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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...
 
virtual void SetContext (vtkRenderWindow *context)=0
 Set/Get the OpenGL context owning the texture object resource. More...
 
virtual vtkRenderWindowGetContext ()=0
 
virtual bool IsSupported ()=0
 Returns if the context supports the required extensions. More...
 
virtual void Allocate ()=0
 Allocate the memory for at least Width*Height elements. More...
 
virtual bool IsAllocated () const =0
 Tell if the buffer has been allocated. More...
 
virtual void SetValues (int srcXmin, int srcYmin)=0
 Copy the contents of the current read buffer to the internal structure starting at lower left corner of the framebuffer (srcXmin,srcYmin). More...
 
virtual vtkIdType GetPickedItem (int x, int y)=0
 Return item under abscissa x and ordinate y. More...
 
virtual void ReleaseGraphicsResources ()
 Release any graphics resources that are being consumed by this object. 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 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 ()
 
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
 
 vtkAbstractContextBufferId ()
 
 ~vtkAbstractContextBufferId () 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

int Width
 
int Height
 
- 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

2D array of ids, used for picking.

An 2D array where each element is the id of an entity drawn at the given pixel. The access is not specified in this class. The effective/concrete subclass vtkContextBufferId stores the whole buffer in RAM. The access to a value is fast and independent of the OpenGL. However it requires to first fill the whole buffer by transferring the buffer generated by OpenGL from the VRAM to the RAM. It is inefficient if the context of the scene changes during interaction.

The effective/concrete subclass vtkOpenGLContextBufferId keeps the buffer id on the VRAM in a texture image. The access to a value is slower than a simple read access to an array but it does not require a large transfer of data from the VRAM to the RAM.

See also
vtkContextBufferId, vtkOpenGLContextBufferId

Definition at line 46 of file vtkAbstractContextBufferId.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkAbstractContextBufferId.h.

Constructor & Destructor Documentation

◆ vtkAbstractContextBufferId()

vtkAbstractContextBufferId::vtkAbstractContextBufferId ( )
protected

◆ ~vtkAbstractContextBufferId()

vtkAbstractContextBufferId::~vtkAbstractContextBufferId ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAbstractContextBufferId::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 vtkOpenGLContextBufferId.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractContextBufferId::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkOpenGLContextBufferId.

◆ NewInstance()

vtkAbstractContextBufferId* vtkAbstractContextBufferId::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractContextBufferId::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 vtkOpenGLContextBufferId.

◆ New()

static vtkAbstractContextBufferId* vtkAbstractContextBufferId::New ( )
static

◆ GetWidth()

virtual int vtkAbstractContextBufferId::GetWidth ( )
virtual

Number of columns.

Initial value is 0.

◆ SetWidth()

virtual void vtkAbstractContextBufferId::SetWidth ( int  )
virtual

Set the number of columns.

Initial value is 0.

◆ GetHeight()

virtual int vtkAbstractContextBufferId::GetHeight ( )
virtual

Number of rows.

Initial value is 0.

◆ SetHeight()

virtual void vtkAbstractContextBufferId::SetHeight ( int  )
virtual

Set the number of rows.

Initial value is 0.

◆ SetContext()

virtual void vtkAbstractContextBufferId::SetContext ( vtkRenderWindow context)
pure virtual

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

Implemented in vtkOpenGLContextBufferId.

◆ GetContext()

virtual vtkRenderWindow* vtkAbstractContextBufferId::GetContext ( )
pure virtual

Implemented in vtkOpenGLContextBufferId.

◆ IsSupported()

virtual bool vtkAbstractContextBufferId::IsSupported ( )
pure virtual

Returns if the context supports the required extensions.

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

Implemented in vtkOpenGLContextBufferId.

◆ Allocate()

virtual void vtkAbstractContextBufferId::Allocate ( )
pure virtual

Allocate the memory for at least Width*Height elements.

Precondition
positive_width: GetWidth()>0
positive_height: GetHeight()>0

Implemented in vtkOpenGLContextBufferId.

◆ IsAllocated()

virtual bool vtkAbstractContextBufferId::IsAllocated ( ) const
pure virtual

Tell if the buffer has been allocated.

Implemented in vtkOpenGLContextBufferId.

◆ SetValues()

virtual void vtkAbstractContextBufferId::SetValues ( int  srcXmin,
int  srcYmin 
)
pure virtual

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

Precondition
is_allocated: this->IsAllocated()

Implemented in vtkOpenGLContextBufferId.

◆ GetPickedItem()

virtual vtkIdType vtkAbstractContextBufferId::GetPickedItem ( int  x,
int  y 
)
pure 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

Implemented in vtkOpenGLContextBufferId.

◆ ReleaseGraphicsResources()

virtual void vtkAbstractContextBufferId::ReleaseGraphicsResources ( )
virtual

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

Default implementation is empty.

Reimplemented in vtkOpenGLContextBufferId.

Member Data Documentation

◆ Width

int vtkAbstractContextBufferId::Width
protected

Definition at line 135 of file vtkAbstractContextBufferId.h.

◆ Height

int vtkAbstractContextBufferId::Height
protected

Definition at line 136 of file vtkAbstractContextBufferId.h.


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