ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkControlPointsItem Class Reference

vtkControlPointsItem - Abstract class for control points items. More...

Inheritance diagram for Kitware.VTK.vtkControlPointsItem:
[legend]
Collaboration diagram for Kitware.VTK.vtkControlPointsItem:
[legend]

List of all members.

Public Types

enum  CurrentPointChangedEvent_WrapperEnum { CurrentPointChangedEvent = 1000, CurrentPointEditEvent = 1001 }
 Undocumented Block. More...

Public Member Functions

 vtkControlPointsItem (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual long AddPoint (IntPtr newPos)
 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.
void DeselectAllPoints ()
 Unselect all the previously selected points.
void DeselectPoint (long pointId)
 Unselect a point by its ID.
void DeselectPoint (IntPtr 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.
long FindPoint (IntPtr pos)
 Returns the vtkIdType of the point given its coordinates and a tolerance based on the screen point size.
override void GetBounds (IntPtr bounds)
 Bounds of the item, typically the bound of all the control points except if custom bounds have been set.
virtual void GetControlPoint (long index, IntPtr point)
 Returns the x and y coordinates as well as the midpoint and sharpness of the control point corresponding to the index.
long GetControlPointId (IntPtr pos)
 Returns the id of the control point exactly matching pos, -1 if not found.
long GetCurrentPoint ()
 Returns the current point selected.
virtual int GetNumberOfPoints ()
 Returns the total number of points.
virtual bool GetStrokeMode ()
 Controls whether or not control points are drawn (true) or clicked and moved (false). False by default.
virtual bool GetSwitchPointsMode ()
 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 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.
virtual void GetUserBounds (ref double _arg1, ref double _arg2, ref double _arg3, ref double _arg4)
 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 GetUserBounds (IntPtr _arg)
 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.
override int IsA (string type)
 Undocumented Block.
bool IsOverPoint (IntPtr pos, long 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.
new vtkControlPointsItem NewInstance ()
 Undocumented Block.
override bool Paint (vtkContext2D painter)
 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.
virtual long RemovePoint (IntPtr pos)
 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.
void ResetBounds ()
 Recompute the bounds next time they are requested. You shouldn't have to call it but it is provided for rare cases.
void SelectAllPoints ()
 Select all the points.
void SelectPoint (long pointId)
 Select a point by its ID.
void SelectPoint (IntPtr 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.
virtual void SetControlPoint (long index, IntPtr point)
 Sets the x and y coordinates as well as the midpoint and sharpness of the control point corresponding to the index.
void SetCurrentPoint (long index)
 Sets the current point selected.
virtual void SetSwitchPointsMode (bool _arg)
 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 SetUserBounds (double _arg1, double _arg2, double _arg3, double _arg4)
 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 SetUserBounds (IntPtr _arg)
 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.
void ToggleSelectPoint (long pointId)
 Toggle the selection of a point by its ID. If the point was selected then unselect it, otherwise select it.
void ToggleSelectPoint (IntPtr 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.

Static Public Member Functions

static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkControlPointsItem SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkControlPointsItem"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "20vtkControlPointsItem"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal long vtkControlPointsItem_AddPoint_01 (HandleRef pThis, IntPtr newPos)
static internal void vtkControlPointsItem_DeselectAllPoints_02 (HandleRef pThis)
static internal void vtkControlPointsItem_DeselectPoint_03 (HandleRef pThis, long pointId)
static internal void vtkControlPointsItem_DeselectPoint_04 (HandleRef pThis, IntPtr currentPoint)
static internal long vtkControlPointsItem_FindPoint_05 (HandleRef pThis, IntPtr pos)
static internal void vtkControlPointsItem_GetBounds_06 (HandleRef pThis, IntPtr bounds)
static internal void vtkControlPointsItem_GetControlPoint_07 (HandleRef pThis, long index, IntPtr point)
static internal long vtkControlPointsItem_GetControlPointId_08 (HandleRef pThis, IntPtr pos)
static internal long vtkControlPointsItem_GetCurrentPoint_09 (HandleRef pThis)
static internal int vtkControlPointsItem_GetNumberOfPoints_10 (HandleRef pThis)
static internal byte vtkControlPointsItem_GetStrokeMode_11 (HandleRef pThis)
static internal byte vtkControlPointsItem_GetSwitchPointsMode_12 (HandleRef pThis)
static internal IntPtr vtkControlPointsItem_GetUserBounds_13 (HandleRef pThis)
static internal void vtkControlPointsItem_GetUserBounds_14 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3, ref double _arg4)
static internal void vtkControlPointsItem_GetUserBounds_15 (HandleRef pThis, IntPtr _arg)
static internal int vtkControlPointsItem_IsA_16 (HandleRef pThis, string type)
static internal byte vtkControlPointsItem_IsOverPoint_17 (HandleRef pThis, IntPtr pos, long pointId)
static internal int vtkControlPointsItem_IsTypeOf_18 (string type)
static internal IntPtr vtkControlPointsItem_NewInstance_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkControlPointsItem_Paint_20 (HandleRef pThis, HandleRef painter)
static internal long vtkControlPointsItem_RemovePoint_21 (HandleRef pThis, IntPtr pos)
static internal void vtkControlPointsItem_ResetBounds_22 (HandleRef pThis)
static internal IntPtr vtkControlPointsItem_SafeDownCast_23 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkControlPointsItem_SelectAllPoints_24 (HandleRef pThis)
static internal void vtkControlPointsItem_SelectPoint_25 (HandleRef pThis, long pointId)
static internal void vtkControlPointsItem_SelectPoint_26 (HandleRef pThis, IntPtr currentPoint)
static internal void vtkControlPointsItem_SetControlPoint_27 (HandleRef pThis, long index, IntPtr point)
static internal void vtkControlPointsItem_SetCurrentPoint_28 (HandleRef pThis, long index)
static internal void vtkControlPointsItem_SetSwitchPointsMode_29 (HandleRef pThis, byte _arg)
static internal void vtkControlPointsItem_SetUserBounds_30 (HandleRef pThis, double _arg1, double _arg2, double _arg3, double _arg4)
static internal void vtkControlPointsItem_SetUserBounds_31 (HandleRef pThis, IntPtr _arg)
static internal void vtkControlPointsItem_ToggleSelectPoint_32 (HandleRef pThis, long pointId)
static internal void vtkControlPointsItem_ToggleSelectPoint_33 (HandleRef pThis, IntPtr currentPoint)

Static Private Member Functions

static vtkControlPointsItem ()
 Automatically generated type registration mechanics.

Detailed Description

vtkControlPointsItem - Abstract class for control points items.

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

vtkScalarsToColorsItem vtkPiecewiseControlPointsItem


Member Enumeration Documentation

Undocumented Block.

Enumerator:
CurrentPointChangedEvent 

enum member

CurrentPointEditEvent 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.


Member Function Documentation

virtual long Kitware.VTK.vtkControlPointsItem.AddPoint ( IntPtr  newPos) [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.

Reimplemented in Kitware.VTK.vtkCompositeControlPointsItem, Kitware.VTK.vtkColorTransferControlPointsItem, and Kitware.VTK.vtkPiecewiseControlPointsItem.

Unselect all the previously selected points.

Unselect a point by its ID.

void Kitware.VTK.vtkControlPointsItem.DeselectPoint ( IntPtr  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.

override void Kitware.VTK.vtkControlPointsItem.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkPlot.

Reimplemented in Kitware.VTK.vtkCompositeControlPointsItem, Kitware.VTK.vtkColorTransferControlPointsItem, and Kitware.VTK.vtkPiecewiseControlPointsItem.

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

override void Kitware.VTK.vtkControlPointsItem.GetBounds ( IntPtr  bounds) [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 Kitware.VTK.vtkPlot.

virtual void Kitware.VTK.vtkControlPointsItem.GetControlPoint ( long  index,
IntPtr  point 
) [virtual]

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

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

Returns the current point selected.

Returns the total number of points.

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

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 double [] Kitware.VTK.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 Kitware.VTK.vtkControlPointsItem.GetUserBounds ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3,
ref double  _arg4 
) [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 Kitware.VTK.vtkControlPointsItem.GetUserBounds ( IntPtr  _arg) [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.

override int Kitware.VTK.vtkControlPointsItem.IsA ( string  type) [virtual]
bool Kitware.VTK.vtkControlPointsItem.IsOverPoint ( IntPtr  pos,
long  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.
static new int Kitware.VTK.vtkControlPointsItem.IsTypeOf ( string  type) [static]
override bool Kitware.VTK.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 Kitware.VTK.vtkAbstractContextItem.

virtual long Kitware.VTK.vtkControlPointsItem.RemovePoint ( IntPtr  pos) [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.

Reimplemented in Kitware.VTK.vtkColorTransferControlPointsItem, Kitware.VTK.vtkCompositeControlPointsItem, and Kitware.VTK.vtkPiecewiseControlPointsItem.

Recompute the bounds next time they are requested. You shouldn't have to call it but it is provided for rare cases.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPlot.

Reimplemented in Kitware.VTK.vtkColorTransferControlPointsItem, Kitware.VTK.vtkCompositeControlPointsItem, and Kitware.VTK.vtkPiecewiseControlPointsItem.

Here is the call graph for this function:

Select all the points.

Select a point by its ID.

void Kitware.VTK.vtkControlPointsItem.SelectPoint ( IntPtr  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.

virtual void Kitware.VTK.vtkControlPointsItem.SetControlPoint ( long  index,
IntPtr  point 
) [virtual]

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

Sets the current point selected.

virtual void Kitware.VTK.vtkControlPointsItem.SetSwitchPointsMode ( bool  _arg) [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 Kitware.VTK.vtkControlPointsItem.SetUserBounds ( double  _arg1,
double  _arg2,
double  _arg3,
double  _arg4 
) [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 Kitware.VTK.vtkControlPointsItem.SetUserBounds ( IntPtr  _arg) [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.

Toggle the selection of a point by its ID. If the point was selected then unselect it, otherwise select it.

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.

static internal long Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_AddPoint_01 ( HandleRef  pThis,
IntPtr  newPos 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_DeselectAllPoints_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_DeselectPoint_03 ( HandleRef  pThis,
long  pointId 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_DeselectPoint_04 ( HandleRef  pThis,
IntPtr  currentPoint 
) [private]
static internal long Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_FindPoint_05 ( HandleRef  pThis,
IntPtr  pos 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_GetBounds_06 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_GetControlPoint_07 ( HandleRef  pThis,
long  index,
IntPtr  point 
) [private]
static internal long Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_GetControlPointId_08 ( HandleRef  pThis,
IntPtr  pos 
) [private]
static internal long Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_GetCurrentPoint_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_GetNumberOfPoints_10 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_GetStrokeMode_11 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_GetSwitchPointsMode_12 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_GetUserBounds_13 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_GetUserBounds_14 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3,
ref double  _arg4 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_GetUserBounds_15 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_IsA_16 ( HandleRef  pThis,
string  type 
) [private]
static internal byte Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_IsOverPoint_17 ( HandleRef  pThis,
IntPtr  pos,
long  pointId 
) [private]
static internal int Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_IsTypeOf_18 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_NewInstance_19 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_Paint_20 ( HandleRef  pThis,
HandleRef  painter 
) [private]
static internal long Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_RemovePoint_21 ( HandleRef  pThis,
IntPtr  pos 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_ResetBounds_22 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_SafeDownCast_23 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_SelectAllPoints_24 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_SelectPoint_25 ( HandleRef  pThis,
long  pointId 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_SelectPoint_26 ( HandleRef  pThis,
IntPtr  currentPoint 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_SetControlPoint_27 ( HandleRef  pThis,
long  index,
IntPtr  point 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_SetCurrentPoint_28 ( HandleRef  pThis,
long  index 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_SetSwitchPointsMode_29 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_SetUserBounds_30 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3,
double  _arg4 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_SetUserBounds_31 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_ToggleSelectPoint_32 ( HandleRef  pThis,
long  pointId 
) [private]
static internal void Kitware.VTK.vtkControlPointsItem.vtkControlPointsItem_ToggleSelectPoint_33 ( HandleRef  pThis,
IntPtr  currentPoint 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkControlPointsItem.MRClassNameKey = "20vtkControlPointsItem" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPlot.

Reimplemented in Kitware.VTK.vtkCompositeControlPointsItem, Kitware.VTK.vtkColorTransferControlPointsItem, and Kitware.VTK.vtkPiecewiseControlPointsItem.

new const string Kitware.VTK.vtkControlPointsItem.MRFullTypeName = "Kitware.VTK.vtkControlPointsItem"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPlot.

Reimplemented in Kitware.VTK.vtkCompositeControlPointsItem, Kitware.VTK.vtkColorTransferControlPointsItem, and Kitware.VTK.vtkPiecewiseControlPointsItem.


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