vtkPlotPoints - Class for drawing an points given two columns from a vtkTable. More...

Inheritance diagram for Kitware.VTK.vtkPlotPoints:

Collaboration diagram for Kitware.VTK.vtkPlotPoints:

Public Types
enum	CIRCLE_WrapperEnum { CIRCLE = 4, CROSS = 1, DIAMOND = 5, NONE = 0, PLUS = 2, SQUARE = 3 }
	Get the array name to color by. More...

Public Member Functions
	vtkPlotPoints (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkPlotPoints ()
	Creates a 2D Chart object.
virtual void	CreateDefaultLookupTable ()
	Create default lookup table. Generally used to create one when none is available with the scalar data.
override void	GetBounds (IntPtr bounds)
	Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).
vtkScalarsToColors	GetLookupTable ()
	Specify a lookup table for the mapper to use.
virtual float	GetMarkerSize ()
	Get/set the marker size that should be used. The default is negative, and in that case it is 2.3 times the pen width, if less than 8 will be used.
virtual int	GetMarkerStyle ()
	Get/set the marker style that should be used. The default is none, the enum in this class is used as a parameter.
virtual int	GetScalarVisibility ()
	Turn on/off flag to control whether scalar data is used to color objects.
override int	IsA (string type)
	*Undocumented Block
new vtkPlotPoints	NewInstance ()
	*Undocumented Block
override bool	Paint (vtkContext2D painter)
	Paint event for the XY plot, called whenever the chart needs to be drawn.
virtual void	ScalarVisibilityOff ()
	Turn on/off flag to control whether scalar data is used to color objects.
virtual void	ScalarVisibilityOn ()
	Turn on/off flag to control whether scalar data is used to color objects.
void	SelectColorArray (int arrayNum)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. The lookup table will decide how to convert vectors to colors.
void	SetLookupTable (vtkScalarsToColors lut)
	Specify a lookup table for the mapper to use.
virtual void	SetMarkerSize (float _arg)
	Get/set the marker size that should be used. The default is negative, and in that case it is 2.3 times the pen width, if less than 8 will be used.
virtual void	SetMarkerStyle (int _arg)
	Get/set the marker style that should be used. The default is none, the enum in this class is used as a parameter.
virtual void	SetScalarVisibility (int _arg)
	Turn on/off flag to control whether scalar data is used to color objects.
override void	Update ()
	Perform any updates to the item that may be necessary before rendering. The scene should take care of calling this on all items before their Paint function is invoked.
Public Member Functions inherited from Kitware.VTK.vtkPlot
	vtkPlot (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual vtkBrush	GetBrush ()
	Get a pointer to the vtkBrush object that controls the was this plot fills shapes.
virtual void	GetColor (IntPtr rgb)
	Set the plot color.
virtual vtkContextMapper2D	GetData ()
	Get the data object that the plot will draw.
virtual vtkStringArray	GetIndexedLabels ()
	Get the indexed labels array.
virtual vtkTable	GetInput ()
	Get the input table used by the plot.
virtual vtkStringArray	GetLabels ()
	Get the plot labels. If this array has a length greater than 1 the index refers to the stacked objects in the plot. See vtkPlotBar for example.
virtual int	GetNumberOfLabels ()
	Get the number of labels associated with this plot.
virtual vtkPen	GetPen ()
	Get a pointer to the vtkPen object that controls the was this plot draws lines.
virtual vtkIdTypeArray	GetSelection ()
	Convenience function to set the input arrays. For most plots index 0 is the x axis, and index 1 is the y axis. The name is the name of the column in the vtkTable.
virtual bool	GetUseIndexForXSeries ()
	Use the Y array index for the X value. If true any X column setting will be ignored, and the X values will simply be the index of the Y column.
virtual float	GetWidth ()
	Get the width of the line.
virtual vtkAxis	GetXAxis ()
	Get/set the X axis associated with this plot.
virtual vtkAxis	GetYAxis ()
	Get/set the Y axis associated with this plot.
virtual void	SetColor (byte r, byte g, byte b, byte a)
	Set the plot color.
virtual void	SetColor (double r, double g, double b)
	Set the plot color.
void	SetIndexedLabels (vtkStringArray labels)
	Set indexed labels for the plot. If set, this array can be used to provide custom labels for each point in a plot. This array should be the same length as the points array. Default is null (no indexed labels).
virtual void	SetInput (vtkTable table)
	This is a convenience function to set the input table and the x, y column for the plot.
void	SetInput (vtkTable table, int xColumn, int yColumn)
	This is a convenience function to set the input table and the x, y column for the plot.
virtual void	SetLabels (vtkStringArray labels)
	Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index.
virtual void	SetSelection (vtkIdTypeArray id)
	Convenience function to set the input arrays. For most plots index 0 is the x axis, and index 1 is the y axis. The name is the name of the column in the vtkTable.
virtual void	SetUseIndexForXSeries (bool _arg)
	Use the Y array index for the X value. If true any X column setting will be ignored, and the X values will simply be the index of the Y column.
virtual void	SetWidth (float width)
	Set the width of the line.
virtual void	SetXAxis (vtkAxis axis)
	Get/set the X axis associated with this plot.
virtual void	SetYAxis (vtkAxis axis)
	Get/set the Y axis associated with this plot.
Public Member Functions inherited from Kitware.VTK.vtkContextItem
	vtkContextItem (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual double	GetOpacity ()
	Get the opacity of the item.
virtual void	SetOpacity (double _arg)
	Set the opacity of the item. 1.0 by default.
Public Member Functions inherited from Kitware.VTK.vtkAbstractContextItem
	vtkAbstractContextItem (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
uint	AddItem (vtkAbstractContextItem item)
	Add child items to this item. Increments reference count of item.
void	ClearItems ()
	Remove all child items from this item.
vtkAbstractContextItem	GetItem (uint index)
	Get the item at the specified index.
uint	GetNumberOfItems ()
	Get the number of child items.
vtkAbstractContextItem	GetParent ()
	Get the parent item. The parent will be set for all items except top level items in a tree.
vtkContextScene	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.
virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn).
bool	PaintChildren (vtkContext2D painter)
	Paint the children of the item, should be called whenever the children need to be rendered.
virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item. The default implementation is empty.
bool	RemoveItem (vtkAbstractContextItem item)
	Remove child item from this item. Decrements reference count of item.
bool	RemoveItem (uint index)
	Remove child item from this item. Decrements reference count of item.
virtual void	SetParent (vtkAbstractContextItem parent)
	Set the parent item. The parent will be set for all items except top level items in a scene.
virtual void	SetScene (vtkContextScene scene)
	Set the vtkContextScene for the item, always set for an item in a scene.
virtual void	SetVisible (bool _arg)
	Set the visibility of the item (should it be drawn). Visible by default.
Public Member Functions inherited from Kitware.VTK.vtkObject
	vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObject ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint	AddObserver (uint arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
uint	AddObserver (string arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	DebugOff ()
	Turn debugging output off.
virtual void	DebugOn ()
	Turn debugging output on.
vtkCommand	GetCommand (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
byte	GetDebug ()
	Get the value of the debug flag.
virtual uint	GetMTime ()
	Return this object's modified time.
int	HasObserver (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	Modified ()
	Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void	RemoveAllObservers ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (vtkCommand arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	SetDebug (byte debugFlag)
	Set the value of the debug flag. A non-zero value turns debugging on.
override string	ToString ()
	Returns the result of calling vtkObject::Print as a C# string.
delegate void	vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
	Generic signature for all vtkObject events.
void	RemoveAllHandlersForAllEvents ()
	Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
Public Member Functions inherited from Kitware.VTK.vtkObjectBase
	vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObjectBase ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void	Register (vtkObjectBase o)
	Increase the reference count (mark as used by another object).
virtual void	FastDelete ()
	Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string	GetClassName ()
	Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int arg0)
	Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions
static new vtkPlotPoints	New ()
	Creates a 2D Chart object.
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkPlotPoints	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkPlotPoints"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkPlot
Public Attributes inherited from Kitware.VTK.vtkContextItem
Public Attributes inherited from Kitware.VTK.vtkAbstractContextItem
Public Attributes inherited from Kitware.VTK.vtkObject
Public Attributes inherited from Kitware.VTK.vtkObjectBase
Public Attributes inherited from Kitware.VTK.WrappedObject
const string	vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
	Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string	vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
	Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string	vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
	Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
	Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
	Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string	vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
	Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string	vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
	Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string	vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
	Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string	vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
	Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string	vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
	Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string	vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
	Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string	vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
	Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string	vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
	Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string	vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
	Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string	vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
	Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes
static new readonly string	MRClassNameKey = "13vtkPlotPoints"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkPlot
Static Public Attributes inherited from Kitware.VTK.vtkContextItem
Static Public Attributes inherited from Kitware.VTK.vtkAbstractContextItem
Static Public Attributes inherited from Kitware.VTK.vtkObject
Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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.

Static Private Member Functions
static	vtkPlotPoints ()
	Automatically generated type registration mechanics.

Detailed Description

vtkPlotPoints - Class for drawing an points given two columns from a vtkTable.

Description This class draws points in a plot given two columns from a table. If you need a line as well you should use vtkPlotLine which derives from vtkPlotPoints and is capable of drawing both points and a line.

vtkPlotLine

Member Enumeration Documentation

enum Kitware.VTK.vtkPlotPoints.CIRCLE_WrapperEnum

Get the array name to color by.

Enumerator:

CIRCLE	enum member
CROSS	enum member
DIAMOND	enum member
NONE	enum member
PLUS	enum member
SQUARE	enum member

Constructor & Destructor Documentation

static Kitware.VTK.vtkPlotPoints.vtkPlotPoints ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkPlotPoints.vtkPlotPoints ( )

Creates a 2D Chart object.

Member Function Documentation

virtual void Kitware.VTK.vtkPlotPoints.CreateDefaultLookupTable ( )

virtual

Create default lookup table. Generally used to create one when none is available with the scalar data.

override void Kitware.VTK.vtkPlotPoints.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.vtkPlotLine.

override void Kitware.VTK.vtkPlotPoints.GetBounds ( IntPtr bounds )

virtual

Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).

Reimplemented from Kitware.VTK.vtkPlot.

vtkScalarsToColors Kitware.VTK.vtkPlotPoints.GetLookupTable ( )

Specify a lookup table for the mapper to use.

Here is the call graph for this function:

virtual float Kitware.VTK.vtkPlotPoints.GetMarkerSize ( )

virtual

Get/set the marker size that should be used. The default is negative, and in that case it is 2.3 times the pen width, if less than 8 will be used.

virtual int Kitware.VTK.vtkPlotPoints.GetMarkerStyle ( )

virtual

Get/set the marker style that should be used. The default is none, the enum in this class is used as a parameter.

virtual int Kitware.VTK.vtkPlotPoints.GetScalarVisibility ( )

virtual

Turn on/off flag to control whether scalar data is used to color objects.

override int Kitware.VTK.vtkPlotPoints.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPlot.

Reimplemented in Kitware.VTK.vtkPlotLine.

static new int Kitware.VTK.vtkPlotPoints.IsTypeOf ( string type )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPlot.

Reimplemented in Kitware.VTK.vtkPlotLine.

static new vtkPlotPoints Kitware.VTK.vtkPlotPoints.New ( )

static

Creates a 2D Chart object.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkPlotLine.

new vtkPlotPoints Kitware.VTK.vtkPlotPoints.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPlot.

Reimplemented in Kitware.VTK.vtkPlotLine.

override bool Kitware.VTK.vtkPlotPoints.Paint ( vtkContext2D painter )

virtual

Paint event for the XY plot, called whenever the chart needs to be drawn.

Reimplemented from Kitware.VTK.vtkAbstractContextItem.

Reimplemented in Kitware.VTK.vtkPlotLine.

static new vtkPlotPoints Kitware.VTK.vtkPlotPoints.SafeDownCast ( vtkObjectBase o )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPlot.

Reimplemented in Kitware.VTK.vtkPlotLine.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkPlotPoints.ScalarVisibilityOff ( )

virtual

Turn on/off flag to control whether scalar data is used to color objects.

virtual void Kitware.VTK.vtkPlotPoints.ScalarVisibilityOn ( )

virtual

Turn on/off flag to control whether scalar data is used to color objects.

void Kitware.VTK.vtkPlotPoints.SelectColorArray ( int arrayNum )

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. The lookup table will decide how to convert vectors to colors.

void Kitware.VTK.vtkPlotPoints.SetLookupTable ( vtkScalarsToColors lut )

Specify a lookup table for the mapper to use.

virtual void Kitware.VTK.vtkPlotPoints.SetMarkerSize ( float _arg )

virtual

Get/set the marker size that should be used. The default is negative, and in that case it is 2.3 times the pen width, if less than 8 will be used.

virtual void Kitware.VTK.vtkPlotPoints.SetMarkerStyle ( int _arg )

virtual

Get/set the marker style that should be used. The default is none, the enum in this class is used as a parameter.

virtual void Kitware.VTK.vtkPlotPoints.SetScalarVisibility ( int _arg )

virtual

Turn on/off flag to control whether scalar data is used to color objects.

override void Kitware.VTK.vtkPlotPoints.Update ( )

virtual

Perform any updates to the item that may be necessary before rendering. The scene should take care of calling this on all items before their Paint function is invoked.

Reimplemented from Kitware.VTK.vtkAbstractContextItem.