1118OPSSNew/Assets/3rdParty/MSG-Machinery/Plugins/MGS/MGS.Mathematics.xml

546 lines
21 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>MGS.Mathematics</name>
</assembly>
<members>
<member name="T:MGS.Mathematics.Vector">
<summary>
Vector in plane rectangular coordinate system.
</summary>
</member>
<member name="F:MGS.Mathematics.Vector.x">
<summary>
X of vector.
</summary>
</member>
<member name="F:MGS.Mathematics.Vector.y">
<summary>
Y of vector.
</summary>
</member>
<member name="P:MGS.Mathematics.Vector.Zero">
<summary>
Origin(0,0) of plane rectangular coordinate system.
</summary>
</member>
<member name="P:MGS.Mathematics.Vector.One">
<summary>
Vector(1,1) in plane rectangular coordinate system.
</summary>
</member>
<member name="M:MGS.Mathematics.Vector.#ctor(System.Double,System.Double)">
<summary>
Constructor.
</summary>
<param name="x">X of vector.</param>
<param name="y">Y of vector.</param>
</member>
<member name="M:MGS.Mathematics.Vector.Equals(System.Object)">
<summary>
Equals?
</summary>
<param name="obj">Target obj.</param>
<returns>Equals?</returns>
</member>
<member name="M:MGS.Mathematics.Vector.GetHashCode">
<summary>
Get hash code.
</summary>
<returns>Hash code.</returns>
</member>
<member name="M:MGS.Mathematics.Vector.ToString">
<summary>
To string.
</summary>
<returns>String.</returns>
</member>
<member name="M:MGS.Mathematics.Vector.Center(MGS.Mathematics.Vector,MGS.Mathematics.Vector)">
<summary>
Center of vector v1 and v2.
</summary>
<param name="v1">Vector v1.</param>
<param name="v2">Vector v2.</param>
<returns>The center of vector v1 and v2.</returns>
</member>
<member name="M:MGS.Mathematics.Vector.Distance(MGS.Mathematics.Vector,MGS.Mathematics.Vector)">
<summary>
Distance from vector v1 to v2.
</summary>
<param name="v1">Vector v1.</param>
<param name="v2">Vector v2.</param>
<returns>Distance from vector v1 to v2.</returns>
</member>
<member name="M:MGS.Mathematics.Vector.op_Addition(MGS.Mathematics.Vector,MGS.Mathematics.Vector)">
<summary>
Operator +
</summary>
<param name="lhs">Vector1.</param>
<param name="rhs">Vector2.</param>
<returns>lhs+rhs</returns>
</member>
<member name="M:MGS.Mathematics.Vector.op_Subtraction(MGS.Mathematics.Vector,MGS.Mathematics.Vector)">
<summary>
Operator -
</summary>
<param name="lhs">Vector1.</param>
<param name="rhs">Vector2.</param>
<returns>lhs-rhs</returns>
</member>
<member name="M:MGS.Mathematics.Vector.op_UnaryNegation(MGS.Mathematics.Vector)">
<summary>
Operator -
</summary>
<param name="p">Vector</param>
<returns>-Vector</returns>
</member>
<member name="M:MGS.Mathematics.Vector.op_Multiply(MGS.Mathematics.Vector,System.Double)">
<summary>
Operator *
</summary>
<param name="lhs">Vector.</param>
<param name="rhs">double.</param>
<returns>lhs*rhs</returns>
</member>
<member name="M:MGS.Mathematics.Vector.op_Multiply(System.Double,MGS.Mathematics.Vector)">
<summary>
Operator *
</summary>
<param name="lhs">double.</param>
<param name="rhs">Vector.</param>
<returns>lhs*rhs</returns>
</member>
<member name="M:MGS.Mathematics.Vector.op_Equality(MGS.Mathematics.Vector,MGS.Mathematics.Vector)">
<summary>
Operator ==
</summary>
<param name="lhs">Vector1.</param>
<param name="rhs">Vector2.</param>
<returns>lhs==rhs?</returns>
</member>
<member name="M:MGS.Mathematics.Vector.op_Inequality(MGS.Mathematics.Vector,MGS.Mathematics.Vector)">
<summary>
Operator !=
</summary>
<param name="lhs">Vector1.</param>
<param name="rhs">Vector2.</param>
<returns>lhs!=rhs?</returns>
</member>
<member name="T:MGS.Mathematics.Circle">
<summary>
Circle in plane rectangular coordinate system.
</summary>
</member>
<member name="F:MGS.Mathematics.Circle.c">
<summary>
Center.
</summary>
</member>
<member name="F:MGS.Mathematics.Circle.r">
<summary>
Radius.
</summary>
</member>
<member name="P:MGS.Mathematics.Circle.Unit">
<summary>
Unit circle.
</summary>
</member>
<member name="M:MGS.Mathematics.Circle.#ctor(MGS.Mathematics.Vector,System.Double)">
<summary>
Constructor.
</summary>
<param name="c">Center.</param>
<param name="r">Radius.</param>
</member>
<member name="T:MGS.Mathematics.Line">
<summary>
Line in plane rectangular coordinate system.
</summary>
</member>
<member name="F:MGS.Mathematics.Line.k">
<summary>
Slope of line.
</summary>
</member>
<member name="F:MGS.Mathematics.Line.b">
<summary>
Intercept of line.
</summary>
</member>
<member name="P:MGS.Mathematics.Line.Horizontal">
<summary>
Horizontal line (x axis).
</summary>
</member>
<member name="P:MGS.Mathematics.Line.Vertical">
<summary>
Vertical line (y axis).
</summary>
</member>
<member name="M:MGS.Mathematics.Line.#ctor(System.Double,System.Double)">
<summary>
Constructor.
</summary>
<param name="k">Slope of line.</param>
<param name="b">Intercept of line.</param>
</member>
<member name="M:MGS.Mathematics.Line.FromPoints(MGS.Mathematics.Vector,MGS.Mathematics.Vector)">
<summary>
Get the line that pass vector v1 and v2.
</summary>
<param name="v1">Vector p1.</param>
<param name="v2">Vector p2.</param>
<returns>The line that pass vector v1 and v2.</returns>
</member>
<member name="T:MGS.Mathematics.Relation">
<summary>
Position relation.
</summary>
</member>
<member name="F:MGS.Mathematics.Relation.Undefined">
<summary>
Undefined relation.
</summary>
</member>
<member name="F:MGS.Mathematics.Relation.Coincidence">
<summary>
Coincidence.
</summary>
</member>
<member name="F:MGS.Mathematics.Relation.External">
<summary>
External.
</summary>
</member>
<member name="F:MGS.Mathematics.Relation.Internal">
<summary>
Internal.
</summary>
</member>
<member name="F:MGS.Mathematics.Relation.Parallel">
<summary>
Parallel.
</summary>
</member>
<member name="F:MGS.Mathematics.Relation.Vertical">
<summary>
Vertical.
</summary>
</member>
<member name="F:MGS.Mathematics.Relation.Intersect">
<summary>
Intersect
</summary>
</member>
<member name="F:MGS.Mathematics.Relation.OutsideTangent">
<summary>
Outside tangent.
</summary>
</member>
<member name="F:MGS.Mathematics.Relation.InsideTangent">
<summary>
Inside tangent.
</summary>
</member>
<member name="T:MGS.Mathematics.Planimetry">
<summary>
Planimetry.
</summary>
</member>
<member name="M:MGS.Mathematics.Planimetry.GetDistance(MGS.Mathematics.Line,MGS.Mathematics.Line)">
<summary>
Gets the distance from line L1 to line L2.
</summary>
<param name="L1">line L1.</param>
<param name="L2">line L2.</param>
<returns>The distance from line L1 to line L2.</returns>
</member>
<member name="M:MGS.Mathematics.Planimetry.GetDistance(MGS.Mathematics.Vector,MGS.Mathematics.Line)">
<summary>
Gets the distance from vector to line.
</summary>
<param name="v">Vector.</param>
<param name="L">Line.</param>
<returns>The distance from vector to line.</returns>
</member>
<member name="M:MGS.Mathematics.Planimetry.GetRelation(MGS.Mathematics.Circle,MGS.Mathematics.Circle)">
<summary>
Get relation of two circles.
</summary>
<param name="c1">Circle c1.</param>
<param name="c2">Circle c2.</param>
<returns>Relation of two circles.</returns>
</member>
<member name="M:MGS.Mathematics.Planimetry.GetRelation(MGS.Mathematics.Circle,MGS.Mathematics.Line)">
<summary>
Get relation of circle and line.
</summary>
<param name="c">Circle.</param>
<param name="L">Line.</param>
<returns>Relation of circle and line.</returns>
</member>
<member name="M:MGS.Mathematics.Planimetry.GetRelation(MGS.Mathematics.Circle,MGS.Mathematics.Vector)">
<summary>
Get relation of circle and vector.
</summary>
<param name="c">Circle.</param>
<param name="v">Vector.</param>
<returns>Relation of circle and vector.</returns>
</member>
<member name="M:MGS.Mathematics.Planimetry.GetRelation(MGS.Mathematics.Line,MGS.Mathematics.Line)">
<summary>
Get relation of two lines.
</summary>
<param name="L1">Line L1.</param>
<param name="L2">Line L2.</param>
<returns>Relation of two lines.</returns>
</member>
<member name="M:MGS.Mathematics.Planimetry.GetRelation(MGS.Mathematics.Line,MGS.Mathematics.Vector)">
<summary>
Get relation of line and vector.
</summary>
<param name="L">Line.</param>
<param name="v">Vector.</param>
<returns>Relation of line and vector.</returns>
</member>
<member name="M:MGS.Mathematics.Planimetry.GetIntersections(MGS.Mathematics.Circle,MGS.Mathematics.Circle)">
<summary>
Get intersections of two circles.
</summary>
<param name="c1">Circle c1.</param>
<param name="c2">Circle c2.</param>
<returns>Intersections of two circles.</returns>
</member>
<member name="M:MGS.Mathematics.Planimetry.GetIntersections(MGS.Mathematics.Circle,MGS.Mathematics.Line)">
<summary>
Get intersections of circle and line.
</summary>
<param name="C">Circle.</param>
<param name="L">Line.</param>
<returns>Intersections of circle and line.</returns>
</member>
<member name="M:MGS.Mathematics.Planimetry.GetIntersections(MGS.Mathematics.Line,MGS.Mathematics.Line)">
<summary>
Get intersection of two lines.
</summary>
<param name="L1">Line L1.</param>
<param name="L2">Line L2.</param>
<returns>Intersection of two lines.</returns>
</member>
<member name="T:MGS.Mathematics.Hermite">
<summary>
Hermite interpolation.
</summary>
</member>
<member name="M:MGS.Mathematics.Hermite.Evaluate(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
<summary>
Evaluate the value of hermite curve at time.
</summary>
<param name="t0">Time of start key frame.</param>
<param name="t1">Time of end key frame.</param>
<param name="v0">Value of start key frame.</param>
<param name="v1">Value of end key frame.</param>
<param name="m0">Micro quotient value of start key frame.</param>
<param name="m1">Micro quotient value of end key frame.</param>
<param name="t">Time of curve to evaluate value.</param>
<returns>The value of hermite curve at time.</returns>
</member>
<member name="T:MGS.Mathematics.KeyFrame">
<summary>
Key frame base on time and value.
</summary>
</member>
<member name="F:MGS.Mathematics.KeyFrame.time">
<summary>
Time of key frame.
</summary>
</member>
<member name="F:MGS.Mathematics.KeyFrame.value">
<summary>
Value of key frame.
</summary>
</member>
<member name="F:MGS.Mathematics.KeyFrame.inTangent">
<summary>
In tangent of key frame.
</summary>
</member>
<member name="F:MGS.Mathematics.KeyFrame.outTangent">
<summary>
Out tangent of key frame.
</summary>
</member>
<member name="M:MGS.Mathematics.KeyFrame.#ctor(System.Double,System.Double)">
<summary>
Constructor.
</summary>
<param name="time">Time of key frame.</param>
<param name="value">Value of key frame.</param>
</member>
<member name="M:MGS.Mathematics.KeyFrame.#ctor(System.Double,System.Double,System.Double,System.Double)">
<summary>
Constructor.
</summary>
<param name="time">Time of key frame.</param>
<param name="value">Value of key frame.</param>
<param name="inTangent">In tangent of key frame.</param>
<param name="outTangent">Out tangent of key frame.</param>
</member>
<member name="T:MGS.Mathematics.HermiteCurve">
<summary>
Piecewise three hermite spline curve.
</summary>
</member>
<member name="P:MGS.Mathematics.HermiteCurve.Item(System.Int32)">
<summary>
Indexer.
</summary>
<param name="index">Index of key frame.</param>
<returns>The key frame at index.</returns>
</member>
<member name="F:MGS.Mathematics.HermiteCurve.frames">
<summary>
Key frames of curve.
</summary>
</member>
<member name="P:MGS.Mathematics.HermiteCurve.KeyFramesCount">
<summary>
Count of key frames.
</summary>
</member>
<member name="M:MGS.Mathematics.HermiteCurve.#ctor">
<summary>
Constructor.
</summary>
</member>
<member name="M:MGS.Mathematics.HermiteCurve.#ctor(MGS.Mathematics.KeyFrame[])">
<summary>
Constructor.
</summary>
<param name="frames">Key frames of curve.</param>
</member>
<member name="M:MGS.Mathematics.HermiteCurve.Evaluate(System.Double)">
<summary>
Evaluate the value of hermite curve at time.
</summary>
<param name="t">Time of curve to evaluate value.</param>
<returns>The value of hermite curve at time.</returns>
</member>
<member name="M:MGS.Mathematics.HermiteCurve.AddKeyFrame(System.Double,System.Double)">
<summary>
Add key frame to curve.
</summary>
<param name="time">Time of key frame.</param>
<param name="value">Value of key frame.</param>
</member>
<member name="M:MGS.Mathematics.HermiteCurve.AddKeyFrame(MGS.Mathematics.KeyFrame)">
<summary>
Add key frame to curve.
</summary>
<param name="keyFrame">Key frame to add.</param>
</member>
<member name="M:MGS.Mathematics.HermiteCurve.RemoveKeyFrameAt(System.Int32)">
<summary>
Remove key frame at index.
</summary>
<param name="index">Index of key frame.</param>
</member>
<member name="M:MGS.Mathematics.HermiteCurve.Evaluate(MGS.Mathematics.KeyFrame,MGS.Mathematics.KeyFrame,System.Double)">
<summary>
Evaluate the value of hermite curve at time on the range from start key frame to end key frame.
</summary>
<param name="start">Start key frame of hermite curve.</param>
<param name="end">End key frame of hermite curve.</param>
<param name="t">Time of curve to evaluate value.</param>
<returns>The value of hermite curve at time on the range from start key frame to end key frame.</returns>
</member>
<member name="M:MGS.Mathematics.HermiteCurve.Evaluate(MGS.Mathematics.KeyFrame[],System.Double)">
<summary>
Evaluate the value of hermite curve at time.
</summary>
<param name="frames">Key frames of hermite curve.</param>
<param name="t"></param>
<returns>The value of hermite curve at time.</returns>
</member>
<member name="T:MGS.Mathematics.Maths">
<summary>
Mathematical concepts and methods.
</summary>
</member>
<member name="M:MGS.Mathematics.Maths.Lerp(System.Double,System.Double,System.Double)">
<summary>
Interpolates between a and b by t.
</summary>
<param name="from">Start value of interpolate value.</param>
<param name="to">End value of interpolate value.</param>
<param name="t">t is clamped between 0 and 1.</param>
<returns></returns>
</member>
<member name="T:MGS.Mathematics.LinearSmooth">
<summary>
Linear Smooth.
</summary>
</member>
<member name="M:MGS.Mathematics.LinearSmooth.ThreePointSmooth(System.Double[])">
<summary>
Three point linear smooth.
</summary>
<param name="source">Data source.</param>
<returns>Smooth result.</returns>
</member>
<member name="M:MGS.Mathematics.LinearSmooth.FivePointSmooth(System.Double[])">
<summary>
Five point linear smooth.
</summary>
<param name="source">Data source.</param>
<returns>Smooth result.</returns>
</member>
<member name="M:MGS.Mathematics.LinearSmooth.SevenPointSmooth(System.Double[])">
<summary>
Seven point linear smooth.
</summary>
<param name="source">Data source.</param>
<returns>Smooth result.</returns>
</member>
<member name="T:MGS.Mathematics.QuadraticSmooth">
<summary>
Quadratic Smooth.
</summary>
</member>
<member name="M:MGS.Mathematics.QuadraticSmooth.FivePointSmooth(System.Double[])">
<summary>
Five point quadratic smooth.
</summary>
<param name="source">Data source.</param>
<returns>Smooth result.</returns>
</member>
<member name="M:MGS.Mathematics.QuadraticSmooth.SevenPointSmooth(System.Double[])">
<summary>
Seven point quadratic smooth.
</summary>
<param name="source">Data source.</param>
<returns>Smooth result.</returns>
</member>
<member name="T:MGS.Mathematics.CubicSmooth">
<summary>
Cubic Smooth.
</summary>
</member>
<member name="M:MGS.Mathematics.CubicSmooth.FivePointSmooth(System.Double[])">
<summary>
Five point cubic smooth.
</summary>
<param name="source">Data source.</param>
<returns>Smooth result.</returns>
</member>
<member name="M:MGS.Mathematics.CubicSmooth.SevenPointSmooth(System.Double[])">
<summary>
Seven point cubic smooth.
</summary>
<param name="source">Data source.</param>
<returns>Smooth result.</returns>
</member>
</members>
</doc>