Pt (Euclid) | Euclid

Pt Type

Namespace: Euclid
Assembly: Euclid.dll
Base Type: ValueType
Kind: Struct

Pt is an immutable 2D point. Made up from 2 floats: X and Y.

3D Points are called 'Pnt'

Record fields

Record Field	Description
`X` Full Usage: `X` Field type: `float`	The field holding the X part of this 2D point. Field type: `float`
`Y` Full Usage: `Y` Field type: `float`	The field holding the Y part of this 2D point. Field type: `float`

Constructors

Constructor	Description
`Pt(x, y)` Full Usage: `Pt(x, y)` Parameters: x : `float` y : `float` Returns: `Pt`	Create a new 2D point from X and Y coordinates. When compiled in DEBUG or with CHECK_EUCLID symbol defined, this constructor checks for NaN and Infinity values and raises an exception if any are found. This check is skipped in release mode for performance reasons. x : `float` y : `float` Returns: `Pt`

Instance members

Instance member	Description
`this.AsFSharpCode` Full Usage: `this.AsFSharpCode` Returns: `string`	Format 2D point into an F# code string that can be used to recreate the point. Returns: `string`
`this.AsString` Full Usage: `this.AsString` Returns: `string`	Format 2D point into string with nice floating point number formatting of X and Y But without full type name as in p.ToString() Returns: `string`

Static members

Static member	Description
`f * a` Full Usage: `f * a` Parameters: f : `float` a : `Pt` Returns: `Pt` Modifiers: inline	Multiplies a scalar with a 2D point, also called scaling a point. Returns a new 2D point. f : `float` a : `Pt` Returns: `Pt`
`a * f` Full Usage: `a * f` Parameters: a : `Pt` f : `float` Returns: `Pt` Modifiers: inline	Multiplies a 2D point with a scalar, also called scaling a point. Returns a new 2D point. a : `Pt` f : `float` Returns: `Pt`
`a + b` Full Usage: `a + b` Parameters: a : `Pt` b : `Pt` Returns: `Pt` Modifiers: inline	Add two 2D points together. Returns a new 2D point. a : `Pt` b : `Pt` Returns: `Pt`
`p + v` Full Usage: `p + v` Parameters: p : `Pt` v : `UnitVc` Returns: `Pt` Modifiers: inline	Add a unit-vector to a 2D point. Returns a new 2D point. p : `Pt` v : `UnitVc` Returns: `Pt`
`p + v` Full Usage: `p + v` Parameters: p : `Pt` v : `Vc` Returns: `Pt` Modifiers: inline	Add a vector to a 2D point. Returns a new 2D point. p : `Pt` v : `Vc` Returns: `Pt`
`a - b` Full Usage: `a - b` Parameters: a : `Pt` b : `UnitVc` Returns: `Pt` Modifiers: inline	Subtract a unit-vector from a 2D point. Returns a new 2D point. a : `Pt` b : `UnitVc` Returns: `Pt`
`a - b` Full Usage: `a - b` Parameters: a : `Pt` b : `Vc` Returns: `Pt` Modifiers: inline	Subtract a vector from a 2D point. Returns a new 2D point. a : `Pt` b : `Vc` Returns: `Pt`
`a - b` Full Usage: `a - b` Parameters: a : `Pt` b : `Pt` Returns: `Vc` Modifiers: inline	Subtract one 2D point from another. 'a-b' returns a new 2D vector from b to a. a : `Pt` b : `Pt` Returns: `Vc`
`p / f` Full Usage: `p / f` Parameters: p : `Pt` f : `float` Returns: `Pt` Modifiers: inline	Divides a 2D point by a scalar, also called dividing/scaling a point. Returns a new 2D point. p : `Pt` f : `float` Returns: `Pt`
`Pt.DivideByInt(pt, i)` Full Usage: `Pt.DivideByInt(pt, i)` Parameters: pt : `Pt` i : `int` Returns: `Pt`	Divides the 2D point by an integer. (This member is needed by Array.average and similar functions) pt : `Pt` i : `int` Returns: `Pt`
`Pt.Origin` Full Usage: `Pt.Origin` Returns: `Pt` Modifiers: inline	Same as Pt.Zero. Returns: `Pt`
`Pt.Zero` Full Usage: `Pt.Zero` Returns: `Pt` Modifiers: inline	Same as Pt.Origin. Returns: `Pt`