VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | 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 Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkControlPointsItem * NewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void GetBounds (double bounds[4])
 
virtual bool Paint (vtkContext2D *painter)
 
void SelectPoint (vtkIdType pointId)
 
void SelectPoint (double *currentPoint)
 
void SelectAllPoints ()
 
void DeselectPoint (vtkIdType pointId)
 
void DeselectPoint (double *currentPoint)
 
void DeselectAllPoints ()
 
void ToggleSelectPoint (vtkIdType pointId)
 
void ToggleSelectPoint (double *currentPoint)
 
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
 
vtkIdType GetNumberOfSelectedPoints () const
 
vtkIdType FindPoint (double *pos)
 
bool IsOverPoint (double *pos, vtkIdType pointId)
 
vtkIdType GetControlPointId (double *pos)
 
virtual vtkIdType AddPoint (double *newPos)=0
 
virtual vtkIdType RemovePoint (double *pos)=0
 
vtkIdType RemovePoint (vtkIdType pointId)
 
void RemoveCurrentPoint ()
 
virtual vtkIdType GetNumberOfPoints () const =0
 
virtual void GetControlPoint (vtkIdType index, double *point) const =0
 
virtual void SetControlPoint (vtkIdType index, double *point)=0
 
void MovePoints (const vtkVector2f &translation, vtkIdTypeArray *pointIds)
 
void MovePoints (const vtkVector2f &translation, bool dontMoveFirstAndLast=false)
 
void SpreadPoints (float factor, vtkIdTypeArray *pointIds)
 
void SpreadPoints (float factor, bool dontSpreadFirstAndLast=false)
 
vtkIdType GetCurrentPoint () const
 
void SetCurrentPoint (vtkIdType index)
 
void ResetBounds ()
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 
virtual void SetUserBounds (double, double, double, double)
 
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)
 
virtual void SetValidBounds (double[4])
 
virtual double * GetValidBounds ()
 
virtual void GetValidBounds (double &, double &, double &, double &)
 
virtual void GetValidBounds (double[4])
 
virtual float GetScreenPointRadius ()
 
virtual void SetScreenPointRadius (float)
 
void GetControlPointsIds (vtkIdTypeArray *ids, bool excludeFirstAndLast=false) const
 
virtual bool GetStrokeMode ()
 
virtual void SetSwitchPointsMode (bool)
 
virtual bool GetSwitchPointsMode ()
 
virtual void SetEndPointsXMovable (bool)
 
virtual bool GetEndPointsXMovable ()
 
virtual void SetEndPointsYMovable (bool)
 
virtual bool GetEndPointsYMovable ()
 
virtual bool GetEndPointsMovable ()
 
virtual void SetEndPointsRemovable (bool)
 
virtual bool GetEndPointsRemovable ()
 
virtual void SetShowLabels (bool)
 
virtual bool GetShowLabels ()
 
virtual void SetLabelFormat (const char *)
 
virtual char * GetLabelFormat ()
 
virtual vtkPen * GetSelectedPointPen ()
 
virtual vtkBrush * GetSelectedPointBrush ()
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 
- Public Member Functions inherited from vtkPlot
vtkPlot * NewInstance () const
 
virtual void SetWidth (float width)
 
virtual float GetWidth ()
 
virtual void SetLabel (const vtkStdString &label)
 
virtual vtkStdString GetLabel ()
 
virtual void SetLabels (vtkStringArray *labels)
 
virtual vtkStringArray * GetLabels ()
 
virtual int GetNumberOfLabels ()
 
vtkStdString GetLabel (vtkIdType index)
 
void SetIndexedLabels (vtkStringArray *labels)
 
virtual vtkStringArray * GetIndexedLabels ()
 
vtkContextMapper2D * GetData ()
 
virtual vtkTable * GetInput ()
 
virtual void SetInputArray (int index, const vtkStdString &name)
 
virtual void UpdateCache ()
 
virtual void SetLegendVisibility (bool)
 
virtual bool GetLegendVisibility ()
 
virtual void LegendVisibilityOn ()
 
virtual void LegendVisibilityOff ()
 
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
 
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 
virtual vtkStdString GetTooltipLabelFormat ()
 
virtual void SetTooltipNotation (int notation)
 
virtual int GetTooltipNotation ()
 
virtual void SetTooltipPrecision (int precision)
 
virtual int GetTooltipPrecision ()
 
virtual vtkStdString GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
 
virtual bool SelectPointsInPolygon (const vtkContextPolygon &polygon)
 
virtual void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
virtual void SetColor (double r, double g, double b)
 
virtual void GetColor (double rgb[3])
 
void GetColor (unsigned char rgb[3])
 
void SetPen (vtkPen *pen)
 
vtkPen * GetPen ()
 
void SetBrush (vtkBrush *brush)
 
vtkBrush * GetBrush ()
 
void SetSelectionPen (vtkPen *pen)
 
vtkPen * GetSelectionPen ()
 
void SetSelectionBrush (vtkBrush *brush)
 
vtkBrush * GetSelectionBrush ()
 
virtual bool GetUseIndexForXSeries ()
 
virtual void SetUseIndexForXSeries (bool)
 
virtual void SetInputData (vtkTable *table)
 
virtual void SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
 
void SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
 
virtual void SetSelectable (bool)
 
virtual bool GetSelectable ()
 
virtual void SelectableOn ()
 
virtual void SelectableOff ()
 
virtual void SetSelection (vtkIdTypeArray *id)
 
virtual vtkIdTypeArray * GetSelection ()
 
virtual vtkAxis * GetXAxis ()
 
virtual void SetXAxis (vtkAxis *axis)
 
virtual vtkAxis * GetYAxis ()
 
virtual void SetYAxis (vtkAxis *axis)
 
void SetShiftScale (const vtkRectd &scaling)
 
vtkRectd GetShiftScale ()
 
virtual void GetUnscaledInputBounds (double bounds[4])
 
virtual void SetProperty (const vtkStdString &property, const vtkVariant &var)
 
virtual vtkVariant GetProperty (const vtkStdString &property)
 
- Public Member Functions inherited from vtkContextItem
vtkContextItem * NewInstance () const
 
virtual double GetOpacity ()
 
virtual void SetOpacity (double)
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItem * NewInstance () const
 
virtual void Update ()
 
virtual bool PaintChildren (vtkContext2D *painter)
 
virtual void ReleaseGraphicsResources ()
 
unsigned int AddItem (vtkAbstractContextItem *item)
 
bool RemoveItem (vtkAbstractContextItem *item)
 
bool RemoveItem (unsigned int index)
 
vtkAbstractContextItem * GetItem (unsigned int index)
 
unsigned int GetItemIndex (vtkAbstractContextItem *item)
 
unsigned int GetNumberOfItems ()
 
void ClearItems ()
 
unsigned int Raise (unsigned int index)
 
unsigned int Lower (unsigned int index)
 
virtual vtkAbstractContextItem * GetPickedItem (const vtkContextMouseEvent &mouse)
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 
virtual void SetScene (vtkContextScene *scene)
 
virtual void SetParent (vtkAbstractContextItem *parent)
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 
virtual unsigned int StackAbove (unsigned int index, unsigned int under)
 
virtual unsigned int StackUnder (unsigned int child, unsigned int above)
 
vtkContextScene * GetScene ()
 
vtkAbstractContextItem * GetParent ()
 
virtual bool GetVisible ()
 
virtual void SetVisible (bool)
 
virtual bool GetInteractive ()
 
virtual void SetInteractive (bool)
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkControlPointsItem * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPlot
static int IsTypeOf (const char *type)
 
static vtkPlot * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkContextItem
static int IsTypeOf (const char *type)
 
static vtkContextItem * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static int IsTypeOf (const char *type)
 
static vtkAbstractContextItem * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkControlPointsItem ()
 
virtual ~vtkControlPointsItem ()
 
void StartChanges ()
 
void EndChanges ()
 
void StartInteraction ()
 
void StartInteractionIfNotStarted ()
 
void Interaction ()
 
void EndInteraction ()
 
int GetInteractionsCount () const
 
virtual void emitEvent (unsigned long event, void *params=0)=0
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 
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 bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 
virtual vtkStdString GetControlPointLabel (vtkIdType index)
 
void AddPointId (vtkIdType addedPointId)
 
bool IsEndPointPicked ()
 
bool IsPointRemovable (vtkIdType pointId)
 
virtual void ComputeBounds (double *bounds)
 
virtual bool UsingLogScale ()
 
virtual void ComputePoints ()
 
virtual unsigned long int GetControlPointsMTime ()=0
 
virtual void TransformScreenToData (const vtkVector2f &in, vtkVector2f &out)
 
virtual void TransformDataToScreen (const vtkVector2f &in, vtkVector2f &out)
 
virtual bool ClampPos (double pos[2], double bounds[4])
 
bool ClampValidPos (double pos[2])
 
void DrawUnselectedPoints (vtkContext2D *painter)
 
void DrawSelectedPoints (vtkContext2D *painter)
 
virtual void DrawPoint (vtkContext2D *painter, vtkIdType index)
 
- Protected Member Functions inherited from vtkPlot
 vtkPlot ()
 
 ~vtkPlot ()
 
vtkStdString GetNumber (double position, vtkAxis *axis)
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem ()
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

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
 
vtkSmartPointer< vtkBrush > Brush
 
vtkSmartPointer< vtkPen > SelectionPen
 
vtkSmartPointer< vtkBrush > SelectionBrush
 
vtkSmartPointer< vtkStringArray > Labels
 
vtkSmartPointer< vtkStringArray > AutoLabels
 
vtkSmartPointer< vtkStringArray > IndexedLabels
 
bool UseIndexForXSeries
 
vtkSmartPointer< vtkContextMapper2D > Data
 
bool Selectable
 
vtkIdTypeArray * Selection
 
vtkAxis * XAxis
 
vtkAxis * YAxis
 
vtkStdString TooltipLabelFormat
 
vtkStdString TooltipDefaultLabelFormat
 
int TooltipNotation
 
int TooltipPrecision
 
vtkRectd ShiftScale
 
bool LegendVisibility
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene * Scene
 
vtkAbstractContextItem * Parent
 
vtkContextScenePrivate * Children
 
bool Visible
 
bool Interactive
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

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
Tests:
vtkControlPointsItem (Tests)

Definition at line 43 of file vtkControlPointsItem.h.

Member Typedef Documentation

typedef vtkPlot vtkControlPointsItem::Superclass

Definition at line 46 of file vtkControlPointsItem.h.

Member Enumeration Documentation

anonymous enum
Enumerator
CurrentPointChangedEvent 
CurrentPointEditEvent 

Definition at line 55 of file vtkControlPointsItem.h.

Constructor & Destructor Documentation

vtkControlPointsItem::vtkControlPointsItem ( )
protected
virtual vtkControlPointsItem::~vtkControlPointsItem ( )
protectedvirtual

Member Function Documentation

static int vtkControlPointsItem::IsTypeOf ( const char *  type)
static
virtual int 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, vtkPiecewiseControlPointsItem, and vtkColorTransferControlPointsItem.

static vtkControlPointsItem* vtkControlPointsItem::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkControlPointsItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPlot.

Reimplemented in vtkCompositeControlPointsItem, vtkPiecewiseControlPointsItem, and vtkColorTransferControlPointsItem.

vtkControlPointsItem* vtkControlPointsItem::NewInstance ( ) const
virtual void vtkControlPointsItem::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPlot.

Reimplemented in vtkCompositeControlPointsItem, vtkPiecewiseControlPointsItem, and vtkColorTransferControlPointsItem.

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

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.

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.

virtual void vtkControlPointsItem::SetUserBounds ( double  [4])
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 double* vtkControlPointsItem::GetUserBounds ( )
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 void vtkControlPointsItem::GetUserBounds ( 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.

virtual void vtkControlPointsItem::GetUserBounds ( double  [4])
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 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.

virtual void vtkControlPointsItem::SetValidBounds ( double  [4])
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 double* vtkControlPointsItem::GetValidBounds ( )
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 void vtkControlPointsItem::GetValidBounds ( 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.

virtual void vtkControlPointsItem::GetValidBounds ( double  [4])
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 float vtkControlPointsItem::GetScreenPointRadius ( )
virtual

Get/set the radius for screen points. Default is 6.f

virtual void vtkControlPointsItem::SetScreenPointRadius ( float  )
virtual

Get/set the radius for screen points. Default is 6.f

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

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

virtual bool vtkControlPointsItem::SelectPoints ( const vtkVector2f &  min,
const vtkVector2f &  max 
)
virtual

Select all points in the specified rectangle.

Reimplemented from vtkPlot.

vtkIdType vtkControlPointsItem::GetNumberOfSelectedPoints ( ) const

Return the number of selected points.

vtkIdType vtkControlPointsItem::FindPoint ( double *  pos)

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

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.
vtkIdType vtkControlPointsItem::GetControlPointId ( double *  pos)

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 bool vtkControlPointsItem::GetStrokeMode ( )
virtual

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

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.

virtual bool vtkControlPointsItem::GetSwitchPointsMode ( )
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 void vtkControlPointsItem::SetEndPointsXMovable ( bool  )
virtual

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

virtual bool vtkControlPointsItem::GetEndPointsXMovable ( )
virtual

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

virtual void vtkControlPointsItem::SetEndPointsYMovable ( bool  )
virtual

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

virtual bool vtkControlPointsItem::GetEndPointsYMovable ( )
virtual

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

virtual bool vtkControlPointsItem::GetEndPointsMovable ( )
virtual

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

virtual void vtkControlPointsItem::SetEndPointsRemovable ( bool  )
virtual

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

virtual bool vtkControlPointsItem::GetEndPointsRemovable ( )
virtual

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

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.

virtual bool vtkControlPointsItem::GetShowLabels ( )
virtual

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

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

Get/Set the label format. Default is "%.4f, %.4f".

virtual char* vtkControlPointsItem::GetLabelFormat ( )
virtual

Get/Set the label format. Default is "%.4f, %.4f".

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.

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.

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.

void vtkControlPointsItem::RemoveCurrentPoint ( )
inline

Remove the current point.

Definition at line 406 of file vtkControlPointsItem.h.

virtual vtkIdType vtkControlPointsItem::GetNumberOfPoints ( ) const
pure virtual

Returns the total number of points

Implemented in vtkCompositeControlPointsItem, vtkPiecewiseControlPointsItem, and vtkColorTransferControlPointsItem.

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.

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.

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 vtkPen* vtkControlPointsItem::GetSelectedPointPen ( )
virtual

Gets the selected point pen and brush.

virtual vtkBrush* vtkControlPointsItem::GetSelectedPointBrush ( )
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.

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

Mouse button down event.

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkCompositeControlPointsItem.

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

Mouse button down event.

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkCompositeControlPointsItem.

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

Mouse move event.

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkCompositeControlPointsItem.

virtual bool vtkControlPointsItem::KeyPressEvent ( const vtkContextKeyEvent &  key)
virtual

Key press event.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkControlPointsItem::KeyReleaseEvent ( const vtkContextKeyEvent &  key)
virtual

Key release event.

Reimplemented from vtkAbstractContextItem.

void vtkControlPointsItem::StartChanges ( )
protected
void vtkControlPointsItem::EndChanges ( )
protected
void vtkControlPointsItem::StartInteraction ( )
protected
void vtkControlPointsItem::StartInteractionIfNotStarted ( )
protected
void vtkControlPointsItem::Interaction ( )
protected
void vtkControlPointsItem::EndInteraction ( )
protected
int vtkControlPointsItem::GetInteractionsCount ( ) const
protected
virtual void vtkControlPointsItem::emitEvent ( unsigned long  event,
void *  params = 0 
)
protectedpure virtual

Implemented in vtkCompositeControlPointsItem, vtkColorTransferControlPointsItem, and vtkPiecewiseControlPointsItem.

static void vtkControlPointsItem::CallComputePoints ( vtkObject *  sender,
unsigned long  event,
void *  receiver,
void *  params 
)
staticprotected
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

virtual unsigned long int vtkControlPointsItem::GetControlPointsMTime ( )
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.

virtual bool vtkControlPointsItem::Hit ( const vtkContextMouseEvent &  mouse)
protectedvirtual

Returns true if the supplied x, y coordinate is on a control point.

Reimplemented from vtkAbstractContextItem.

virtual void vtkControlPointsItem::TransformScreenToData ( const vtkVector2f &  in,
vtkVector2f &  out 
)
protectedvirtual

Transform the mouse event in the control-points space. This is needed when ColorTransferFunction is using log-scale.

virtual void vtkControlPointsItem::TransformDataToScreen ( const vtkVector2f &  in,
vtkVector2f &  out 
)
protectedvirtual

Transform the mouse event in the control-points space. This is needed when ColorTransferFunction is using log-scale.

virtual bool vtkControlPointsItem::ClampPos ( double  pos[2],
double  bounds[4] 
)
protectedvirtual

Clamp the given 2D pos into the bounds of the function. Return true if the pos has been clamped, false otherwise.

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

void vtkControlPointsItem::DrawUnselectedPoints ( vtkContext2D *  painter)
protected

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

void vtkControlPointsItem::DrawSelectedPoints ( vtkContext2D *  painter)
protected

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

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

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

Reimplemented in vtkCompositeControlPointsItem, and vtkColorTransferControlPointsItem.

void vtkControlPointsItem::SetCurrentPointPos ( const vtkVector2f &  newPos)
protected
vtkIdType vtkControlPointsItem::SetPointPos ( vtkIdType  point,
const vtkVector2f &  newPos 
)
protected
void vtkControlPointsItem::MoveCurrentPoint ( const vtkVector2f &  translation)
protected
vtkIdType vtkControlPointsItem::MovePoint ( vtkIdType  point,
const vtkVector2f &  translation 
)
protected
vtkVector2f vtkControlPointsItem::GetSelectionCenterOfMass ( ) const
inlineprotected

Definition at line 412 of file vtkControlPointsItem.h.

vtkVector2f vtkControlPointsItem::GetCenterOfMass ( vtkIdTypeArray *  pointIDs) const
protected
void vtkControlPointsItem::Stroke ( const vtkVector2f &  newPos)
protected
virtual void vtkControlPointsItem::EditPoint ( float   vtkNotUsedtX,
float   vtkNotUsedtY 
)
protectedvirtual
virtual bool vtkControlPointsItem::MouseButtonReleaseEvent ( const vtkContextMouseEvent &  mouse)
protectedvirtual

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

virtual vtkStdString vtkControlPointsItem::GetControlPointLabel ( vtkIdType  index)
protectedvirtual

Generate label for a control point.

void vtkControlPointsItem::AddPointId ( vtkIdType  addedPointId)
protected
bool vtkControlPointsItem::IsEndPointPicked ( )
protected

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

bool vtkControlPointsItem::IsPointRemovable ( vtkIdType  pointId)
protected

Return true if the point is removable

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.

virtual bool vtkControlPointsItem::UsingLogScale ( )
inlineprotectedvirtual

Returns true if control points are to be rendered in log-space. This is true when vtkScalarsToColors is using log-scale, for example. Default implementation always return false.

Reimplemented in vtkCompositeControlPointsItem, and vtkColorTransferControlPointsItem.

Definition at line 365 of file vtkControlPointsItem.h.

Member Data Documentation

vtkCallbackCommand* vtkControlPointsItem::Callback
protected

Definition at line 367 of file vtkControlPointsItem.h.

vtkPen* vtkControlPointsItem::SelectedPointPen
protected

Definition at line 368 of file vtkControlPointsItem.h.

vtkBrush* vtkControlPointsItem::SelectedPointBrush
protected

Definition at line 369 of file vtkControlPointsItem.h.

int vtkControlPointsItem::BlockUpdates
protected

Definition at line 370 of file vtkControlPointsItem.h.

int vtkControlPointsItem::StartedInteractions
protected

Definition at line 371 of file vtkControlPointsItem.h.

int vtkControlPointsItem::StartedChanges
protected

Definition at line 372 of file vtkControlPointsItem.h.

vtkIdType vtkControlPointsItem::CurrentPoint
protected

Definition at line 373 of file vtkControlPointsItem.h.

double vtkControlPointsItem::Bounds[4]
protected

Definition at line 375 of file vtkControlPointsItem.h.

double vtkControlPointsItem::UserBounds[4]
protected

Definition at line 376 of file vtkControlPointsItem.h.

double vtkControlPointsItem::ValidBounds[4]
protected

Definition at line 377 of file vtkControlPointsItem.h.

vtkTransform2D* vtkControlPointsItem::Transform
protected

Definition at line 379 of file vtkControlPointsItem.h.

float vtkControlPointsItem::ScreenPointRadius
protected

Definition at line 380 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::StrokeMode
protected

Definition at line 382 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::SwitchPointsMode
protected

Definition at line 383 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::MouseMoved
protected

Definition at line 384 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::EnforceValidFunction
protected

Definition at line 385 of file vtkControlPointsItem.h.

vtkIdType vtkControlPointsItem::PointToDelete
protected

Definition at line 386 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::PointAboutToBeDeleted
protected

Definition at line 387 of file vtkControlPointsItem.h.

vtkIdType vtkControlPointsItem::PointToToggle
protected

Definition at line 388 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::PointAboutToBeToggled
protected

Definition at line 389 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::InvertShadow
protected

Definition at line 390 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::EndPointsXMovable
protected

Definition at line 391 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::EndPointsYMovable
protected

Definition at line 392 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::EndPointsRemovable
protected

Definition at line 393 of file vtkControlPointsItem.h.

bool vtkControlPointsItem::ShowLabels
protected

Definition at line 394 of file vtkControlPointsItem.h.

char* vtkControlPointsItem::LabelFormat
protected

Definition at line 395 of file vtkControlPointsItem.h.

The documentation for this class was generated from the following file:
Generated on Wed Dec 16 2015 17:15:48 for VTK by   doxygen 1.8.9.1