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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAbstractContextBufferId *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual bool	IsSupported ()=0

virtual void	Allocate ()=0

virtual bool	IsAllocated () const =0

virtual vtkIdType	GetPickedItem (int x, int y)=0

virtual void	ReleaseGraphicsResources ()


virtual int	GetWidth ()


virtual void	SetWidth (int)


virtual int	GetHeight ()


virtual void	SetHeight (int)


virtual void	SetContext (vtkRenderWindow *context)=0

virtual vtkRenderWindow *	GetContext ()=0


virtual void	SetValues (int srcXmin, int srcYmin)=0

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

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

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkAbstractContextBufferId *	SafeDownCast (vtkObjectBase *o)

static vtkAbstractContextBufferId *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractContextBufferId ()

virtual	~vtkAbstractContextBufferId ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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
vtkAtomicInt32	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 45 of file vtkAbstractContextBufferId.h.

Member Typedef Documentation

typedef vtkObject vtkAbstractContextBufferId::Superclass

Definition at line 48 of file vtkAbstractContextBufferId.h.

Constructor & Destructor Documentation

vtkAbstractContextBufferId::vtkAbstractContextBufferId ( )

protected

virtual vtkAbstractContextBufferId::~vtkAbstractContextBufferId ( )

protectedvirtual

Member Function Documentation

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

static

virtual int 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 vtkObject.

Reimplemented in vtkOpenGLContextBufferId, and vtkOpenGLContextBufferId.

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

static

virtual vtkObjectBase* vtkAbstractContextBufferId::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkOpenGLContextBufferId, and vtkOpenGLContextBufferId.

vtkAbstractContextBufferId* vtkAbstractContextBufferId::NewInstance ( ) const

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

Reimplemented in vtkOpenGLContextBufferId, and vtkOpenGLContextBufferId.

static vtkAbstractContextBufferId* vtkAbstractContextBufferId::New ( )

static

virtual int vtkAbstractContextBufferId::GetWidth ( )

virtual

Number of columns. Initial value is 0.

virtual void vtkAbstractContextBufferId::SetWidth ( int )

virtual

Set the number of columns. Initial value is 0.

virtual int vtkAbstractContextBufferId::GetHeight ( )

virtual

Number of rows. Initial value is 0.

virtual void vtkAbstractContextBufferId::SetHeight ( int )

virtual

Set the number of rows. Initial value is 0.

virtual void vtkAbstractContextBufferId::SetContext ( vtkRenderWindow * context )

pure virtual

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

Implemented in vtkOpenGLContextBufferId, and vtkOpenGLContextBufferId.

virtual vtkRenderWindow* vtkAbstractContextBufferId::GetContext ( )

pure virtual

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

Implemented in vtkOpenGLContextBufferId, and vtkOpenGLContextBufferId.

virtual bool vtkAbstractContextBufferId::IsSupported ( )

pure virtual

Returns if the context supports the required extensions.

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

Implemented in vtkOpenGLContextBufferId, and vtkOpenGLContextBufferId.

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, and vtkOpenGLContextBufferId.

virtual bool vtkAbstractContextBufferId::IsAllocated ( ) const

pure virtual

Tell if the buffer has been allocated.

Implemented in vtkOpenGLContextBufferId, and vtkOpenGLContextBufferId.

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, and vtkOpenGLContextBufferId.

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.