ScottPlot
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Properties | List of all members
ScottPlot.CoordinateLine Struct Reference

Represents a straight line in coordinate space. More...

Public Member Functions

 CoordinateLine (double x1, double y1, double x2, double y2)
 
 CoordinateLine (Coordinates pt1, Coordinates pt2)
 
 CoordinateLine (double x, double y, double slope)
 
 CoordinateLine (Coordinates point, double slope)
 
override string ToString ()
 
CoordinateLine ExtendTo (CoordinateRect rect)
 Adjust the line to fit within the boundaries of the given rectangle. The slope and Y intercept will not be changed.
 
double X (double y=0)
 Return the X position on the line at the given Y.
 
double Y (double x=0)
 Return the Y position on the line at the given X.
 
CoordinateLine WithDelta (double dX, double dY)
 
CoordinateLine Reversed ()
 

Public Attributes

readonly double X1
 
readonly double X2
 
readonly double Y1
 
readonly double Y2
 

Properties

double XSpan [get]
 
double YSpan [get]
 
double Slope [get]
 
double SlopeRadians [get]
 
double SlopeDegrees [get]
 
double YIntercept [get]
 
float Length [get]
 
Coordinates Start [get]
 
Coordinates End [get]
 
Coordinates Center [get]
 

Detailed Description

Represents a straight line in coordinate space.

Constructor & Destructor Documentation

◆ CoordinateLine() [1/4]

ScottPlot.CoordinateLine.CoordinateLine ( double  x1,
double  y1,
double  x2,
double  y2 
)
inline

◆ CoordinateLine() [2/4]

ScottPlot.CoordinateLine.CoordinateLine ( Coordinates  pt1,
Coordinates  pt2 
)
inline

◆ CoordinateLine() [3/4]

ScottPlot.CoordinateLine.CoordinateLine ( double  x,
double  y,
double  slope 
)
inline

◆ CoordinateLine() [4/4]

ScottPlot.CoordinateLine.CoordinateLine ( Coordinates  point,
double  slope 
)
inline

Member Function Documentation

◆ ExtendTo()

CoordinateLine ScottPlot.CoordinateLine.ExtendTo ( CoordinateRect  rect)
inline

Adjust the line to fit within the boundaries of the given rectangle. The slope and Y intercept will not be changed.

◆ Reversed()

CoordinateLine ScottPlot.CoordinateLine.Reversed ( )
inline

◆ ToString()

override string ScottPlot.CoordinateLine.ToString ( )
inline

◆ WithDelta()

CoordinateLine ScottPlot.CoordinateLine.WithDelta ( double  dX,
double  dY 
)
inline

◆ X()

double ScottPlot.CoordinateLine.X ( double  y = 0)
inline

Return the X position on the line at the given Y.

◆ Y()

double ScottPlot.CoordinateLine.Y ( double  x = 0)
inline

Return the Y position on the line at the given X.

Member Data Documentation

◆ X1

readonly double ScottPlot.CoordinateLine.X1

◆ X2

readonly double ScottPlot.CoordinateLine.X2

◆ Y1

readonly double ScottPlot.CoordinateLine.Y1

◆ Y2

readonly double ScottPlot.CoordinateLine.Y2

Property Documentation

◆ Center

Coordinates ScottPlot.CoordinateLine.Center
get

◆ End

Coordinates ScottPlot.CoordinateLine.End
get

◆ Length

float ScottPlot.CoordinateLine.Length
get

◆ Slope

double ScottPlot.CoordinateLine.Slope
get

◆ SlopeDegrees

double ScottPlot.CoordinateLine.SlopeDegrees
get

◆ SlopeRadians

double ScottPlot.CoordinateLine.SlopeRadians
get

◆ Start

Coordinates ScottPlot.CoordinateLine.Start
get

◆ XSpan

double ScottPlot.CoordinateLine.XSpan
get

◆ YIntercept

double ScottPlot.CoordinateLine.YIntercept
get

◆ YSpan

double ScottPlot.CoordinateLine.YSpan
get

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