vtkContextBufferId Class Reference

#include <vtkContextBufferId.h>

Inheritance diagram for vtkContextBufferId:

Inheritance graph
[legend]
Collaboration diagram for vtkContextBufferId:

Collaboration graph
[legend]

List of all members.


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.


Public Types

typedef vtkAbstractContextBufferId 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)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkContextBufferIdSafeDownCast (vtkObject *o)
static vtkContextBufferIdNew ()

Protected Member Functions

 vtkContextBufferId ()
virtual ~vtkContextBufferId ()
int GetValue (vtkIdType i)
void SetValue (vtkIdType i, int value)

Protected Attributes

vtkIntArrayIdArray

Member Typedef Documentation

Reimplemented from vtkAbstractContextBufferId.

Definition at line 34 of file vtkContextBufferId.h.


Constructor & Destructor Documentation

vtkContextBufferId::vtkContextBufferId (  )  [protected]

virtual vtkContextBufferId::~vtkContextBufferId (  )  [protected, virtual]


Member Function Documentation

virtual const char* vtkContextBufferId::GetClassName (  )  [virtual]

Reimplemented from vtkAbstractContextBufferId.

static int vtkContextBufferId::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type 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.

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]

Reimplemented from vtkAbstractContextBufferId.

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.

Reimplemented from vtkObject.

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

Definition at line 77 of file vtkContextBufferId.h.


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

Generated on Wed Aug 24 11:32:07 2011 for VTK by  doxygen 1.5.6