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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
void Allocate ()
bool IsAllocated () const
int GetValue (vtkIdType i)
vtkIdType GetPickedItem (int x, int y)
virtual int GetWidth ()
virtual void SetWidth (int)
virtual int GetHeight ()
virtual void SetHeight (int)
void SetValue (vtkIdType i, int value)

Static Public Member Functions

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

Protected Member Functions

 vtkContextBufferId ()
virtual ~vtkContextBufferId ()

Protected Attributes

int Width
int Height
vtkIntArrayIdArray

Member Typedef Documentation

Reimplemented from vtkObject.

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

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkContextBufferId* vtkContextBufferId::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

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

static vtkContextBufferId* vtkContextBufferId::New (  )  [static]

Creates a 2D Painter object.

Reimplemented from vtkObject.

virtual int vtkContextBufferId::GetWidth (  )  [virtual]

Number of columns. Initial value is 0.

virtual void vtkContextBufferId::SetWidth ( int   )  [virtual]

Set the number of columns. Initial value is 0.

virtual int vtkContextBufferId::GetHeight (  )  [virtual]

Number of rows. Initial value is 0.

virtual void vtkContextBufferId::SetHeight ( int   )  [virtual]

Set the number of rows. Initial value is 0.

void vtkContextBufferId::Allocate (  ) 

Allocate the memory for at least Width*Height elements.

Precondition:
positive_width: GetWidth()>0

positive_height: GetHeight()>0

bool vtkContextBufferId::IsAllocated (  )  const

Tell if the buffer has been allocated.

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

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  ) 

Get the value at index `i'.

Precondition:
is_allocated: this->IsAllocated()

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

vtkIdType vtkContextBufferId::GetPickedItem ( int  x,
int  y 
)

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


Member Data Documentation

int vtkContextBufferId::Width [protected]

Definition at line 89 of file vtkContextBufferId.h.

int vtkContextBufferId::Height [protected]

Definition at line 90 of file vtkContextBufferId.h.

Definition at line 91 of file vtkContextBufferId.h.


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

Generated on Fri Apr 9 17:37:36 2010 for VTK by  doxygen 1.5.6