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

#include <vtkMultiSliceContextItem.h>

Inheritance diagram for vtkMultiSliceContextItem:
Inheritance graph
[legend]
Collaboration diagram for vtkMultiSliceContextItem:
Collaboration graph
[legend]

Public Types

enum  { AddSliceEvent = vtkCommand::UserEvent + 1, RemoveSliceEvent = vtkCommand::UserEvent + 2, ModifySliceEvent = vtkCommand::UserEvent + 3 }
 
typedef vtkContextItem Superclass
 
- Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem Superclass
 
- Public Types inherited from vtkAbstractContextItem
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
bool Paint (vtkContext2D *painter) override
 Paint the texture into a rectangle defined by the bounds. More...
 
vtkAxisGetAxis ()
 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...
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Return true if the supplied x, y coordinate is inside the item. More...
 
bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
 Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items. More...
 
bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
 Mouse button release event. More...
 
bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse) override
 Mouse button double click event. More...
 
bool MouseMoveEvent (const vtkContextMouseEvent &mouse) override
 Mouse move event. More...
 
const doubleGetVisibleSlices (int &nbSlices) const
 Get access to the data model. More...
 
const doubleGetSlices (int &nbSlices) const
 Returns access to slices. More...
 
void SetSlices (double *values, bool *visibility, int numberOfSlices)
 Allow user to programmatically 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...
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
virtual double GetOpacity ()
 
virtual void SetOpacity (double)
 
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 MouseEnterEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 
virtual bool KeyReleaseEvent (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)
 
vtkContextSceneGetScene ()
 
vtkAbstractContextItemGetParent ()
 
virtual bool GetVisible ()
 
virtual void SetVisible (bool)
 
virtual bool GetInteractive ()
 
virtual void SetInteractive (bool)
 
virtual unsigned int StackAbove (unsigned int index, unsigned int under)
 
virtual unsigned int StackUnder (unsigned int child, unsigned int above)
 
vtkContextSceneGetScene ()
 
vtkAbstractContextItemGetParent ()
 
virtual bool GetVisible ()
 
virtual void SetVisible (bool)
 
virtual bool GetInteractive ()
 
virtual void SetInteractive (bool)
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
- 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)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkMultiSliceContextItemNew ()
 
static int IsTypeOf (const char *type)
 
static vtkMultiSliceContextItemSafeDownCast (vtkObject *o)
 
- 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 vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

double ScreenToRange (float position)
 
double ComputeEpsilon (int numberOfPixel=5)
 
void forceRender ()
 
 vtkMultiSliceContextItem ()
 
 ~vtkMultiSliceContextItem () override
 
- Protected Member Functions inherited from vtkContextItem
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkContextItem ()
 
 ~vtkContextItem ()
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
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 &)
 

Additional Inherited Members

- 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

Definition at line 17 of file vtkMultiSliceContextItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 21 of file vtkMultiSliceContextItem.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
AddSliceEvent 
RemoveSliceEvent 
ModifySliceEvent 

Definition at line 116 of file vtkMultiSliceContextItem.h.

Constructor & Destructor Documentation

◆ vtkMultiSliceContextItem()

vtkMultiSliceContextItem::vtkMultiSliceContextItem ( )
protected

◆ ~vtkMultiSliceContextItem()

vtkMultiSliceContextItem::~vtkMultiSliceContextItem ( )
overrideprotected

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

Reimplemented from vtkContextItem.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkContextItem.

◆ Paint()

bool vtkMultiSliceContextItem::Paint ( vtkContext2D painter)
overridevirtual

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

Reimplemented from vtkAbstractContextItem.

◆ 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()

bool vtkMultiSliceContextItem::Hit ( const vtkContextMouseEvent mouse)
overridevirtual

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

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonPressEvent()

bool vtkMultiSliceContextItem::MouseButtonPressEvent ( const vtkContextMouseEvent mouse)
overridevirtual

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

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonReleaseEvent()

bool vtkMultiSliceContextItem::MouseButtonReleaseEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse button release event.

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

Reimplemented from vtkAbstractContextItem.

◆ MouseDoubleClickEvent()

bool vtkMultiSliceContextItem::MouseDoubleClickEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse button double click event.

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

Reimplemented from vtkAbstractContextItem.

◆ MouseMoveEvent()

bool vtkMultiSliceContextItem::MouseMoveEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse move event.

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

Reimplemented from vtkAbstractContextItem.

◆ GetVisibleSlices()

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

Get access to the data model.

Return a pointer array to the different 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 programmatically 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: