VTK
|
Abstract class for control points items. More...
#include <vtkControlPointsItem.h>
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... | |
vtkControlPointsItem * | NewInstance () 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... | |
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 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... | |
void | ResetBounds () |
Recompute the bounds next time they are requested. 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... | |
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]) |
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 double * | GetUserBounds () |
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 | GetUserBounds (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 | GetUserBounds (double[4]) |
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 | SetValidBounds (double, double, double, double) |
Controls the valid range for the values. More... | |
virtual void | SetValidBounds (double[4]) |
Controls the valid range for the values. More... | |
virtual double * | GetValidBounds () |
Controls the valid range for the values. More... | |
virtual void | GetValidBounds (double &, double &, double &, double &) |
Controls the valid range for the values. More... | |
virtual void | GetValidBounds (double[4]) |
Controls the valid range for the values. More... | |
virtual float | GetScreenPointRadius () |
Get/set the radius for screen points. More... | |
virtual void | SetScreenPointRadius (float) |
Get/set the radius for screen points. 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 () |
If DrawPoints is false, SwitchPoints controls the behavior when a control point is dragged past another point. More... | |
virtual void | SetEndPointsXMovable (bool) |
If EndPointsMovable is false, the two end points will not be moved. More... | |
virtual bool | GetEndPointsXMovable () |
If EndPointsMovable is false, the two end points will not be moved. More... | |
virtual void | SetEndPointsYMovable (bool) |
If EndPointsMovable is false, the two end points will not be moved. More... | |
virtual bool | GetEndPointsYMovable () |
If EndPointsMovable is false, the two end points will not be moved. More... | |
virtual bool | GetEndPointsMovable () |
If EndPointsMovable is false, the two end points will not be moved. More... | |
virtual void | SetEndPointsRemovable (bool) |
If EndPointsRemovable is false, the two end points will not be removed. More... | |
virtual bool | GetEndPointsRemovable () |
If EndPointsRemovable is false, the two end points will not be removed. More... | |
virtual void | SetShowLabels (bool) |
When set to true, labels are shown on the current control point and the end points. More... | |
virtual bool | GetShowLabels () |
When set to true, labels are shown on the current control point and the end points. More... | |
virtual void | SetLabelFormat (const char *) |
Get/Set the label format. More... | |
virtual char * | GetLabelFormat () |
Get/Set the label format. More... | |
virtual vtkPen * | GetSelectedPointPen () |
Gets the selected point pen and brush. More... | |
virtual vtkBrush * | GetSelectedPointBrush () |
Depending on the control points item, the brush might not be taken into account. More... | |
bool | MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override |
Mouse button down event. More... | |
bool | MouseDoubleClickEvent (const vtkContextMouseEvent &mouse) override |
Mouse button down event. More... | |
Public Member Functions inherited from vtkPlot | |
vtkPlot * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
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 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) |
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 | SetWidth (float width) |
Set the width of the line. More... | |
virtual float | GetWidth () |
Get the width of the line. More... | |
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 vtkStringArray * | GetLabels () |
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 vtkStringArray * | GetIndexedLabels () |
Get the indexed labels array. More... | |
vtkContextMapper2D * | GetData () |
Get the data object that the plot will draw. More... | |
virtual vtkTable * | GetInput () |
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 | 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 | SetLegendVisibility (bool) |
Set whether the plot renders an entry in the legend. More... | |
virtual bool | GetLegendVisibility () |
Set whether the plot renders an entry in the legend. More... | |
virtual void | LegendVisibilityOn () |
Set whether the plot renders an entry in the legend. More... | |
virtual void | LegendVisibilityOff () |
Set whether the plot renders an entry in the legend. More... | |
virtual void | SetTooltipLabelFormat (const vtkStdString &label) |
Sets/gets a printf-style string to build custom tooltip labels from. More... | |
virtual vtkStdString | GetTooltipLabelFormat () |
Sets/gets a printf-style string to build custom tooltip labels from. More... | |
virtual void | SetTooltipNotation (int notation) |
Sets/gets the tooltip notation style. More... | |
virtual int | GetTooltipNotation () |
Sets/gets the tooltip notation style. More... | |
virtual void | SetTooltipPrecision (int precision) |
Sets/gets the tooltip precision. More... | |
virtual int | GetTooltipPrecision () |
Sets/gets the tooltip precision. 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) |
Set the plot color. More... | |
virtual void | GetColor (double rgb[3]) |
Set the plot color. More... | |
void | GetColor (unsigned char rgb[3]) |
Set the plot color. More... | |
void | SetPen (vtkPen *pen) |
Set/get the vtkPen object that controls how this plot draws (out)lines. More... | |
vtkPen * | GetPen () |
Set/get the vtkPen object that controls how this plot draws (out)lines. More... | |
void | SetBrush (vtkBrush *brush) |
Set/get the vtkBrush object that controls how this plot fills shapes. More... | |
vtkBrush * | GetBrush () |
Set/get the vtkBrush object that controls how this plot fills shapes. More... | |
void | SetSelectionPen (vtkPen *pen) |
Set/get the vtkBrush object that controls how this plot fills selected shapes. More... | |
vtkPen * | GetSelectionPen () |
Set/get the vtkBrush object that controls how this plot fills selected shapes. More... | |
void | SetSelectionBrush (vtkBrush *brush) |
Set/get the vtkBrush object that controls how this plot fills selected shapes. More... | |
vtkBrush * | GetSelectionBrush () |
Set/get the vtkBrush object that controls how this plot fills selected shapes. 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) |
This is a convenience function to set the input table and the x, y column for the plot. More... | |
void | SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn) |
This is a convenience function to set the input table and the x, y column for the plot. More... | |
virtual void | SetSelectable (bool) |
Set whether the plot can be selected. More... | |
virtual bool | GetSelectable () |
Set whether the plot can be selected. More... | |
virtual void | SelectableOn () |
Set whether the plot can be selected. More... | |
virtual void | SelectableOff () |
Set whether the plot can be selected. More... | |
virtual void | SetSelection (vtkIdTypeArray *id) |
Sets the list of points that must be selected. More... | |
virtual vtkIdTypeArray * | GetSelection () |
Sets the list of points that must be selected. More... | |
virtual vtkAxis * | GetXAxis () |
Get/set the X axis associated with this plot. More... | |
virtual void | SetXAxis (vtkAxis *axis) |
Get/set the X axis associated with this plot. More... | |
virtual vtkAxis * | GetYAxis () |
Get/set the Y axis associated with this plot. More... | |
virtual void | SetYAxis (vtkAxis *axis) |
Get/set the Y axis associated with this plot. More... | |
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 () |
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... | |
virtual void | SetProperty (const vtkStdString &property, const vtkVariant &var) |
A General setter/getter that should be overridden. More... | |
virtual vtkVariant | GetProperty (const vtkStdString &property) |
A General setter/getter that should be overridden. More... | |
Public Member Functions inherited from vtkContextItem | |
vtkContextItem * | NewInstance () 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 | |
vtkAbstractContextItem * | NewInstance () 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... | |
vtkAbstractContextItem * | GetItem (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 vtkAbstractContextItem * | GetPickedItem (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... | |
vtkContextScene * | GetScene () |
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... | |
vtkAbstractContextItem * | GetParent () |
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... | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
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) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
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) |
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, 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) |
This method invokes an event and return whether the event was aborted or not. More... | |
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 | 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... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkControlPointsItem * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkPlot | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkPlot * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkContextItem | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkContextItem * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkAbstractContextItem | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkAbstractContextItem * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
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 () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () 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 |
bool | Hit (const vtkContextMouseEvent &mouse) override |
Returns true if the supplied x, y coordinate is on a control point. More... | |
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)) |
bool | MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override |
Mouse button release event. More... | |
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... | |
virtual void | ComputePoints () |
Must be reimplemented by subclasses to calculate the points to draw. More... | |
virtual vtkMTimeType | GetControlPointsMTime ()=0 |
Must be reimplemented by subclasses to calculate the points to draw. 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) |
Transform the mouse event in the control-points space. More... | |
virtual void | TransformScreenToData (const double inX, const double inY, double &outX, double &outY) |
Transform the mouse event in the control-points space. More... | |
virtual void | TransformDataToScreen (const double inX, const double inY, double &outX, double &outY) |
Transform the mouse event in the control-points space. More... | |
virtual bool | ClampPos (double pos[2], double bounds[4]) |
Clamp the given 2D pos into the bounds of the function. More... | |
bool | ClampValidDataPos (double pos[2]) |
Clamp the given 2D pos into the bounds of the function. More... | |
bool | ClampValidScreenPos (double pos[2]) |
Clamp the given 2D pos into the bounds of the function. More... | |
void | DrawUnselectedPoints (vtkContext2D *painter) |
Internal function that paints a collection of points and optionally excludes some. More... | |
void | DrawSelectedPoints (vtkContext2D *painter) |
Internal function that paints a collection of points and optionally excludes some. More... | |
virtual void | DrawPoint (vtkContext2D *painter, vtkIdType index) |
Internal function that paints a collection of points and optionally excludes some. 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... | |
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 () |
These methods allow a command to exclusively grab all events. More... | |
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 | |
vtkCallbackCommand * | Callback |
vtkPen * | SelectedPointPen |
vtkBrush * | SelectedPointBrush |
int | BlockUpdates |
int | StartedInteractions |
int | StartedChanges |
vtkIdType | CurrentPoint |
double | Bounds [4] |
double | UserBounds [4] |
double | ValidBounds [4] |
vtkTransform2D * | Transform |
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< vtkPen > | Pen |
This object stores the vtkPen that controls how the plot is drawn. More... | |
vtkSmartPointer< vtkBrush > | Brush |
This object stores the vtkBrush that controls how the plot is drawn. More... | |
vtkSmartPointer< vtkPen > | SelectionPen |
This object stores the vtkPen that controls how the selected elements of the plot are drawn. More... | |
vtkSmartPointer< vtkBrush > | SelectionBrush |
This object stores the vtkBrush that controls how the selected elements of the plot are drawn. More... | |
vtkSmartPointer< vtkStringArray > | Labels |
Plot labels, used by legend. More... | |
vtkSmartPointer< vtkStringArray > | AutoLabels |
Holds Labels when they're auto-created. More... | |
vtkSmartPointer< vtkStringArray > | IndexedLabels |
Holds Labels when they're auto-created. More... | |
bool | UseIndexForXSeries |
Use the Y array index for the X value. More... | |
vtkSmartPointer< vtkContextMapper2D > | Data |
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... | |
vtkIdTypeArray * | Selection |
Selected indices for the table the plot is rendering. More... | |
vtkAxis * | XAxis |
The X axis associated with this plot. More... | |
vtkAxis * | YAxis |
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 |
Protected Attributes inherited from vtkContextItem | |
double | Opacity |
Protected Attributes inherited from vtkAbstractContextItem | |
vtkContextScene * | Scene |
Point to the scene the item is on - can be null. More... | |
vtkAbstractContextItem * | Parent |
Point to the parent item - can be null. More... | |
vtkContextScenePrivate * | Children |
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 | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Friends | |
class | vtkPiecewisePointHandleItem |
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)
Definition at line 45 of file vtkControlPointsItem.h.
Definition at line 48 of file vtkControlPointsItem.h.
anonymous enum |
Enumerator | |
---|---|
CurrentPointChangedEvent | |
CurrentPointEditEvent |
Definition at line 57 of file vtkControlPointsItem.h.
|
protected |
|
overrideprotected |
|
static |
|
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, vtkPiecewiseControlPointsItem, and vtkColorTransferControlPointsItem.
|
static |
|
protectedvirtual |
Reimplemented from vtkPlot.
Reimplemented in vtkCompositeControlPointsItem, vtkPiecewiseControlPointsItem, and vtkColorTransferControlPointsItem.
vtkControlPointsItem* vtkControlPointsItem::NewInstance | ( | ) | const |
|
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.
|
overridevirtual |
Bounds of the item, typically the bound of all the control points except if custom bounds have been set.
Reimplemented from vtkPlot.
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.
|
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.
|
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.
|
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.
|
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.
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.
|
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.
|
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.
|
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.
|
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.
|
virtual |
Get/set the radius for screen points.
Default is 6.f
|
virtual |
Get/set the radius for screen points.
Default is 6.f
|
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.
void vtkControlPointsItem::SelectPoint | ( | vtkIdType | pointId | ) |
Select a point by its ID.
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
void vtkControlPointsItem::SelectAllPoints | ( | ) |
Select all the points.
void vtkControlPointsItem::DeselectPoint | ( | vtkIdType | pointId | ) |
Unselect a point by its ID.
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
void vtkControlPointsItem::DeselectAllPoints | ( | ) |
Unselect all the previously selected points.
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.
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
|
overridevirtual |
Select all points in the specified rectangle.
Reimplemented from vtkPlot.
vtkIdType vtkControlPointsItem::GetNumberOfSelectedPoints | ( | ) | const |
Return the number of selected points.
Returns the vtkIdType of the point given its coordinates and a tolerance based on the screen point size.
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
Returns the id of the control point exactly matching pos, -1 if not found.
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.
|
virtual |
Controls whether or not control points are drawn (true) or clicked and moved (false).
False by default.
|
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.
|
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.
|
virtual |
If EndPointsMovable is false, the two end points will not be moved.
True by default.
|
virtual |
If EndPointsMovable is false, the two end points will not be moved.
True by default.
|
virtual |
If EndPointsMovable is false, the two end points will not be moved.
True by default.
|
virtual |
If EndPointsMovable is false, the two end points will not be moved.
True by default.
|
virtual |
If EndPointsMovable is false, the two end points will not be moved.
True by default.
|
virtual |
If EndPointsRemovable is false, the two end points will not be removed.
True by default.
|
virtual |
If EndPointsRemovable is false, the two end points will not be removed.
True by default.
|
virtual |
When set to true, labels are shown on the current control point and the end points.
Default is false.
|
virtual |
When set to true, labels are shown on the current control point and the end points.
Default is false.
|
virtual |
Get/Set the label format.
Default is "%.4f, %.4f".
|
virtual |
Get/Set the label format.
Default is "%.4f, %.4f".
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.
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.
Remove a point give its id.
It is a utility function that internally call the virtual method RemovePoint(double*) and return its result.
|
inline |
Remove the current point.
Definition at line 514 of file vtkControlPointsItem.h.
|
pure virtual |
Returns the total number of points.
Implemented in vtkCompositeControlPointsItem, vtkPiecewiseControlPointsItem, and vtkColorTransferControlPointsItem.
|
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.
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.
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()
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.
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.
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.
vtkIdType vtkControlPointsItem::GetCurrentPoint | ( | ) | const |
Returns the current point ID selected or -1 if there is no point current.
No current point by default.
void vtkControlPointsItem::SetCurrentPoint | ( | vtkIdType | index | ) |
Sets the current point selected.
|
virtual |
Gets the selected point pen and brush.
|
virtual |
Depending on the control points item, the brush might not be taken into account.
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.
|
overridevirtual |
Mouse button down event.
Reimplemented from vtkAbstractContextItem.
|
overridevirtual |
Mouse button down event.
Reimplemented from vtkAbstractContextItem.
|
overridevirtual |
Mouse move event.
Reimplemented from vtkAbstractContextItem.
|
overridevirtual |
Key press event.
Reimplemented from vtkAbstractContextItem.
|
overridevirtual |
Key release event.
Reimplemented from vtkAbstractContextItem.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protectedpure virtual |
Implemented in vtkCompositeControlPointsItem, vtkColorTransferControlPointsItem, and vtkPiecewiseControlPointsItem.
|
staticprotected |
|
protectedvirtual |
Must be reimplemented by subclasses to calculate the points to draw.
It's subclass responsibility to call ComputePoints() via the callback
|
protectedpure virtual |
Must be reimplemented by subclasses to calculate the points to draw.
It's subclass responsibility to call ComputePoints() via the callback
Implemented in vtkCompositeControlPointsItem, vtkColorTransferControlPointsItem, and vtkPiecewiseControlPointsItem.
|
overrideprotectedvirtual |
Returns true if the supplied x, y coordinate is on a control point.
Reimplemented from vtkAbstractContextItem.
|
protectedvirtual |
Transform the mouse event in the control-points space.
This is needed when ColorTransferFunction is using log-scale or shifted/scaled.
|
protectedvirtual |
Transform the mouse event in the control-points space.
This is needed when ColorTransferFunction is using log-scale or shifted/scaled.
|
protectedvirtual |
Transform the mouse event in the control-points space.
This is needed when ColorTransferFunction is using log-scale or shifted/scaled.
|
protectedvirtual |
Transform the mouse event in the control-points space.
This is needed when ColorTransferFunction is using log-scale or shifted/scaled.
Clamp the given 2D pos into the bounds of the function.
Return true if the pos has been clamped, false otherwise.
|
protected |
Clamp the given 2D pos into the bounds of the function.
Return true if the pos has been clamped, false otherwise.
|
protected |
Clamp the given 2D pos into the bounds of the function.
Return true if the pos has been clamped, false otherwise.
|
protected |
Internal function that paints a collection of points and optionally excludes some.
|
protected |
Internal function that paints a collection of points and optionally excludes some.
|
protectedvirtual |
Internal function that paints a collection of points and optionally excludes some.
Reimplemented in vtkCompositeControlPointsItem, and vtkColorTransferControlPointsItem.
|
protected |
|
protected |
|
protected |
|
protected |
|
inlineprotected |
Definition at line 520 of file vtkControlPointsItem.h.
|
protected |
|
protected |
|
protectedvirtual |
|
overrideprotectedvirtual |
Mouse button release event.
Reimplemented from vtkAbstractContextItem.
|
protectedvirtual |
Generate label for a control point.
|
protected |
|
protected |
Return true if any of the end points is current point or part of the selection.
|
protected |
Return true if the point is removable.
|
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.
|
friend |
Definition at line 374 of file vtkControlPointsItem.h.
|
protected |
Definition at line 475 of file vtkControlPointsItem.h.
|
protected |
Definition at line 476 of file vtkControlPointsItem.h.
|
protected |
Definition at line 477 of file vtkControlPointsItem.h.
|
protected |
Definition at line 478 of file vtkControlPointsItem.h.
|
protected |
Definition at line 479 of file vtkControlPointsItem.h.
|
protected |
Definition at line 480 of file vtkControlPointsItem.h.
|
protected |
Definition at line 481 of file vtkControlPointsItem.h.
|
protected |
Definition at line 483 of file vtkControlPointsItem.h.
|
protected |
Definition at line 484 of file vtkControlPointsItem.h.
|
protected |
Definition at line 485 of file vtkControlPointsItem.h.
|
protected |
Definition at line 487 of file vtkControlPointsItem.h.
|
protected |
Definition at line 488 of file vtkControlPointsItem.h.
|
protected |
Definition at line 490 of file vtkControlPointsItem.h.
|
protected |
Definition at line 491 of file vtkControlPointsItem.h.
|
protected |
Definition at line 492 of file vtkControlPointsItem.h.
|
protected |
Definition at line 493 of file vtkControlPointsItem.h.
|
protected |
Definition at line 494 of file vtkControlPointsItem.h.
|
protected |
Definition at line 495 of file vtkControlPointsItem.h.
|
protected |
Definition at line 496 of file vtkControlPointsItem.h.
|
protected |
Definition at line 497 of file vtkControlPointsItem.h.
|
protected |
Definition at line 498 of file vtkControlPointsItem.h.
|
protected |
Definition at line 499 of file vtkControlPointsItem.h.
|
protected |
Definition at line 500 of file vtkControlPointsItem.h.
|
protected |
Definition at line 501 of file vtkControlPointsItem.h.
|
protected |
Definition at line 502 of file vtkControlPointsItem.h.
|
protected |
Definition at line 503 of file vtkControlPointsItem.h.