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

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

#include <vtkContextBufferId.h>

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

Public Types

typedef vtkAbstractContextBufferId Superclass
 
- Public Types inherited from vtkAbstractContextBufferId
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Allocate ()
 
virtual bool IsAllocated () const
 
virtual vtkIdType GetPickedItem (int x, int y)
 
virtual void SetValues (int srcXmin, int srcYmin)
 
- Public Member Functions inherited from vtkAbstractContextBufferId
virtual void ReleaseGraphicsResources ()
 
virtual int GetWidth ()
 
virtual void SetWidth (int)
 
virtual int GetHeight ()
 
virtual void SetHeight (int)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char 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)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(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 &os)
 
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 vtkContextBufferIdSafeDownCast (vtkObject *o)
 
static vtkContextBufferIdNew ()
 
- Static Public Member Functions inherited from vtkAbstractContextBufferId
static int IsTypeOf (const char *type)
 
static vtkAbstractContextBufferIdSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

 vtkContextBufferId ()
 
virtual ~vtkContextBufferId ()
 
int GetValue (vtkIdType i)
 
void SetValue (vtkIdType i, int value)
 
- Protected Member Functions inherited from vtkAbstractContextBufferId
 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 &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkIntArrayIdArray
 
- Protected Attributes inherited from vtkAbstractContextBufferId
int Width
 
int Height
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int 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.

Definition at line 31 of file vtkContextBufferId.h.

Member Typedef Documentation

Definition at line 34 of file vtkContextBufferId.h.

Constructor & Destructor Documentation

vtkContextBufferId::vtkContextBufferId ( )
protected
virtual vtkContextBufferId::~vtkContextBufferId ( )
protectedvirtual

Member Function Documentation

virtual const char* vtkContextBufferId::GetClassName ( )
virtual

Reimplemented from vtkAbstractContextBufferId.

static int vtkContextBufferId::IsTypeOf ( const char *  type)
static
virtual int vtkContextBufferId::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 vtkContextBufferId* vtkContextBufferId::SafeDownCast ( vtkObject o)
static
virtual void vtkContextBufferId::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 vtkContextBufferId* vtkContextBufferId::New ( )
static

Creates a 2D Painter object.

virtual void vtkContextBufferId::Allocate ( )
virtual

Allocate the memory for at least Width*Height elements.

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

Implements vtkAbstractContextBufferId.

virtual bool vtkContextBufferId::IsAllocated ( ) const
virtual

Tell if the buffer has been allocated.

Implements vtkAbstractContextBufferId.

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

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

Precondition
is_allocated: this->IsAllocated()

Implements vtkAbstractContextBufferId.

virtual vtkIdType vtkContextBufferId::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.

void vtkContextBufferId::SetValue ( vtkIdType  i,
int  value 
)
protected

Set the value at index `i'.

Precondition
is_allocated: this->IsAllocated()
valid_i: i>=0 i<this->GetWidth()*this->GetHeight()
Postcondition
is_set: this->GetValue(i)==value
int vtkContextBufferId::GetValue ( vtkIdType  i)
protected

Get the value at index `i'.

Precondition
is_allocated: this->IsAllocated()
valid_i: i>=0 i<this->GetWidth()*this->GetHeight()

Member Data Documentation

vtkIntArray* vtkContextBufferId::IdArray
protected

Definition at line 77 of file vtkContextBufferId.h.


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