VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
vtkControlPointsItem Class Referenceabstract

Abstract class for control points items. More...

#include <vtkControlPointsItem.h>

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

Public Types

enum  { CurrentPointChangedEvent = vtkCommand::UserEvent, CurrentPointEditEvent }
 
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...
 
vtkControlPointsItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void GetBounds (double bounds[4]) override
 Bounds of the item, typically the bound of all the control points except if custom bounds have been set. More...
 
virtual void SetUserBounds (double, double, double, double)
 Set custom bounds, except if bounds are invalid, bounds will be automatically computed based on the range of the control points Invalid bounds by default. More...
 
virtual void SetUserBounds (double[4])
 
virtual double * GetUserBounds ()
 
virtual void GetUserBounds (double &, double &, double &, double &)
 
virtual void GetUserBounds (double[4])
 
virtual void SetValidBounds (double, double, double, double)
 Controls the valid range for the values. More...
 
virtual void SetValidBounds (double[4])
 
virtual double * GetValidBounds ()
 
virtual void GetValidBounds (double &, double &, double &, double &)
 
virtual void GetValidBounds (double[4])
 
virtual float GetScreenPointRadius ()
 Get/set the radius for screen points. More...
 
virtual void SetScreenPointRadius (float)
 
bool Paint (vtkContext2D *painter) override
 Paint the points with a fixed size (cosmetic) which doesn't depend on the scene zoom factor. More...
 
void SelectPoint (vtkIdType pointId)
 Select a point by its ID. More...
 
void SelectPoint (double *currentPoint)
 Utility function that selects a point providing its coordinates. More...
 
void SelectAllPoints ()
 Select all the points. More...
 
void DeselectPoint (vtkIdType pointId)
 Unselect a point by its ID. More...
 
void DeselectPoint (double *currentPoint)
 Utility function that unselects a point providing its coordinates. More...
 
void DeselectAllPoints ()
 Unselect all the previously selected points. More...
 
void ToggleSelectPoint (vtkIdType pointId)
 Toggle the selection of a point by its ID. More...
 
void ToggleSelectPoint (double *currentPoint)
 Utility function that toggles the selection a point providing its coordinates. More...
 
bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max) override
 Select all points in the specified rectangle. More...
 
vtkIdType GetNumberOfSelectedPoints () const
 Return the number of selected points. More...
 
vtkIdType FindPoint (double *pos)
 Returns the vtkIdType of the point given its coordinates and a tolerance based on the screen point size. More...
 
bool IsOverPoint (double *pos, vtkIdType pointId)
 Returns true if pos is above the pointId point, false otherwise. More...
 
vtkIdType GetControlPointId (double *pos)
 Returns the id of the control point exactly matching pos, -1 if not found. More...
 
void GetControlPointsIds (vtkIdTypeArray *ids, bool excludeFirstAndLast=false) const
 Utility function that returns an array of all the control points IDs Typically: [0, 1, 2, ... More...
 
virtual bool GetStrokeMode ()
 Controls whether or not control points are drawn (true) or clicked and moved (false). More...
 
virtual void SetSwitchPointsMode (bool)
 If DrawPoints is false, SwitchPoints controls the behavior when a control point is dragged past another point. More...
 
virtual bool GetSwitchPointsMode ()
 
virtual void SetEndPointsXMovable (bool)
 If EndPointsMovable is false, the two end points will not be moved. More...
 
virtual bool GetEndPointsXMovable ()
 
virtual void SetEndPointsYMovable (bool)
 
virtual bool GetEndPointsYMovable ()
 
virtual bool GetEndPointsMovable ()
 
virtual void SetEndPointsRemovable (bool)
 If EndPointsRemovable is false, the two end points will not be removed. More...
 
virtual bool GetEndPointsRemovable ()
 
virtual void SetShowLabels (bool)
 When set to true, labels are shown on the current control point and the end points. More...
 
virtual bool GetShowLabels ()
 
virtual void SetLabelFormat (const char *)
 Get/Set the label format. More...
 
virtual char * GetLabelFormat ()
 
virtual vtkIdType AddPoint (double *newPos)=0
 Add a point to the function. More...
 
virtual vtkIdType RemovePoint (double *pos)=0
 Remove a point of the function. More...
 
vtkIdType RemovePoint (vtkIdType pointId)
 Remove a point give its id. More...
 
void RemoveCurrentPoint ()
 Remove the current point. More...
 
virtual vtkIdType GetNumberOfPoints () const =0
 Returns the total number of points. More...
 
virtual void GetControlPoint (vtkIdType index, double *point) const =0
 Returns the x and y coordinates as well as the midpoint and sharpness of the control point corresponding to the index. More...
 
virtual void SetControlPoint (vtkIdType index, double *point)=0
 Sets the x and y coordinates as well as the midpoint and sharpness of the control point corresponding to the index. More...
 
void MovePoints (const vtkVector2f &translation, vtkIdTypeArray *pointIds)
 Move the points referred by pointIds by a given translation. More...
 
void MovePoints (const vtkVector2f &translation, bool dontMoveFirstAndLast=false)
 Utility function to move all the control points of the given translation If dontMoveFirstAndLast is true, then the first and last points won't be moved. More...
 
void SpreadPoints (float factor, vtkIdTypeArray *pointIds)
 Spread the points referred by pointIds If factor > 0, points are moved away from each other. More...
 
void SpreadPoints (float factor, bool dontSpreadFirstAndLast=false)
 Utility function to spread all the control points of a given factor If dontSpreadFirstAndLast is true, then the first and last points won't be spread. More...
 
vtkIdType GetCurrentPoint () const
 Returns the current point ID selected or -1 if there is no point current. More...
 
void SetCurrentPoint (vtkIdType index)
 Sets the current point selected. More...
 
virtual vtkPenGetSelectedPointPen ()
 Gets the selected point pen and brush. More...
 
virtual vtkBrushGetSelectedPointBrush ()
 Depending on the control points item, the brush might not be taken into account. More...
 
virtual bool GetUseAddPointItem ()
 When enabled, a dedicated item is used to determine if a point should be added when clicking anywhere. More...
 
virtual void SetUseAddPointItem (bool)
 
virtual void UseAddPointItemOn ()
 
virtual void UseAddPointItemOff ()
 
vtkPlotGetAddPointItem ()
 Item dedicated to add point, to be added below all other items. More...
 
void ResetBounds ()
 Recompute the bounds next time they are requested. More...
 
bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
 Mouse and key events. More...
 
bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse) override
 Mouse button double click event. More...
 
bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
 Mouse button release event. More...
 
bool MouseMoveEvent (const vtkContextMouseEvent &mouse) override
 Mouse move event. More...
 
bool KeyPressEvent (const vtkContextKeyEvent &key) override
 Key press event. More...
 
bool KeyReleaseEvent (const vtkContextKeyEvent &key) override
 Key release event. More...
 
- Public Member Functions inherited from vtkPlot
vtkPlotNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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 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 MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. 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 vtkControlPointsItemSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkControlPointsItem ()
 
 ~vtkControlPointsItem () override
 
void StartChanges ()
 
void EndChanges ()
 
void StartInteraction ()
 
void StartInteractionIfNotStarted ()
 
void Interaction ()
 
void EndInteraction ()
 
int GetInteractionsCount () const
 
virtual void emitEvent (unsigned long event, void *params=nullptr)=0
 
virtual void ComputePoints ()
 Must be reimplemented by subclasses to calculate the points to draw. More...
 
virtual vtkMTimeType GetControlPointsMTime ()=0
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Returns true if the supplied x, y are within the bounds or on a control point. More...
 
bool ClampValidDataPos (double pos[2])
 Clamp the given 2D pos into the bounds of the function. More...
 
bool ClampValidScreenPos (double pos[2])
 
void DrawUnselectedPoints (vtkContext2D *painter)
 Internal function that paints a collection of points and optionally excludes some. More...
 
void DrawSelectedPoints (vtkContext2D *painter)
 
virtual void DrawPoint (vtkContext2D *painter, vtkIdType index)
 
void SetCurrentPointPos (const vtkVector2f &newPos)
 
vtkIdType SetPointPos (vtkIdType point, const vtkVector2f &newPos)
 
void MoveCurrentPoint (const vtkVector2f &translation)
 
vtkIdType MovePoint (vtkIdType point, const vtkVector2f &translation)
 
vtkVector2f GetSelectionCenterOfMass () const
 
vtkVector2f GetCenterOfMass (vtkIdTypeArray *pointIDs) const
 
void Stroke (const vtkVector2f &newPos)
 
virtual void EditPoint (float vtkNotUsed(tX), float vtkNotUsed(tY))
 
virtual vtkStdString GetControlPointLabel (vtkIdType index)
 Generate label for a control point. More...
 
void AddPointId (vtkIdType addedPointId)
 
bool IsEndPointPicked ()
 Return true if any of the end points is current point or part of the selection. More...
 
bool IsPointRemovable (vtkIdType pointId)
 Return true if the point is removable. More...
 
virtual void ComputeBounds (double *bounds)
 Compute the bounds for this item. 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 &)
 

Static Protected Member Functions

static void CallComputePoints (vtkObject *sender, unsigned long event, void *receiver, void *params)
 

Protected Attributes

vtkCallbackCommandCallback
 
vtkPenSelectedPointPen
 
vtkBrushSelectedPointBrush
 
int BlockUpdates
 
int StartedInteractions
 
int StartedChanges
 
vtkIdType CurrentPoint
 
double Bounds [4]
 
double UserBounds [4]
 
double ValidBounds [4]
 
vtkTransform2DTransform
 
float ScreenPointRadius
 
bool StrokeMode
 
bool SwitchPointsMode
 
bool MouseMoved
 
bool EnforceValidFunction
 
vtkIdType PointToDelete
 
bool PointAboutToBeDeleted
 
vtkIdType PointToToggle
 
bool PointAboutToBeToggled
 
bool InvertShadow
 
bool EndPointsXMovable
 
bool EndPointsYMovable
 
bool EndPointsRemovable
 
bool ShowLabels
 
char * LabelFormat
 
- 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
 

Friends

class vtkPiecewisePointHandleItem
 

Detailed Description

Abstract class for control points items.

vtkControlPointsItem provides control point painting and management for subclasses that provide points (typically control points of a transfer function)

See also
vtkScalarsToColorsItem vtkPiecewiseControlPointsItem

Definition at line 44 of file vtkControlPointsItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkControlPointsItem.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
CurrentPointChangedEvent 
CurrentPointEditEvent 

Definition at line 56 of file vtkControlPointsItem.h.

Constructor & Destructor Documentation

◆ vtkControlPointsItem()

vtkControlPointsItem::vtkControlPointsItem ( )
protected

◆ ~vtkControlPointsItem()

vtkControlPointsItem::~vtkControlPointsItem ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkCompositeControlPointsItem, vtkColorTransferControlPointsItem, and vtkPiecewiseControlPointsItem.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkControlPointsItem::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkControlPointsItem* vtkControlPointsItem::NewInstance ( ) const

◆ PrintSelf()

void vtkControlPointsItem::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 vtkObjectBase.

Reimplemented in vtkPiecewiseControlPointsItem.

◆ GetBounds()

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

Bounds of the item, typically the bound of all the control points except if custom bounds have been set.

See also
SetUserBounds.

Reimplemented from vtkPlot.

◆ SetUserBounds() [1/2]

virtual void vtkControlPointsItem::SetUserBounds ( double  ,
double  ,
double  ,
double   
)
virtual

Set custom bounds, except if bounds are invalid, bounds will be automatically computed based on the range of the control points Invalid bounds by default.

◆ SetUserBounds() [2/2]

virtual void vtkControlPointsItem::SetUserBounds ( double  [4])
virtual

◆ GetUserBounds() [1/3]

virtual double* vtkControlPointsItem::GetUserBounds ( )
virtual

◆ GetUserBounds() [2/3]

virtual void vtkControlPointsItem::GetUserBounds ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

◆ GetUserBounds() [3/3]

virtual void vtkControlPointsItem::GetUserBounds ( double  [4])
virtual

◆ SetValidBounds() [1/2]

virtual void vtkControlPointsItem::SetValidBounds ( double  ,
double  ,
double  ,
double   
)
virtual

Controls the valid range for the values.

An invalid value (0, -1, 0., -1, 0, -1.) indicates that the valid range is the current bounds. It is the default behavior.

◆ SetValidBounds() [2/2]

virtual void vtkControlPointsItem::SetValidBounds ( double  [4])
virtual

◆ GetValidBounds() [1/3]

virtual double* vtkControlPointsItem::GetValidBounds ( )
virtual

◆ GetValidBounds() [2/3]

virtual void vtkControlPointsItem::GetValidBounds ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

◆ GetValidBounds() [3/3]

virtual void vtkControlPointsItem::GetValidBounds ( double  [4])
virtual

◆ GetScreenPointRadius()

virtual float vtkControlPointsItem::GetScreenPointRadius ( )
virtual

Get/set the radius for screen points.

Default is 6.f

◆ SetScreenPointRadius()

virtual void vtkControlPointsItem::SetScreenPointRadius ( float  )
virtual

◆ Paint()

bool vtkControlPointsItem::Paint ( vtkContext2D painter)
overridevirtual

Paint the points with a fixed size (cosmetic) which doesn't depend on the scene zoom factor.

Selected and unselected points are drawn with a different color.

Reimplemented from vtkAbstractContextItem.

◆ SelectPoint() [1/2]

void vtkControlPointsItem::SelectPoint ( vtkIdType  pointId)

Select a point by its ID.

◆ SelectPoint() [2/2]

void vtkControlPointsItem::SelectPoint ( double *  currentPoint)

Utility function that selects a point providing its coordinates.

To be found, the position of the point must be no further away than its painted point size

◆ SelectAllPoints()

void vtkControlPointsItem::SelectAllPoints ( )

Select all the points.

◆ DeselectPoint() [1/2]

void vtkControlPointsItem::DeselectPoint ( vtkIdType  pointId)

Unselect a point by its ID.

◆ DeselectPoint() [2/2]

void vtkControlPointsItem::DeselectPoint ( double *  currentPoint)

Utility function that unselects a point providing its coordinates.

To be found, the position of the point must be no further away than its painted point size

◆ DeselectAllPoints()

void vtkControlPointsItem::DeselectAllPoints ( )

Unselect all the previously selected points.

◆ ToggleSelectPoint() [1/2]

void vtkControlPointsItem::ToggleSelectPoint ( vtkIdType  pointId)

Toggle the selection of a point by its ID.

If the point was selected then unselect it, otherwise select it.

◆ ToggleSelectPoint() [2/2]

void vtkControlPointsItem::ToggleSelectPoint ( double *  currentPoint)

Utility function that toggles the selection a point providing its coordinates.

To be found, the position of the point must be no further away than its painted point size

◆ SelectPoints()

bool vtkControlPointsItem::SelectPoints ( const vtkVector2f min,
const vtkVector2f max 
)
overridevirtual

Select all points in the specified rectangle.

Reimplemented from vtkPlot.

◆ GetNumberOfSelectedPoints()

vtkIdType vtkControlPointsItem::GetNumberOfSelectedPoints ( ) const

Return the number of selected points.

◆ FindPoint()

vtkIdType vtkControlPointsItem::FindPoint ( double *  pos)

Returns the vtkIdType of the point given its coordinates and a tolerance based on the screen point size.

◆ IsOverPoint()

bool vtkControlPointsItem::IsOverPoint ( double *  pos,
vtkIdType  pointId 
)

Returns true if pos is above the pointId point, false otherwise.

It uses the size of the drawn point. To search what point is under the pos, use the more efficient

See also
FindPoint() instead.

◆ GetControlPointId()

vtkIdType vtkControlPointsItem::GetControlPointId ( double *  pos)

Returns the id of the control point exactly matching pos, -1 if not found.

◆ GetControlPointsIds()

void vtkControlPointsItem::GetControlPointsIds ( vtkIdTypeArray ids,
bool  excludeFirstAndLast = false 
) const

Utility function that returns an array of all the control points IDs Typically: [0, 1, 2, ...

n -1] where n is the point count Can exclude the first and last point ids from the array.

◆ GetStrokeMode()

virtual bool vtkControlPointsItem::GetStrokeMode ( )
virtual

Controls whether or not control points are drawn (true) or clicked and moved (false).

False by default.

◆ SetSwitchPointsMode()

virtual void vtkControlPointsItem::SetSwitchPointsMode ( bool  )
virtual

If DrawPoints is false, SwitchPoints controls the behavior when a control point is dragged past another point.

The crossed point becomes current (true) or the current point is blocked/stopped (false). False by default.

◆ GetSwitchPointsMode()

virtual bool vtkControlPointsItem::GetSwitchPointsMode ( )
virtual

◆ SetEndPointsXMovable()

virtual void vtkControlPointsItem::SetEndPointsXMovable ( bool  )
virtual

If EndPointsMovable is false, the two end points will not be moved.

True by default.

◆ GetEndPointsXMovable()

virtual bool vtkControlPointsItem::GetEndPointsXMovable ( )
virtual

◆ SetEndPointsYMovable()

virtual void vtkControlPointsItem::SetEndPointsYMovable ( bool  )
virtual

◆ GetEndPointsYMovable()

virtual bool vtkControlPointsItem::GetEndPointsYMovable ( )
virtual

◆ GetEndPointsMovable()

virtual bool vtkControlPointsItem::GetEndPointsMovable ( )
virtual

◆ SetEndPointsRemovable()

virtual void vtkControlPointsItem::SetEndPointsRemovable ( bool  )
virtual

If EndPointsRemovable is false, the two end points will not be removed.

True by default.

◆ GetEndPointsRemovable()

virtual bool vtkControlPointsItem::GetEndPointsRemovable ( )
virtual

◆ SetShowLabels()

virtual void vtkControlPointsItem::SetShowLabels ( bool  )
virtual

When set to true, labels are shown on the current control point and the end points.

Default is false.

◆ GetShowLabels()

virtual bool vtkControlPointsItem::GetShowLabels ( )
virtual

◆ SetLabelFormat()

virtual void vtkControlPointsItem::SetLabelFormat ( const char *  )
virtual

Get/Set the label format.

Default is "%.4f, %.4f".

◆ GetLabelFormat()

virtual char* vtkControlPointsItem::GetLabelFormat ( )
virtual

◆ AddPoint()

virtual vtkIdType vtkControlPointsItem::AddPoint ( double *  newPos)
pure virtual

Add a point to the function.

Returns the index of the point (0 based), or -1 on error. Subclasses should reimplement this function to do the actual work.

Implemented in vtkCompositeControlPointsItem, vtkColorTransferControlPointsItem, and vtkPiecewiseControlPointsItem.

◆ RemovePoint() [1/2]

virtual vtkIdType vtkControlPointsItem::RemovePoint ( double *  pos)
pure virtual

Remove a point of the function.

Returns the index of the point (0 based), or -1 on error. Subclasses should reimplement this function to do the actual work.

Implemented in vtkCompositeControlPointsItem, vtkColorTransferControlPointsItem, and vtkPiecewiseControlPointsItem.

◆ RemovePoint() [2/2]

vtkIdType vtkControlPointsItem::RemovePoint ( vtkIdType  pointId)

Remove a point give its id.

It is a utility function that internally call the virtual method RemovePoint(double*) and return its result.

◆ RemoveCurrentPoint()

void vtkControlPointsItem::RemoveCurrentPoint ( )
inline

Remove the current point.

Definition at line 516 of file vtkControlPointsItem.h.

◆ GetNumberOfPoints()

virtual vtkIdType vtkControlPointsItem::GetNumberOfPoints ( ) const
pure virtual

Returns the total number of points.

Implemented in vtkCompositeControlPointsItem, vtkPiecewiseControlPointsItem, and vtkColorTransferControlPointsItem.

◆ GetControlPoint()

virtual void vtkControlPointsItem::GetControlPoint ( vtkIdType  index,
double *  point 
) const
pure virtual

Returns the x and y coordinates as well as the midpoint and sharpness of the control point corresponding to the index.

point must be a double array of size 4.

Implemented in vtkCompositeControlPointsItem, vtkPiecewiseControlPointsItem, and vtkColorTransferControlPointsItem.

◆ SetControlPoint()

virtual void vtkControlPointsItem::SetControlPoint ( vtkIdType  index,
double *  point 
)
pure virtual

Sets the x and y coordinates as well as the midpoint and sharpness of the control point corresponding to the index.

Implemented in vtkCompositeControlPointsItem, vtkPiecewiseControlPointsItem, and vtkColorTransferControlPointsItem.

◆ MovePoints() [1/2]

void vtkControlPointsItem::MovePoints ( const vtkVector2f translation,
vtkIdTypeArray pointIds 
)

Move the points referred by pointIds by a given translation.

The new positions won't be outside the bounds. MovePoints is typically called with GetControlPointsIds() or GetSelection(). Warning: if you pass this->GetSelection(), the array is deleted after each individual point move. Increase the reference count of the array. See also MoveAllPoints()

◆ MovePoints() [2/2]

void vtkControlPointsItem::MovePoints ( const vtkVector2f translation,
bool  dontMoveFirstAndLast = false 
)

Utility function to move all the control points of the given translation If dontMoveFirstAndLast is true, then the first and last points won't be moved.

◆ SpreadPoints() [1/2]

void vtkControlPointsItem::SpreadPoints ( float  factor,
vtkIdTypeArray pointIds 
)

Spread the points referred by pointIds If factor > 0, points are moved away from each other.

If factor < 0, points are moved closer to each other SpreadPoints is typically called with GetControlPointsIds() or GetSelection(). Warning: if you pass this->GetSelection(), the array is deleted after each individual point move. Increase the reference count of the array.

◆ SpreadPoints() [2/2]

void vtkControlPointsItem::SpreadPoints ( float  factor,
bool  dontSpreadFirstAndLast = false 
)

Utility function to spread all the control points of a given factor If dontSpreadFirstAndLast is true, then the first and last points won't be spread.

◆ GetCurrentPoint()

vtkIdType vtkControlPointsItem::GetCurrentPoint ( ) const

Returns the current point ID selected or -1 if there is no point current.

No current point by default.

◆ SetCurrentPoint()

void vtkControlPointsItem::SetCurrentPoint ( vtkIdType  index)

Sets the current point selected.

◆ GetSelectedPointPen()

virtual vtkPen* vtkControlPointsItem::GetSelectedPointPen ( )
virtual

Gets the selected point pen and brush.

◆ GetSelectedPointBrush()

virtual vtkBrush* vtkControlPointsItem::GetSelectedPointBrush ( )
virtual

Depending on the control points item, the brush might not be taken into account.

◆ GetUseAddPointItem()

virtual bool vtkControlPointsItem::GetUseAddPointItem ( )
virtual

When enabled, a dedicated item is used to determine if a point should be added when clicking anywhere.

This item can be recovered with GetAddPointItem and can this be placed below all other items. False by default.

◆ SetUseAddPointItem()

virtual void vtkControlPointsItem::SetUseAddPointItem ( bool  )
virtual

◆ UseAddPointItemOn()

virtual void vtkControlPointsItem::UseAddPointItemOn ( )
virtual

◆ UseAddPointItemOff()

virtual void vtkControlPointsItem::UseAddPointItemOff ( )
virtual

◆ GetAddPointItem()

vtkPlot* vtkControlPointsItem::GetAddPointItem ( )

Item dedicated to add point, to be added below all other items.

Used only if UseAddPointItem is set to true.

◆ ResetBounds()

void vtkControlPointsItem::ResetBounds ( )

Recompute the bounds next time they are requested.

You shouldn't have to call it but it is provided for rare cases.

◆ MouseButtonPressEvent()

bool vtkControlPointsItem::MouseButtonPressEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse and key events.

Reimplemented from vtkAbstractContextItem.

◆ MouseDoubleClickEvent()

bool vtkControlPointsItem::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.

◆ MouseButtonReleaseEvent()

bool vtkControlPointsItem::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.

◆ MouseMoveEvent()

bool vtkControlPointsItem::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.

◆ KeyPressEvent()

bool vtkControlPointsItem::KeyPressEvent ( const vtkContextKeyEvent key)
overridevirtual

Key press event.

Reimplemented from vtkAbstractContextItem.

◆ KeyReleaseEvent()

bool vtkControlPointsItem::KeyReleaseEvent ( const vtkContextKeyEvent key)
overridevirtual

Key release event.

Reimplemented from vtkAbstractContextItem.

◆ StartChanges()

void vtkControlPointsItem::StartChanges ( )
protected

◆ EndChanges()

void vtkControlPointsItem::EndChanges ( )
protected

◆ StartInteraction()

void vtkControlPointsItem::StartInteraction ( )
protected

◆ StartInteractionIfNotStarted()

void vtkControlPointsItem::StartInteractionIfNotStarted ( )
protected

◆ Interaction()

void vtkControlPointsItem::Interaction ( )
protected

◆ EndInteraction()

void vtkControlPointsItem::EndInteraction ( )
protected

◆ GetInteractionsCount()

int vtkControlPointsItem::GetInteractionsCount ( ) const
protected

◆ emitEvent()

virtual void vtkControlPointsItem::emitEvent ( unsigned long  event,
void *  params = nullptr 
)
protectedpure virtual

◆ CallComputePoints()

static void vtkControlPointsItem::CallComputePoints ( vtkObject sender,
unsigned long  event,
void *  receiver,
void *  params 
)
staticprotected

◆ ComputePoints()

virtual void vtkControlPointsItem::ComputePoints ( )
protectedvirtual

Must be reimplemented by subclasses to calculate the points to draw.

It's subclass responsibility to call ComputePoints() via the callback

◆ GetControlPointsMTime()

virtual vtkMTimeType vtkControlPointsItem::GetControlPointsMTime ( )
protectedpure virtual

◆ Hit()

bool vtkControlPointsItem::Hit ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

Returns true if the supplied x, y are within the bounds or on a control point.

If UseAddPointItem is true, returns true only if the supplied x, y are on a control point.

Reimplemented from vtkAbstractContextItem.

◆ ClampValidDataPos()

bool vtkControlPointsItem::ClampValidDataPos ( double  pos[2])
protected

Clamp the given 2D pos into the bounds of the function.

Return true if the pos has been clamped, false otherwise.

◆ ClampValidScreenPos()

bool vtkControlPointsItem::ClampValidScreenPos ( double  pos[2])
protected

◆ DrawUnselectedPoints()

void vtkControlPointsItem::DrawUnselectedPoints ( vtkContext2D painter)
protected

Internal function that paints a collection of points and optionally excludes some.

◆ DrawSelectedPoints()

void vtkControlPointsItem::DrawSelectedPoints ( vtkContext2D painter)
protected

◆ DrawPoint()

virtual void vtkControlPointsItem::DrawPoint ( vtkContext2D painter,
vtkIdType  index 
)
protectedvirtual

◆ SetCurrentPointPos()

void vtkControlPointsItem::SetCurrentPointPos ( const vtkVector2f newPos)
protected

◆ SetPointPos()

vtkIdType vtkControlPointsItem::SetPointPos ( vtkIdType  point,
const vtkVector2f newPos 
)
protected

◆ MoveCurrentPoint()

void vtkControlPointsItem::MoveCurrentPoint ( const vtkVector2f translation)
protected

◆ MovePoint()

vtkIdType vtkControlPointsItem::MovePoint ( vtkIdType  point,
const vtkVector2f translation 
)
protected

◆ GetSelectionCenterOfMass()

vtkVector2f vtkControlPointsItem::GetSelectionCenterOfMass ( ) const
inlineprotected

Definition at line 522 of file vtkControlPointsItem.h.

◆ GetCenterOfMass()

vtkVector2f vtkControlPointsItem::GetCenterOfMass ( vtkIdTypeArray pointIDs) const
protected

◆ Stroke()

void vtkControlPointsItem::Stroke ( const vtkVector2f newPos)
protected

◆ EditPoint()

virtual void vtkControlPointsItem::EditPoint ( float   vtkNotUsedtX,
float   vtkNotUsedtY 
)
protectedvirtual

◆ GetControlPointLabel()

virtual vtkStdString vtkControlPointsItem::GetControlPointLabel ( vtkIdType  index)
protectedvirtual

Generate label for a control point.

◆ AddPointId()

void vtkControlPointsItem::AddPointId ( vtkIdType  addedPointId)
protected

◆ IsEndPointPicked()

bool vtkControlPointsItem::IsEndPointPicked ( )
protected

Return true if any of the end points is current point or part of the selection.

◆ IsPointRemovable()

bool vtkControlPointsItem::IsPointRemovable ( vtkIdType  pointId)
protected

Return true if the point is removable.

◆ ComputeBounds()

virtual void vtkControlPointsItem::ComputeBounds ( double *  bounds)
protectedvirtual

Compute the bounds for this item.

Typically, the bounds should be aligned to the range of the vtkScalarsToColors or vtkPiecewiseFunction that is being controlled by the subclasses. Default implementation uses the range of the control points themselves.

Reimplemented in vtkColorTransferControlPointsItem.

Friends And Related Function Documentation

◆ vtkPiecewisePointHandleItem

friend class vtkPiecewisePointHandleItem
friend

Definition at line 387 of file vtkControlPointsItem.h.

Member Data Documentation

◆ Callback

vtkCallbackCommand* vtkControlPointsItem::Callback
protected

Definition at line 473 of file vtkControlPointsItem.h.

◆ SelectedPointPen

vtkPen* vtkControlPointsItem::SelectedPointPen
protected

Definition at line 474 of file vtkControlPointsItem.h.

◆ SelectedPointBrush

vtkBrush* vtkControlPointsItem::SelectedPointBrush
protected

Definition at line 475 of file vtkControlPointsItem.h.

◆ BlockUpdates

int vtkControlPointsItem::BlockUpdates
protected

Definition at line 476 of file vtkControlPointsItem.h.

◆ StartedInteractions

int vtkControlPointsItem::StartedInteractions
protected

Definition at line 477 of file vtkControlPointsItem.h.

◆ StartedChanges

int vtkControlPointsItem::StartedChanges
protected

Definition at line 478 of file vtkControlPointsItem.h.

◆ CurrentPoint

vtkIdType vtkControlPointsItem::CurrentPoint
protected

Definition at line 479 of file vtkControlPointsItem.h.

◆ Bounds

double vtkControlPointsItem::Bounds[4]
protected

Definition at line 481 of file vtkControlPointsItem.h.

◆ UserBounds

double vtkControlPointsItem::UserBounds[4]
protected

Definition at line 482 of file vtkControlPointsItem.h.

◆ ValidBounds

double vtkControlPointsItem::ValidBounds[4]
protected

Definition at line 483 of file vtkControlPointsItem.h.

◆ Transform

vtkTransform2D* vtkControlPointsItem::Transform
protected

Definition at line 485 of file vtkControlPointsItem.h.

◆ ScreenPointRadius

float vtkControlPointsItem::ScreenPointRadius
protected

Definition at line 486 of file vtkControlPointsItem.h.

◆ StrokeMode

bool vtkControlPointsItem::StrokeMode
protected

Definition at line 488 of file vtkControlPointsItem.h.

◆ SwitchPointsMode

bool vtkControlPointsItem::SwitchPointsMode
protected

Definition at line 489 of file vtkControlPointsItem.h.

◆ MouseMoved

bool vtkControlPointsItem::MouseMoved
protected

Definition at line 490 of file vtkControlPointsItem.h.

◆ EnforceValidFunction

bool vtkControlPointsItem::EnforceValidFunction
protected

Definition at line 491 of file vtkControlPointsItem.h.

◆ PointToDelete

vtkIdType vtkControlPointsItem::PointToDelete
protected

Definition at line 492 of file vtkControlPointsItem.h.

◆ PointAboutToBeDeleted

bool vtkControlPointsItem::PointAboutToBeDeleted
protected

Definition at line 493 of file vtkControlPointsItem.h.

◆ PointToToggle

vtkIdType vtkControlPointsItem::PointToToggle
protected

Definition at line 494 of file vtkControlPointsItem.h.

◆ PointAboutToBeToggled

bool vtkControlPointsItem::PointAboutToBeToggled
protected

Definition at line 495 of file vtkControlPointsItem.h.

◆ InvertShadow

bool vtkControlPointsItem::InvertShadow
protected

Definition at line 496 of file vtkControlPointsItem.h.

◆ EndPointsXMovable

bool vtkControlPointsItem::EndPointsXMovable
protected

Definition at line 497 of file vtkControlPointsItem.h.

◆ EndPointsYMovable

bool vtkControlPointsItem::EndPointsYMovable
protected

Definition at line 498 of file vtkControlPointsItem.h.

◆ EndPointsRemovable

bool vtkControlPointsItem::EndPointsRemovable
protected

Definition at line 499 of file vtkControlPointsItem.h.

◆ ShowLabels

bool vtkControlPointsItem::ShowLabels
protected

Definition at line 500 of file vtkControlPointsItem.h.

◆ LabelFormat

char* vtkControlPointsItem::LabelFormat
protected

Definition at line 501 of file vtkControlPointsItem.h.


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