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

item to show and control the range of a vtkColorTransferFunction More...

#include <vtkRangeHandlesItem.h>

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

Public Types

enum  Handle { NO_HANDLE = -1, LEFT_HANDLE = 0, RIGHT_HANDLE = 1 }
 
typedef vtkPlot Superclass
 
- Public Types inherited from vtkPlot
typedef vtkContextItem Superclass
 
- Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem Superclass
 
- Public Types inherited from vtkAbstractContextItem
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkRangeHandlesItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool Paint (vtkContext2D *painter) override
 Paint both handles and the range if a handle is active or hovered. More...
 
void GetBounds (double bounds[4]) override
 Recover the bounds of the item. More...
 
virtual void GetHandlesRange (double range[2])
 Recover the range currently set by the handles Use this method by observing EndInteractionEvent. More...
 
void SetColorTransferFunction (vtkColorTransferFunction *ctf)
 Get/set the color transfer function to interact with. More...
 
virtual vtkColorTransferFunctionGetColorTransferFunction ()
 
virtual void SetHandleWidth (float)
 Set/Get the handles width in pixels. More...
 
virtual float GetHandleWidth ()
 
void ComputeHandlesDrawRange ()
 Compute the handles draw range by using the handle width and the transfer function. More...
 
- Public Member Functions inherited from vtkPlot
vtkPlotNewInstance () const
 
virtual void SetLegendVisibility (bool)
 Set whether the plot renders an entry in the legend. More...
 
virtual bool GetLegendVisibility ()
 
virtual void LegendVisibilityOn ()
 
virtual void LegendVisibilityOff ()
 
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
 Paint legend event for the plot, called whenever the legend needs the plot items symbol/mark/line drawn. More...
 
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 Sets/gets a printf-style string to build custom tooltip labels from. More...
 
virtual vtkStdString GetTooltipLabelFormat ()
 
virtual void SetTooltipNotation (int notation)
 Sets/gets the tooltip notation style. More...
 
virtual int GetTooltipNotation ()
 
virtual void SetTooltipPrecision (int precision)
 Sets/gets the tooltip precision. More...
 
virtual int GetTooltipPrecision ()
 
virtual vtkStdString GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
 Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar. More...
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId)
 Function to query a plot for the nearest point to the specified coordinate. More...
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
 Function to query a plot for the nearest point to the specified coordinate. More...
 
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
 Select all points in the specified rectangle. More...
 
virtual bool SelectPointsInPolygon (const vtkContextPolygon &polygon)
 Select all points in the specified polygon. More...
 
virtual void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 Set the plot color. More...
 
virtual void SetColor (double r, double g, double b)
 
virtual void GetColor (double rgb[3])
 
void GetColor (unsigned char rgb[3])
 
virtual void SetWidth (float width)
 Set the width of the line. More...
 
virtual float GetWidth ()
 Get the width of the line. More...
 
void SetPen (vtkPen *pen)
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
vtkPenGetPen ()
 
void SetBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills shapes. More...
 
vtkBrushGetBrush ()
 
void SetSelectionPen (vtkPen *pen)
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
vtkPenGetSelectionPen ()
 
void SetSelectionBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
vtkBrushGetSelectionBrush ()
 
virtual void SetLabel (const vtkStdString &label)
 Set the label of this plot. More...
 
virtual vtkStdString GetLabel ()
 Get the label of this plot. More...
 
virtual void SetLabels (vtkStringArray *labels)
 Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index. More...
 
virtual vtkStringArrayGetLabels ()
 Get the plot labels. More...
 
virtual int GetNumberOfLabels ()
 Get the number of labels associated with this plot. More...
 
vtkStdString GetLabel (vtkIdType index)
 Get the label at the specified index. More...
 
void SetIndexedLabels (vtkStringArray *labels)
 Set indexed labels for the plot. More...
 
virtual vtkStringArrayGetIndexedLabels ()
 Get the indexed labels array. More...
 
vtkContextMapper2DGetData ()
 Get the data object that the plot will draw. More...
 
virtual bool GetUseIndexForXSeries ()
 Use the Y array index for the X value. More...
 
virtual void SetUseIndexForXSeries (bool)
 Use the Y array index for the X value. More...
 
virtual void SetInputData (vtkTable *table)
 This is a convenience function to set the input table and the x, y column for the plot. More...
 
virtual void SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
 
void SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
 
virtual vtkTableGetInput ()
 Get the input table used by the plot. More...
 
virtual void SetInputArray (int index, const vtkStdString &name)
 Convenience function to set the input arrays. More...
 
virtual void SetSelectable (bool)
 Set whether the plot can be selected. More...
 
virtual bool GetSelectable ()
 
virtual void SelectableOn ()
 
virtual void SelectableOff ()
 
virtual void SetSelection (vtkIdTypeArray *id)
 Sets the list of points that must be selected. More...
 
virtual vtkIdTypeArrayGetSelection ()
 
virtual vtkAxisGetXAxis ()
 Get/set the X axis associated with this plot. More...
 
virtual void SetXAxis (vtkAxis *axis)
 
virtual vtkAxisGetYAxis ()
 Get/set the Y axis associated with this plot. More...
 
virtual void SetYAxis (vtkAxis *axis)
 
void SetShiftScale (const vtkRectd &scaling)
 Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range. More...
 
vtkRectd GetShiftScale ()
 
virtual void GetUnscaledInputBounds (double bounds[4])
 Provide un-log-scaled bounds for the plot inputs. More...
 
virtual void UpdateCache ()
 Subclasses that build data caches to speed up painting should override this method to update such caches. More...
 
virtual void SetProperty (const vtkStdString &property, const vtkVariant &var)
 A General setter/getter that should be overridden. More...
 
virtual vtkVariant GetProperty (const vtkStdString &property)
 
virtual bool ClampPos (double pos[2])
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual double GetOpacity ()
 Get the opacity of the item. More...
 
virtual void SetOpacity (double)
 Set the opacity of the item. More...
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual void Update ()
 Perform any updates to the item that may be necessary before rendering. More...
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRangeHandlesItemSafeDownCast (vtkObjectBase *o)
 
static vtkRangeHandlesItemNew ()
 
- Static Public Member Functions inherited from vtkPlot
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPlotSafeDownCast (vtkObjectBase *o)
 
static bool ClampPos (double pos[2], double bounds[4])
 Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise. More...
 
- Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRangeHandlesItem ()
 
 ~vtkRangeHandlesItem () override
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Returns true if the supplied x, y coordinate is around a handle. More...
 
bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
 Interaction methods to interact with the handles. More...
 
bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
 Mouse button release event. More...
 
bool MouseMoveEvent (const vtkContextMouseEvent &mouse) override
 Mouse move event. More...
 
bool MouseEnterEvent (const vtkContextMouseEvent &mouse) override
 Mouse enter event. More...
 
bool MouseLeaveEvent (const vtkContextMouseEvent &mouse) override
 Mouse leave event. More...
 
bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse) override
 Mouse button double click event. More...
 
virtual int FindRangeHandle (const vtkVector2f &point, const vtkVector2f &tolerance)
 Returns the handle the provided point is over with a provided tolerance, it can be NO_HANDLE, LEFT_HANDLE or RIGHT_HANDLE. More...
 
void SetActiveHandlePosition (double position)
 Internal method to set the ActiveHandlePosition and compute the ActiveHandleRangeValue accordingly. More...
 
bool IsActiveHandleMoved (double tolerance)
 Internal method to check if the active handle have actually been moved. More...
 
void SetCursor (int cursor)
 Set the cursor shape. More...
 
- Protected Member Functions inherited from vtkPlot
 vtkPlot ()
 
 ~vtkPlot () override
 
vtkStdString GetNumber (double position, vtkAxis *axis)
 Get the properly formatted number for the supplied position and axis. More...
 
virtual void TransformScreenToData (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space. More...
 
virtual void TransformDataToScreen (const vtkVector2f &in, vtkVector2f &out)
 
virtual void TransformScreenToData (const double inX, const double inY, double &outX, double &outY)
 
virtual void TransformDataToScreen (const double inX, const double inY, double &outX, double &outY)
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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 vtkPlot
vtkSmartPointer< vtkPenPen
 This object stores the vtkPen that controls how the plot is drawn. More...
 
vtkSmartPointer< vtkBrushBrush
 This object stores the vtkBrush that controls how the plot is drawn. More...
 
vtkSmartPointer< vtkPenSelectionPen
 This object stores the vtkPen that controls how the selected elements of the plot are drawn. More...
 
vtkSmartPointer< vtkBrushSelectionBrush
 This object stores the vtkBrush that controls how the selected elements of the plot are drawn. More...
 
vtkSmartPointer< vtkStringArrayLabels
 Plot labels, used by legend. More...
 
vtkSmartPointer< vtkStringArrayAutoLabels
 Holds Labels when they're auto-created. More...
 
vtkSmartPointer< vtkStringArrayIndexedLabels
 Holds Labels when they're auto-created. More...
 
bool UseIndexForXSeries
 Use the Y array index for the X value. More...
 
vtkSmartPointer< vtkContextMapper2DData
 This data member contains the data that will be plotted, it inherits from vtkAlgorithm. More...
 
bool Selectable
 Whether plot points can be selected or not. More...
 
vtkIdTypeArraySelection
 Selected indices for the table the plot is rendering. More...
 
vtkAxisXAxis
 The X axis associated with this plot. More...
 
vtkAxisYAxis
 The X axis associated with this plot. More...
 
vtkStdString TooltipLabelFormat
 A printf-style string to build custom tooltip labels from. More...
 
vtkStdString TooltipDefaultLabelFormat
 The default printf-style string to build custom tooltip labels from. More...
 
int TooltipNotation
 
int TooltipPrecision
 
vtkRectd ShiftScale
 The current shift in origin and scaling factor applied to the plot. More...
 
bool LegendVisibility
 
bool LegacyRecursionFlag = false
 Flag used by GetNearestPoint legacy implementation to avoid infinite call. More...
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

item to show and control the range of a vtkColorTransferFunction

vtkRangeHandlesItem provides range handles painting and management for a provided vtkColorTransferFunction. Handles can be moved by clicking on them. The range is shown when hovering or moving the handles. It emits a StartInteractionEvent when starting to interact with a handle, an InteractionEvent when interacting with a handle and an EndInteractionEvent when releasing a handle. It emits a LeftMouseButtonDoubleClickEvent when double clicked.

See also
vtkControlPointsItem vtkScalarsToColorsItem vtkColorTransferFunctionItem

Definition at line 45 of file vtkRangeHandlesItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkRangeHandlesItem.h.

Member Enumeration Documentation

◆ Handle

Enumerator
NO_HANDLE 
LEFT_HANDLE 
RIGHT_HANDLE 

Definition at line 52 of file vtkRangeHandlesItem.h.

Constructor & Destructor Documentation

◆ vtkRangeHandlesItem()

vtkRangeHandlesItem::vtkRangeHandlesItem ( )
protected

◆ ~vtkRangeHandlesItem()

vtkRangeHandlesItem::~vtkRangeHandlesItem ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkRangeHandlesItem::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkRangeHandlesItem::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 vtkPlot.

◆ SafeDownCast()

static vtkRangeHandlesItem* vtkRangeHandlesItem::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRangeHandlesItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPlot.

◆ NewInstance()

vtkRangeHandlesItem* vtkRangeHandlesItem::NewInstance ( ) const

◆ PrintSelf()

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

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

◆ New()

static vtkRangeHandlesItem* vtkRangeHandlesItem::New ( )
static

◆ Paint()

bool vtkRangeHandlesItem::Paint ( vtkContext2D painter)
overridevirtual

Paint both handles and the range if a handle is active or hovered.

Reimplemented from vtkAbstractContextItem.

◆ GetBounds()

void vtkRangeHandlesItem::GetBounds ( double  bounds[4])
overridevirtual

Recover the bounds of the item.

Reimplemented from vtkPlot.

◆ GetHandlesRange()

virtual void vtkRangeHandlesItem::GetHandlesRange ( double  range[2])
virtual

Recover the range currently set by the handles Use this method by observing EndInteractionEvent.

◆ SetColorTransferFunction()

void vtkRangeHandlesItem::SetColorTransferFunction ( vtkColorTransferFunction ctf)

Get/set the color transfer function to interact with.

◆ GetColorTransferFunction()

virtual vtkColorTransferFunction* vtkRangeHandlesItem::GetColorTransferFunction ( )
virtual

◆ SetHandleWidth()

virtual void vtkRangeHandlesItem::SetHandleWidth ( float  )
virtual

Set/Get the handles width in pixels.

Default is 2.

◆ GetHandleWidth()

virtual float vtkRangeHandlesItem::GetHandleWidth ( )
virtual

◆ ComputeHandlesDrawRange()

void vtkRangeHandlesItem::ComputeHandlesDrawRange ( )

Compute the handles draw range by using the handle width and the transfer function.

◆ Hit()

bool vtkRangeHandlesItem::Hit ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

Returns true if the supplied x, y coordinate is around a handle.

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonPressEvent()

bool vtkRangeHandlesItem::MouseButtonPressEvent ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

Interaction methods to interact with the handles.

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonReleaseEvent()

bool vtkRangeHandlesItem::MouseButtonReleaseEvent ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

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.

◆ MouseMoveEvent()

bool vtkRangeHandlesItem::MouseMoveEvent ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

Mouse move event.

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

Reimplemented from vtkAbstractContextItem.

◆ MouseEnterEvent()

bool vtkRangeHandlesItem::MouseEnterEvent ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

Mouse enter event.

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

Reimplemented from vtkAbstractContextItem.

◆ MouseLeaveEvent()

bool vtkRangeHandlesItem::MouseLeaveEvent ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

Mouse leave event.

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

Reimplemented from vtkAbstractContextItem.

◆ MouseDoubleClickEvent()

bool vtkRangeHandlesItem::MouseDoubleClickEvent ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

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.

◆ FindRangeHandle()

virtual int vtkRangeHandlesItem::FindRangeHandle ( const vtkVector2f point,
const vtkVector2f tolerance 
)
protectedvirtual

Returns the handle the provided point is over with a provided tolerance, it can be NO_HANDLE, LEFT_HANDLE or RIGHT_HANDLE.

◆ SetActiveHandlePosition()

void vtkRangeHandlesItem::SetActiveHandlePosition ( double  position)
protected

Internal method to set the ActiveHandlePosition and compute the ActiveHandleRangeValue accordingly.

◆ IsActiveHandleMoved()

bool vtkRangeHandlesItem::IsActiveHandleMoved ( double  tolerance)
protected

Internal method to check if the active handle have actually been moved.

◆ SetCursor()

void vtkRangeHandlesItem::SetCursor ( int  cursor)
protected

Set the cursor shape.


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