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

a vtkContextItem that draws a block (optional label). More...

#include <vtkBlockItem.h>

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

Public Types

typedef vtkContextItem Superclass
 
- Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem Superclass
 
- Public Types inherited from vtkAbstractContextItem
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkBlockItemNewInstance () const
 
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 (float, float, float, float)
 
virtual void SetDimensions (float[4])
 
virtual floatGetDimensions ()
 
virtual void GetDimensions (float &, float &, float &, float &)
 
virtual void GetDimensions (float[4])
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
virtual double GetOpacity ()
 
virtual void SetOpacity (double)
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual void Update ()
 
virtual bool PaintChildren (vtkContext2D *painter)
 
virtual void ReleaseGraphicsResources ()
 
unsigned int AddItem (vtkAbstractContextItem *item)
 
bool RemoveItem (vtkAbstractContextItem *item)
 
bool RemoveItem (unsigned int index)
 
vtkAbstractContextItemGetItem (unsigned int index)
 
unsigned int GetItemIndex (vtkAbstractContextItem *item)
 
unsigned int GetNumberOfItems ()
 
void ClearItems ()
 
unsigned int Raise (unsigned int index)
 
unsigned int Lower (unsigned int index)
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 
virtual void SetScene (vtkContextScene *scene)
 
virtual void SetParent (vtkAbstractContextItem *parent)
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 
virtual unsigned int StackAbove (unsigned int index, unsigned int under)
 
virtual unsigned int StackUnder (unsigned int child, unsigned int above)
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 
vtkContextSceneGetScene ()
 
vtkAbstractContextItemGetParent ()
 
virtual bool GetVisible ()
 
virtual void SetVisible (bool)
 
virtual bool GetInteractive ()
 
virtual void SetInteractive (bool)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
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)
 
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 vtkBlockItemSafeDownCast (vtkObjectBase *o)
 
static vtkBlockItemNew ()
 
- Static Public Member Functions inherited from vtkContextItem
static int IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static int IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *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

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkBlockItem ()
 
 ~vtkBlockItem ()
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem ()
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem ()
 
- 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

float Dimensions [4]
 
vtkStdString Label
 
bool MouseOver
 
double(* scalarFunction )(double, double)
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 
vtkAbstractContextItemParent
 
vtkContextScenePrivateChildren
 
bool Visible
 
bool Interactive
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 36 of file vtkBlockItem.h.

Member Typedef Documentation

Definition at line 39 of file vtkBlockItem.h.

Constructor & Destructor Documentation

vtkBlockItem::vtkBlockItem ( )
protected
vtkBlockItem::~vtkBlockItem ( )
protected

Member Function Documentation

static int vtkBlockItem::IsTypeOf ( const char *  type)
static
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 ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkBlockItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContextItem.

vtkBlockItem* vtkBlockItem::NewInstance ( ) const
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
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 ( float  ,
float  ,
float  ,
float   
)
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 ( float  [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 float* 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 ( float ,
float ,
float ,
float  
)
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 ( float  [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

float vtkBlockItem::Dimensions[4]
protected

Definition at line 98 of file vtkBlockItem.h.

vtkStdString vtkBlockItem::Label
protected

Definition at line 100 of file vtkBlockItem.h.

bool vtkBlockItem::MouseOver
protected

Definition at line 102 of file vtkBlockItem.h.

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

Definition at line 105 of file vtkBlockItem.h.


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