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

#include <vtkAbstractContextBufferId.h>

Inheritance diagram for vtkAbstractContextBufferId:

Collaboration diagram for vtkAbstractContextBufferId:

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

vtkAbstractContextBufferId *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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


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 vtkRenderWindow *	GetContext ()=0
	Set/Get the OpenGL context owning the texture object resource. 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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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)

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

vtkCommand *	GetCommand (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...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and 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	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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractContextBufferId *	SafeDownCast (vtkObjectBase *o)

static vtkAbstractContextBufferId *	New ()

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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 ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

typedef vtkObject vtkAbstractContextBufferId::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

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

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:

Rendering/Context2D/vtkAbstractContextBufferId.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAbstractContextBufferId()

◆ ~vtkAbstractContextBufferId()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ GetWidth()

◆ SetWidth()

◆ GetHeight()

◆ SetHeight()

◆ SetContext()

◆ GetContext()

◆ IsSupported()

◆ Allocate()

◆ IsAllocated()

◆ SetValues()

◆ GetPickedItem()

◆ ReleaseGraphicsResources()

Member Data Documentation

◆ Width

◆ Height