IGLib 1.4
The IGLib base library for development of numerical, technical and business applications.

IG::Gr::PlotZedgraphCurve Class Reference

Curve plots thst is shown on a ZedGraphControl object. More...

Inheritance diagram for IG::Gr::PlotZedgraphCurve:
Collaboration diagram for IG::Gr::PlotZedgraphCurve:

List of all members.

Public Member Functions

 PlotZedgraphCurve (PlotterZedGraph plotter)
 Creates a curve plot.
void SetCurveDefiniton (IRealFunction funcX, IRealFunction funcY)
 Sets definition of the parametric curve in 2D to be plotted.
void SetCurveDefiniton (IRealFunction func)
 Sets explicit definition of curve in 2D to be plotted.
void ClearCurveDefinition ()
 Removes any eventual definition of the plotted curve curve by functions (either parametric or explicit).
override void CalculateBoundsCoordinates ()
 Recalculates bounds for coordinates on the graphic objects currently contained in the graph.
void ClearPoints ()
 Clears the list of points that define the curve to be plotted.
void AddPoint (double xCoordinate, double yCoordinate)
 Adds a point with specified coordinates to the curve plotted on the current curve graph.
void AddPoint (vec2 point)
 Adds the specified point to the curve plotted on the current curve graph.
void AddPoints (params vec2[] points)
 Adds the specified set of points to the curve plotted on the curve graph.
void SetPoints (params vec2[] points)
 Sets points of the curve plotted on the curve graph.
void AddPoints (params Vector2d[] points)
 Adds the specified set of points to the curve plotted on the curve graph.
void SetPoints (params Vector2d[] points)
 Sets points of the curve plotted on the curve graph.
void AddPoints (params IVector[] points)
 Adds the specified set of points to the curve plotted on the curve graph.
void SetPoints (params IVector[] points)
 Sets points of the curve plotted on the curve graph.
void AddPoints (double[] xArray, double[] yArray)
 Adds the specified set of points to the curve plotted on the curve graph.
void SetPoints (double[] xArray, double[] yArray)
 Sets points of the curve plotted on the curve graph.
override void CreateData ()
 Creates data for the plot. Basically, this creates and updates the internal data structures used by the plot, while Update will also update the plot in the window where it is shown.
override void Update ()
 Updates the plot on the plotter (and consequently the related window of type ZedGraphControl).
override void RemoveFromGraphPane ()
 Removes all items of the current plot from the graph pane. Must be overridden in derived classes.

Static Public Member Functions

static SymbolType GetSymbolType (int typeId)
 Converts integer to SymbolType enum.
static int GetPointType (SymbolType pointType)
 Converts SymbolType enum to integer.

Public Attributes

bool _linesVisible = DefaultShowLines
bool _pointsVisible = DefaultShowPoints

Static Public Attributes

static int DefaultNumPoints = 100
 Default number of points when plotting curves specified by functions.
static double DefaultMinParam = 0
 Default lower bound on parameter.
static double DefaultMaxParam = 1
 Default upper bound on parameter.
static bool DefaultShowLines = true
 Default value of the flag specifying whether lines are shown or not.
static bool DefaultShowPoints = true
 Default value of the flag specifying whether points are shown or not.
static color DefaultLineColor = Color.Blue
 Default color for curves.
static double DefaultLineWidth = 2.0
 Default line width.
static DashStyle DefaultLineDashStyle = DashStyle.Solid
 Default line dash style.
static StepType DefaultLineStepType = StepType.NonStep
 Default line step type.
static bool DefaultLineSmoothing = false
 Default smoothing flag.
static double DefaultLineSmoothness = 1.0
 Default level of smoothing when drawing lines.
static double DefaultPointSize = 4.0
 Default point size.
static int DefaultPointType = GetPointType(SymbolType.Circle)
 Default point type.
static color DefaultPointBorderColor = DefaultLineColor
 Default color for point borders.
static color DefaultPointFillColor = DefaultLineColor
 Default point fill color.

Protected Attributes

IRealFunction _functionX
int _numPoints = DefaultNumPoints
double _minParam = DefaultMinParam
double _maxParam = DefaultMaxParam
List< vec2_points
PointPairList _pointList = null
color _lineColor = DefaultLineColor
double _lineWidth = DefaultLineWidth
DashStyle _lineDashStyle = DefaultLineDashStyle
StepType _lineStepType = DefaultLineStepType
bool _lineSmoothing = DefaultLineSmoothing
double _lineSmoothness = DefaultLineSmoothness
double _pointSize = DefaultPointSize
int _pointType = DefaultPointType
color _pointBorderColor = DefaultPointBorderColor
color _pointFillColor = DefaultPointFillColor
bool _isX2Axis = false
bool _isY2Axis = false
LineItem _curveItem

Properties

IRealFunction FunctionX [get, set]
 The first component of a 2D function of 1 parameter that acts as parametric definition of the plotted curve.
IRealFunction FunctionY [get, set]
 The second component of a 2D function of 1 parameter that acts as parametric definition of the plotted curve.
IRealFunction Function [set]
 The first component of a 2D function of 1 parameter that acts as parametric definition of the plotted curve.
IRealFunction IdentityFunction [get]
 Gets identity function.
int NumPoints [get, set]
 Number of points in curve plots. Used when plotting curves specified by functions.
double MinParam [get, set]
 Lower bound on parameter when plotting a curve.
double MaxParam [get, set]
 Upper bound on parameter when plotting a curve.
List< vec2Points [get, set]
 List of points that define the curve to be plotted.
PointPairList PointList [get, set]
 List of points used for ZedGraph representation of the curve.
bool LinesVisible [get, set]
 Specifies whether lines will be shown for the current curve or not.
bool PointsVisible [get, set]
 Specifies whether points will be shown for the current curve or not.
color ColorAll [set]
 Collectively sets the common color for line, point border and point fill.
color LineColor [get, set]
 Line color.
double LineWidth [get, set]
 Specifies the line width.
DashStyle LineDashStyle [get, set]
 Specifies the line dash style.
StepType LineStepType [get, set]
 Specifies the line step type in form of the Yedgraph's StepType enumerator. If different that StepType.NonStep then horizontal steps are plotted between values.
bool LineSmoothing [get, set]
 Specifies whether lines are smoothed or not when drawing the curve.
double LineSmoothness [get, set]
 Specifies the level of smoothing when drawing the curve. Must be between 0 (not smoothed) and 1 (fully smoothed).When set to a value greater than 0, the LineSmoothing flag is set to true.
double PointSize [get, set]
 Type of symbol used for drawing points, specified as int.
int PointType [get, set]
 Type of symbol used for drawing points, specified as int.
SymbolType PointTypeSymbol [get, set]
 Type of symbol used for drawing points, specified as SymbolType enum.
color PointColor [set]
 Collectively sets point border color (PointBorderColor) and point fill color (PointFillColor) to the same value.
color PointBorderColor [get, set]
 Color for plotting points outline (border).
color PointFillColor [get, set]
 Points fill color.
bool IsX2Axis [get, set]
bool IsY2Axis [get, set]
bool Is2Axis [get, set]
LineItem CurveItem [get, set]
 LineItem that is put to the GraphPane. Object can be removed from the pane through this property.

Private Attributes

IRealFunction _functionY
IRealFunction _identity

Detailed Description

Curve plots thst is shown on a ZedGraphControl object.

Line and point settings can be specified such that look of the curve plotted is finely adjusted.

Symbol to draw points can be specified as SymbolType enum or as integer, which is useful in automatical settings when drawing multiple curves.

$A Igor Jun09 Nov11;


Constructor & Destructor Documentation

IG::Gr::PlotZedgraphCurve::PlotZedgraphCurve ( PlotterZedGraph  plotter) [inline]

Creates a curve plot.

Parameters:
plotterPlotter used for displaying the plot.

Member Function Documentation

void IG::Gr::PlotZedgraphCurve::SetCurveDefiniton ( IRealFunction  funcX,
IRealFunction  funcY 
) [inline]

Sets definition of the parametric curve in 2D to be plotted.

Parameters:
funcXFunction of parameter that defines X coordinates of points.
funcYFunction of parameter that defines Y coordinates of points.
void IG::Gr::PlotZedgraphCurve::SetCurveDefiniton ( IRealFunction  func) [inline]

Sets explicit definition of curve in 2D to be plotted.

Parameters:
funcFunction that defines how Y coordinate depends on X coordinate of points.
void IG::Gr::PlotZedgraphCurve::ClearCurveDefinition ( ) [inline]

Removes any eventual definition of the plotted curve curve by functions (either parametric or explicit).

override void IG::Gr::PlotZedgraphCurve::CalculateBoundsCoordinates ( ) [inline, virtual]

Recalculates bounds for coordinates on the graphic objects currently contained in the graph.

Implements IG::Gr::PlotZedGraphBase.

void IG::Gr::PlotZedgraphCurve::ClearPoints ( ) [inline]

Clears the list of points that define the curve to be plotted.

void IG::Gr::PlotZedgraphCurve::AddPoint ( double  xCoordinate,
double  yCoordinate 
) [inline]

Adds a point with specified coordinates to the curve plotted on the current curve graph.

Parameters:
xCoordinateX coordinate of the added point.
yCoordinateY coordinate of the added point.
void IG::Gr::PlotZedgraphCurve::AddPoint ( vec2  point) [inline]

Adds the specified point to the curve plotted on the current curve graph.

Parameters:
pointPoint to be added.
void IG::Gr::PlotZedgraphCurve::AddPoints ( params vec2[]  points) [inline]

Adds the specified set of points to the curve plotted on the curve graph.

Parameters:
pointsPoints to be added to the curve definition.
void IG::Gr::PlotZedgraphCurve::SetPoints ( params vec2[]  points) [inline]

Sets points of the curve plotted on the curve graph.

Parameters:
pointsPoints to be added to the curve definition.

If any of the the elements of the array is null then it is ignored.

void IG::Gr::PlotZedgraphCurve::AddPoints ( params Vector2d[]  points) [inline]

Adds the specified set of points to the curve plotted on the curve graph.

Parameters:
pointsPoints to be added to the curve definition.

If any of the the elements of the array is null then it is ignored.

void IG::Gr::PlotZedgraphCurve::SetPoints ( params Vector2d[]  points) [inline]

Sets points of the curve plotted on the curve graph.

Parameters:
pointsPoints to be added to the curve definition.

If any of the the elements of the array is null then it is ignored.

void IG::Gr::PlotZedgraphCurve::AddPoints ( params IVector[]  points) [inline]

Adds the specified set of points to the curve plotted on the curve graph.

Parameters:
pointsPoints to be added to the curve definition.

If any of the the elements of the array is null then it is ignored. Otherwise, vectors representing points must be of dimension 2.

void IG::Gr::PlotZedgraphCurve::SetPoints ( params IVector[]  points) [inline]

Sets points of the curve plotted on the curve graph.

Parameters:
pointsPoints to be added to the curve definition.

If any of the the elements of the array is null then it is ignored. Otherwise, vectors representing points must be of dimension 2.

void IG::Gr::PlotZedgraphCurve::AddPoints ( double[]  xArray,
double[]  yArray 
) [inline]

Adds the specified set of points to the curve plotted on the curve graph.

Parameters:
xArrayArray of X coordinates of the points that define the curve.
yArrayArray of Y coordinates of the points that define the curve.
void IG::Gr::PlotZedgraphCurve::SetPoints ( double[]  xArray,
double[]  yArray 
) [inline]

Sets points of the curve plotted on the curve graph.

Parameters:
xArrayArray of X coordinates of the points that define the curve.
yArrayArray of Y coordinates of the points that define the curve.
static SymbolType IG::Gr::PlotZedgraphCurve::GetSymbolType ( int  typeId) [inline, static]

Converts integer to SymbolType enum.

Parameters:
typeIdInteger to be converted.
static int IG::Gr::PlotZedgraphCurve::GetPointType ( SymbolType  pointType) [inline, static]

Converts SymbolType enum to integer.

Parameters:
typeIdEnumumerator value to be converted.
override void IG::Gr::PlotZedgraphCurve::CreateData ( ) [inline, virtual]

Creates data for the plot. Basically, this creates and updates the internal data structures used by the plot, while Update will also update the plot in the window where it is shown.

Implements IG::Gr::PlotZedGraphBase.

override void IG::Gr::PlotZedgraphCurve::Update ( ) [inline, virtual]

Updates the plot on the plotter (and consequently the related window of type ZedGraphControl).

Reimplemented from IG::Gr::PlotZedGraphBase.

override void IG::Gr::PlotZedgraphCurve::RemoveFromGraphPane ( ) [inline, virtual]

Removes all items of the current plot from the graph pane. Must be overridden in derived classes.

Implements IG::Gr::PlotZedGraphBase.


Member Data Documentation

Default number of points when plotting curves specified by functions.

Default lower bound on parameter.

Default upper bound on parameter.

PointPairList IG::Gr::PlotZedgraphCurve::_pointList = null [protected]

Default value of the flag specifying whether lines are shown or not.

Default value of the flag specifying whether points are shown or not.

Default color for curves.

Default line width.

DashStyle IG::Gr::PlotZedgraphCurve::DefaultLineDashStyle = DashStyle.Solid [static]

Default line dash style.

StepType IG::Gr::PlotZedgraphCurve::DefaultLineStepType = StepType.NonStep [static]

Default line step type.

Default smoothing flag.

Default level of smoothing when drawing lines.

Default point size.

int IG::Gr::PlotZedgraphCurve::DefaultPointType = GetPointType(SymbolType.Circle) [static]

Default point type.

Default color for point borders.

bool IG::Gr::PlotZedgraphCurve::_isX2Axis = false [protected]
bool IG::Gr::PlotZedgraphCurve::_isY2Axis = false [protected]

Property Documentation

IRealFunction IG::Gr::PlotZedgraphCurve::FunctionX [get, set]

The first component of a 2D function of 1 parameter that acts as parametric definition of the plotted curve.

IRealFunction IG::Gr::PlotZedgraphCurve::FunctionY [get, set]

The second component of a 2D function of 1 parameter that acts as parametric definition of the plotted curve.

IRealFunction IG::Gr::PlotZedgraphCurve::Function [set, protected]

The first component of a 2D function of 1 parameter that acts as parametric definition of the plotted curve.

IRealFunction IG::Gr::PlotZedgraphCurve::IdentityFunction [get, protected]

Gets identity function.

int IG::Gr::PlotZedgraphCurve::NumPoints [get, set]

Number of points in curve plots. Used when plotting curves specified by functions.

double IG::Gr::PlotZedgraphCurve::MinParam [get, set]

Lower bound on parameter when plotting a curve.

double IG::Gr::PlotZedgraphCurve::MaxParam [get, set]

Upper bound on parameter when plotting a curve.

List<vec2> IG::Gr::PlotZedgraphCurve::Points [get, set, protected]

List of points that define the curve to be plotted.

PointPairList IG::Gr::PlotZedgraphCurve::PointList [get, set, protected]

List of points used for ZedGraph representation of the curve.

bool IG::Gr::PlotZedgraphCurve::LinesVisible [get, set]

Specifies whether lines will be shown for the current curve or not.

bool IG::Gr::PlotZedgraphCurve::PointsVisible [get, set]

Specifies whether points will be shown for the current curve or not.

color IG::Gr::PlotZedgraphCurve::ColorAll [set]

Collectively sets the common color for line, point border and point fill.

color IG::Gr::PlotZedgraphCurve::LineColor [get, set]

Line color.

double IG::Gr::PlotZedgraphCurve::LineWidth [get, set]

Specifies the line width.

DashStyle IG::Gr::PlotZedgraphCurve::LineDashStyle [get, set]

Specifies the line dash style.

StepType IG::Gr::PlotZedgraphCurve::LineStepType [get, set]

Specifies the line step type in form of the Yedgraph's StepType enumerator. If different that StepType.NonStep then horizontal steps are plotted between values.

bool IG::Gr::PlotZedgraphCurve::LineSmoothing [get, set]

Specifies whether lines are smoothed or not when drawing the curve.

double IG::Gr::PlotZedgraphCurve::LineSmoothness [get, set]

Specifies the level of smoothing when drawing the curve. Must be between 0 (not smoothed) and 1 (fully smoothed).When set to a value greater than 0, the LineSmoothing flag is set to true.

double IG::Gr::PlotZedgraphCurve::PointSize [get, set]

Type of symbol used for drawing points, specified as int.

int IG::Gr::PlotZedgraphCurve::PointType [get, set]

Type of symbol used for drawing points, specified as int.

SymbolType IG::Gr::PlotZedgraphCurve::PointTypeSymbol [get, set]

Type of symbol used for drawing points, specified as SymbolType enum.

color IG::Gr::PlotZedgraphCurve::PointColor [set]

Collectively sets point border color (PointBorderColor) and point fill color (PointFillColor) to the same value.

color IG::Gr::PlotZedgraphCurve::PointBorderColor [get, set]

Color for plotting points outline (border).

color IG::Gr::PlotZedgraphCurve::PointFillColor [get, set]

Points fill color.

bool IG::Gr::PlotZedgraphCurve::IsX2Axis [get, set]
bool IG::Gr::PlotZedgraphCurve::IsY2Axis [get, set]
bool IG::Gr::PlotZedgraphCurve::Is2Axis [get, set]
LineItem IG::Gr::PlotZedgraphCurve::CurveItem [get, set]

LineItem that is put to the GraphPane. Object can be removed from the pane through this property.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties Events