vtkBlockItem Class Reference

#include <vtkBlockItem.h>

Inheritance diagram for vtkBlockItem:

Inheritance graph
[legend]
Collaboration diagram for vtkBlockItem:

Collaboration graph
[legend]

List of all members.


Detailed Description

a vtkContextItem that draws a block (optional label).

This is a vtkContextItem that can be placed into a vtkContextScene. It draws a block of the given dimensions, and reacts to mouse events.

Tests:
vtkBlockItem (Tests)

Definition at line 35 of file vtkBlockItem.h.


Public Types

typedef vtkContextItem Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual bool Paint (vtkContext2D *painter)
virtual bool Hit (const vtkContextMouseEvent &mouse)
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
virtual void SetLabel (const vtkStdString &label)
virtual vtkStdString GetLabel ()
void SetScalarFunctor (double(*scalarFunction)(double, double))
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
virtual void SetDimensions (int, int, int, int)
virtual void SetDimensions (int[4])
virtual int * GetDimensions ()
virtual void GetDimensions (int &, int &, int &, int &)
virtual void GetDimensions (int[4])

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkBlockItemSafeDownCast (vtkObject *o)
static vtkBlockItemNew ()

Protected Member Functions

 vtkBlockItem ()
 ~vtkBlockItem ()

Protected Attributes

int Dimensions [4]
float LastPosition [2]
vtkStdString Label
bool MouseOver
int MouseButtonPressed
double(* scalarFunction )(double, double)

Member Typedef Documentation

Reimplemented from vtkContextItem.

Definition at line 38 of file vtkBlockItem.h.


Constructor & Destructor Documentation

vtkBlockItem::vtkBlockItem (  )  [protected]

vtkBlockItem::~vtkBlockItem (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkContextItem.

static int vtkBlockItem::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 vtkContextItem.

virtual int vtkBlockItem::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 vtkContextItem.

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

Reimplemented from vtkContextItem.

virtual void vtkBlockItem::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 vtkContextItem.

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual bool vtkBlockItem::Paint ( vtkContext2D painter  )  [virtual]

Paint event for the item.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkBlockItem::Hit ( const vtkContextMouseEvent mouse  )  [virtual]

Returns true if the supplied x, y coordinate is inside the item.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkBlockItem::MouseEnterEvent ( const vtkContextMouseEvent mouse  )  [virtual]

Mouse enter event.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkBlockItem::MouseMoveEvent ( const vtkContextMouseEvent mouse  )  [virtual]

Mouse move event.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkBlockItem::MouseLeaveEvent ( const vtkContextMouseEvent mouse  )  [virtual]

Mouse leave event.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkBlockItem::MouseButtonPressEvent ( const vtkContextMouseEvent mouse  )  [virtual]

Mouse button down event.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkBlockItem::MouseButtonReleaseEvent ( const vtkContextMouseEvent mouse  )  [virtual]

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

virtual void vtkBlockItem::SetLabel ( const vtkStdString label  )  [virtual]

Set the block label.

virtual vtkStdString vtkBlockItem::GetLabel (  )  [virtual]

Get the block label.

virtual void vtkBlockItem::SetDimensions ( int  ,
int  ,
int  ,
int   
) [virtual]

Set the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner. Elements 2 and 3 are the width and height. Initial value is (0,0,0,0).

virtual void vtkBlockItem::SetDimensions ( int  [4]  )  [virtual]

Set the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner. Elements 2 and 3 are the width and height. Initial value is (0,0,0,0).

virtual int* vtkBlockItem::GetDimensions (  )  [virtual]

Get the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner. Elements 2 and 3 are the width and height. Initial value is (0,0,0,0)

virtual void vtkBlockItem::GetDimensions ( int &  ,
int &  ,
int &  ,
int &   
) [virtual]

Get the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner. Elements 2 and 3 are the width and height. Initial value is (0,0,0,0)

virtual void vtkBlockItem::GetDimensions ( int  [4]  )  [virtual]

Get the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner. Elements 2 and 3 are the width and height. Initial value is (0,0,0,0)

void vtkBlockItem::SetScalarFunctor ( double(*)(double, double)  scalarFunction  ) 


Member Data Documentation

int vtkBlockItem::Dimensions[4] [protected]

Definition at line 97 of file vtkBlockItem.h.

float vtkBlockItem::LastPosition[2] [protected]

Definition at line 99 of file vtkBlockItem.h.

Definition at line 101 of file vtkBlockItem.h.

bool vtkBlockItem::MouseOver [protected]

Definition at line 103 of file vtkBlockItem.h.

Definition at line 104 of file vtkBlockItem.h.

double(* vtkBlockItem::scalarFunction)(double, double) [protected]


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

Generated on Wed Aug 24 11:29:33 2011 for VTK by  doxygen 1.5.6