ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkMultiSliceContextItem Class Reference

#include <vtkMultiSliceContextItem.h>

Inherits vtkContextItem.

Public Types

enum  { AddSliceEvent = vtkCommand::UserEvent + 1, RemoveSliceEvent = vtkCommand::UserEvent + 2, ModifySliceEvent = vtkCommand::UserEvent + 3 }
 
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)
 Paint the texture into a rectangle defined by the bounds. More...
 
vtkAxis * GetAxis ()
 Return the Axis on which that ContextItem is based. More...
 
void SetActiveSize (int size)
 The active size define the number of pixel that are going to be used for the slider handle. More...
 
void SetEdgeMargin (int margin)
 The margin used on the side of the Axis. More...
 
int GetActiveSliceIndex ()
 Returns the active slice index. More...
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 Return true if the supplied x, y coordinate is inside the item. More...
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event. More...
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event. More...
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event. More...
 
const double * GetVisibleSlices (int &nbSlices) const
 Get access to the data model. More...
 
const double * GetSlices (int &nbSlices) const
 Returns access to slices. More...
 
void SetSlices (double *values, bool *visibility, int numberOfSlices)
 Allow user to programatically update the data model. More...
 
double GetSliceValue (int sliceIndex)
 Return the slice position for a given index. More...
 
int GetNumberOfSlices ()
 Return the number of slices. More...
 

Static Public Member Functions

static vtkMultiSliceContextItemNew ()
 
static int IsTypeOf (const char *type)
 
static vtkMultiSliceContextItemSafeDownCast (vtkObject *o)
 

Protected Member Functions

double ScreenToRange (float position)
 
double ComputeEpsilon (int numberOfPixel=5)
 
void forceRender ()
 
 vtkMultiSliceContextItem ()
 
virtual ~vtkMultiSliceContextItem ()
 

Detailed Description

Definition at line 28 of file vtkMultiSliceContextItem.h.

Member Typedef Documentation

§ Superclass

typedef vtkContextItem vtkMultiSliceContextItem::Superclass

Definition at line 32 of file vtkMultiSliceContextItem.h.

Member Enumeration Documentation

§ anonymous enum

anonymous enum
Enumerator
AddSliceEvent 
RemoveSliceEvent 
ModifySliceEvent 

Definition at line 127 of file vtkMultiSliceContextItem.h.

Constructor & Destructor Documentation

§ vtkMultiSliceContextItem()

vtkMultiSliceContextItem::vtkMultiSliceContextItem ( )
protected

§ ~vtkMultiSliceContextItem()

virtual vtkMultiSliceContextItem::~vtkMultiSliceContextItem ( )
protectedvirtual

Member Function Documentation

§ New()

static vtkMultiSliceContextItem* vtkMultiSliceContextItem::New ( )
static

§ GetClassName()

virtual const char* vtkMultiSliceContextItem::GetClassName ( )
virtual

§ IsTypeOf()

static int vtkMultiSliceContextItem::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkMultiSliceContextItem::IsA ( const char *  type)
virtual

§ SafeDownCast()

static vtkMultiSliceContextItem* vtkMultiSliceContextItem::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

virtual void vtkMultiSliceContextItem::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

§ Paint()

virtual bool vtkMultiSliceContextItem::Paint ( vtkContext2D *  painter)
virtual

Paint the texture into a rectangle defined by the bounds.

If MaskAboveCurve is true and a shape has been provided by a subclass, it draws the texture into the shape

§ GetAxis()

vtkAxis* vtkMultiSliceContextItem::GetAxis ( )

Return the Axis on which that ContextItem is based.

In order to configure that item, just configure the Axis itself. (Range + Position)

§ SetActiveSize()

void vtkMultiSliceContextItem::SetActiveSize ( int  size)

The active size define the number of pixel that are going to be used for the slider handle.

§ SetEdgeMargin()

void vtkMultiSliceContextItem::SetEdgeMargin ( int  margin)

The margin used on the side of the Axis.

§ GetActiveSliceIndex()

int vtkMultiSliceContextItem::GetActiveSliceIndex ( )

Returns the active slice index.

Active slice is only valid when the slice is being updated between mouse-press/release events.

§ Hit()

virtual bool vtkMultiSliceContextItem::Hit ( const vtkContextMouseEvent &  mouse)
virtual

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

§ MouseButtonPressEvent()

virtual bool vtkMultiSliceContextItem::MouseButtonPressEvent ( const vtkContextMouseEvent &  mouse)
virtual

Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.

§ MouseButtonReleaseEvent()

virtual bool vtkMultiSliceContextItem::MouseButtonReleaseEvent ( const vtkContextMouseEvent &  mouse)
virtual

Mouse button release event.

Return true if the item holds the event, false if the event can be propagated to other items.

§ MouseDoubleClickEvent()

virtual bool vtkMultiSliceContextItem::MouseDoubleClickEvent ( const vtkContextMouseEvent &  mouse)
virtual

Mouse button double click event.

Return true if the item holds the event, false if the event can be propagated to other items.

§ MouseMoveEvent()

virtual bool vtkMultiSliceContextItem::MouseMoveEvent ( const vtkContextMouseEvent &  mouse)
virtual

Mouse move event.

Return true if the item holds the event, false if the event can be propagated to other items.

§ GetVisibleSlices()

const double* vtkMultiSliceContextItem::GetVisibleSlices ( int &  nbSlices) const

Get access to the data model.

Return a pointer array to the differents visible slices

§ GetSlices()

const double* vtkMultiSliceContextItem::GetSlices ( int &  nbSlices) const

Returns access to slices.

§ SetSlices()

void vtkMultiSliceContextItem::SetSlices ( double *  values,
bool *  visibility,
int  numberOfSlices 
)

Allow user to programatically update the data model.

Note, this does not fire any of the slice modification/addition/deletion events.

§ GetSliceValue()

double vtkMultiSliceContextItem::GetSliceValue ( int  sliceIndex)

Return the slice position for a given index.

§ GetNumberOfSlices()

int vtkMultiSliceContextItem::GetNumberOfSlices ( )

Return the number of slices.

§ ScreenToRange()

double vtkMultiSliceContextItem::ScreenToRange ( float  position)
protected

§ ComputeEpsilon()

double vtkMultiSliceContextItem::ComputeEpsilon ( int  numberOfPixel = 5)
protected

§ forceRender()

void vtkMultiSliceContextItem::forceRender ( )
protected

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