Show / Hide Table of Contents

Class PointF

Point class.

Inheritance
System.Object
PointF
Implements
System.IEquatable<PointF>
Namespace: BonEngineSharp.Framework
Assembly: BonEngineSharp.dll
Syntax
public sealed class PointF : ValueType, IEquatable<PointF>

Constructors

PointF(Single, Single)

Create the point.

Declaration
public PointF(float x = 0F, float y = 0F)
Parameters
Type Name Description
System.Single x
System.Single y

Fields

Half

Point with value 0.5, 0.5.

Declaration
public static readonly PointF Half
Field Value
Type Description
PointF

One

Point with value 1,1.

Declaration
public static readonly PointF One
Field Value
Type Description
PointF

X

X component of the point.

Declaration
public float X
Field Value
Type Description
System.Single

Y

Y component of the point.

Declaration
public float Y
Field Value
Type Description
System.Single

Zero

Point with value 0,0.

Declaration
public static readonly PointF Zero
Field Value
Type Description
PointF

Properties

Magnitude

Calc point magnitude.

Declaration
public float Magnitude { get; }
Property Value
Type Description
System.Single

Methods

Add(PointF)

Add point with a point.

Declaration
public PointF Add(PointF other)
Parameters
Type Name Description
PointF other
Returns
Type Description
PointF

Add(Single)

Add point with a scalar.

Declaration
public PointF Add(float scalar)
Parameters
Type Name Description
System.Single scalar
Returns
Type Description
PointF

Add(Single, Single)

Add point with a point.

Declaration
public PointF Add(float x, float y)
Parameters
Type Name Description
System.Single x
System.Single y
Returns
Type Description
PointF

AddSelf(PointF)

Add point with a point.

Declaration
public PointF AddSelf(PointF other)
Parameters
Type Name Description
PointF other
Returns
Type Description
PointF

AddSelf(Single)

Add point with a scalar.

Declaration
public PointF AddSelf(float scalar)
Parameters
Type Name Description
System.Single scalar
Returns
Type Description
PointF

AddSelf(Single, Single)

Add point with a point.

Declaration
public PointF AddSelf(float x, float y)
Parameters
Type Name Description
System.Single x
System.Single y
Returns
Type Description
PointF

Clone()

Clone point.

Declaration
public PointF Clone()
Returns
Type Description
PointF

DistanceTo(PointF)

Get distance to another point.

Declaration
public float DistanceTo(PointF other)
Parameters
Type Name Description
PointF other
Returns
Type Description
System.Single

Divide(PointF)

Divide point with a point.

Declaration
public PointF Divide(PointF other)
Parameters
Type Name Description
PointF other
Returns
Type Description
PointF

Divide(Single)

Divide point with a scalar.

Declaration
public PointF Divide(float scalar)
Parameters
Type Name Description
System.Single scalar
Returns
Type Description
PointF

Divide(Single, Single)

Divide point with a point.

Declaration
public PointF Divide(float x, float y)
Parameters
Type Name Description
System.Single x
System.Single y
Returns
Type Description
PointF

DivideSelf(PointF)

Divide point with a point.

Declaration
public PointF DivideSelf(PointF other)
Parameters
Type Name Description
PointF other
Returns
Type Description
PointF

DivideSelf(Single)

Divide point with a scalar.

Declaration
public PointF DivideSelf(float scalar)
Parameters
Type Name Description
System.Single scalar
Returns
Type Description
PointF

DivideSelf(Single, Single)

Divide point with a point.

Declaration
public PointF DivideSelf(float x, float y)
Parameters
Type Name Description
System.Single x
System.Single y
Returns
Type Description
PointF

Equals(PointF)

Check if this point equals to another point.

Declaration
public bool Equals(PointF other)
Parameters
Type Name Description
PointF other
Returns
Type Description
System.Boolean

Equals(Object)

Check if this point equals to another object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

FromAngle(Int32)

Convert direction in degrees to Point.

Declaration
public static PointF FromAngle(int directionDegrees)
Parameters
Type Name Description
System.Int32 directionDegrees
Returns
Type Description
PointF

FromString(String)

Create point from string.

Declaration
public static PointF FromString(string str)
Parameters
Type Name Description
System.String str

String to parse, must be in format "x,y".

Returns
Type Description
PointF

Point instance.

GetHashCode()

Implement hash code of point.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Lerp(PointF, PointF, Single)

Lerp between two points.

Declaration
public static PointF Lerp(PointF a, PointF b, float delta)
Parameters
Type Name Description
PointF a

From point.

PointF b

To point.

System.Single delta

Lerp factor.

Returns
Type Description
PointF

Lerped point.

Multiply(PointF)

Multiply point with a point.

Declaration
public PointF Multiply(PointF other)
Parameters
Type Name Description
PointF other
Returns
Type Description
PointF

Multiply(Single)

Multiply point with a scalar.

Declaration
public PointF Multiply(float scalar)
Parameters
Type Name Description
System.Single scalar
Returns
Type Description
PointF

Multiply(Single, Single)

Multiply point with a point.

Declaration
public PointF Multiply(float x, float y)
Parameters
Type Name Description
System.Single x
System.Single y
Returns
Type Description
PointF

MultiplySelf(PointF)

Multiply point with a point.

Declaration
public PointF MultiplySelf(PointF other)
Parameters
Type Name Description
PointF other
Returns
Type Description
PointF

MultiplySelf(Single)

Multiply point with a scalar.

Declaration
public PointF MultiplySelf(float scalar)
Parameters
Type Name Description
System.Single scalar
Returns
Type Description
PointF

MultiplySelf(Single, Single)

Multiply point with a point.

Declaration
public PointF MultiplySelf(float x, float y)
Parameters
Type Name Description
System.Single x
System.Single y
Returns
Type Description
PointF

Normalize()

Normalize this point value.

Declaration
public void Normalize()

Rotate(Single)

Rotate clone by degrees.

Declaration
public PointF Rotate(float angle)
Parameters
Type Name Description
System.Single angle
Returns
Type Description
PointF

RotateSelf(Single)

Rotate self by degrees.

Declaration
public PointF RotateSelf(float angle)
Parameters
Type Name Description
System.Single angle
Returns
Type Description
PointF

Set(Single, Single)

Set point values.

Declaration
public void Set(float x, float y)
Parameters
Type Name Description
System.Single x
System.Single y

Substract(PointF)

Substract point with a point.

Declaration
public PointF Substract(PointF other)
Parameters
Type Name Description
PointF other
Returns
Type Description
PointF

Substract(Single)

Substract point with a scalar.

Declaration
public PointF Substract(float scalar)
Parameters
Type Name Description
System.Single scalar
Returns
Type Description
PointF

Substract(Single, Single)

Substract point with a point.

Declaration
public PointF Substract(float x, float y)
Parameters
Type Name Description
System.Single x
System.Single y
Returns
Type Description
PointF

SubstractSelf(PointF)

Substract point with a point.

Declaration
public PointF SubstractSelf(PointF other)
Parameters
Type Name Description
PointF other
Returns
Type Description
PointF

SubstractSelf(Single)

Substract point with a scalar.

Declaration
public PointF SubstractSelf(float scalar)
Parameters
Type Name Description
System.Single scalar
Returns
Type Description
PointF

SubstractSelf(Single, Single)

Substract point with a point.

Declaration
public PointF SubstractSelf(float x, float y)
Parameters
Type Name Description
System.Single x
System.Single y
Returns
Type Description
PointF

ToAngle()

Convert point to degree.

Declaration
public short ToAngle()
Returns
Type Description
System.Int16

Operators

Equality(PointF, PointF)

Implement == operator.

Declaration
public static bool operator ==(PointF obj1, PointF obj2)
Parameters
Type Name Description
PointF obj1
PointF obj2
Returns
Type Description
System.Boolean

Implicit(PointF to PointI)

Implicit conversion to pointI.

Declaration
public static implicit operator PointI(PointF p)
Parameters
Type Name Description
PointF p
Returns
Type Description
PointI

Inequality(PointF, PointF)

Implement != operator.

Declaration
public static bool operator !=(PointF obj1, PointF obj2)
Parameters
Type Name Description
PointF obj1
PointF obj2
Returns
Type Description
System.Boolean

Implements

System.IEquatable<>
Back to top Generated by DocFX