LiveMap API
Loading...
Searching...
No Matches
livemap.data.Point Struct Reference

Represents a point on the map. More...

Public Member Functions

 Point (double[] arr)
 Create a new point from a coordinate array.
 Point (double x, double z)
 Create a new point from coordinates.
Point Add (double num)
 Adds the specified amount to the point's axis values.
Point Add (Point point)
 Adds the specified point's axis values to this point's axis values.
Point Subtract (double num)
 Subtracts the specified amount to the point's axis values.
Point Subtract (Point point)
 Subtracts the specified point's axis values to this point's axis values.
Point Multiply (double num)
 Multiplies the specified amount to the point's axis values.
Point Multiply (Point point)
 Multiplies the specified point's axis values to this point's axis values.
Point Divide (double num)
 Divides the specified amount to the point's axis values.
Point Divide (Point point)
 Divides the specified point's axis values from this point's axis values.
Point Ceil ()
 Round the point values up to the nearest integer.
Point Floor ()
 Round the point values down to the nearest integer.
Point Round ()
 Round the point values to the nearest integer.
override bool Equals (object? obj)
bool Equals (double x, double z)
 Determines whether the specified values are equal to the current object's values.
override string ToString ()
override int GetHashCode ()

Static Public Member Functions

static implicit operator Point (double[] value)
static implicit operator double[] (Point value)
static Point operator+ (Point left, Point right)
static Point operator+ (Point left, double right)
static Point operator+ (double left, Point right)
static Point operator- (Point left, Point right)
static Point operator- (Point left, double right)
static Point operator- (double left, Point right)
static Point operator* (Point left, Point right)
static Point operator* (Point left, double right)
static Point operator* (double left, Point right)
static Point operator/ (Point left, Point right)
static Point operator/ (Point left, double right)
static Point operator/ (double left, Point right)
static bool operator== (Point? left, Point? right)
static bool operator!= (Point? left, Point? right)

Properties

double X [get]
 The value of the X axis of this point.
double Z [get]
 The value of the Z axis of this point.
double this[int index] [get]
 Get the axis value of the specified index.

Detailed Description

Represents a point on the map.

Constructor & Destructor Documentation

◆ Point() [1/2]

livemap.data.Point.Point ( double[] arr)
inline

Create a new point from a coordinate array.

Parameters
arr

◆ Point() [2/2]

livemap.data.Point.Point ( double x,
double z )
inline

Create a new point from coordinates.

Parameters
x
z

Member Function Documentation

◆ Add() [1/2]

Point livemap.data.Point.Add ( double num)

Adds the specified amount to the point's axis values.

Parameters
numThe value to add to the point's axis values
Returns
A new point with the added axis values

◆ Add() [2/2]

Point livemap.data.Point.Add ( Point point)

Adds the specified point's axis values to this point's axis values.

Parameters
pointThe point to add to this point's axis values
Returns
A new point with the added axis values

◆ Ceil()

Point livemap.data.Point.Ceil ( )

Round the point values up to the nearest integer.

Returns
A new point with the values rounded up to the nearest integer

◆ Divide() [1/2]

Point livemap.data.Point.Divide ( double num)

Divides the specified amount to the point's axis values.

Parameters
numThe value to divide to the point's axis values
Returns
A new point with the divided axis values

◆ Divide() [2/2]

Point livemap.data.Point.Divide ( Point point)

Divides the specified point's axis values from this point's axis values.

Parameters
pointThe point to divide from this point's axis values
Returns
A new point with the divided axis values

◆ Equals() [1/2]

bool livemap.data.Point.Equals ( double x,
double z )

Determines whether the specified values are equal to the current object's values.

Parameters
xThe x value to compare with the current object
zThe z value to compare with the current object
Returns
true if the specified values are equal to the current object's values

◆ Equals() [2/2]

override bool livemap.data.Point.Equals ( object? obj)

◆ Floor()

Point livemap.data.Point.Floor ( )

Round the point values down to the nearest integer.

Returns
A new point with the values rounded down to the nearest integer

◆ GetHashCode()

override int livemap.data.Point.GetHashCode ( )

◆ Multiply() [1/2]

Point livemap.data.Point.Multiply ( double num)

Multiplies the specified amount to the point's axis values.

Parameters
numThe value to multiply to the point's axis values
Returns
A new point with the multiplied axis values

◆ Multiply() [2/2]

Point livemap.data.Point.Multiply ( Point point)

Multiplies the specified point's axis values to this point's axis values.

Parameters
pointThe point to multiply to this point's axis values
Returns
A new point with the multiplied axis values

◆ operator double[]()

implicit livemap.data.Point.operator double[] ( Point value)
static

◆ operator Point()

implicit livemap.data.Point.operator Point ( double[] value)
static

◆ operator!=()

bool livemap.data.Point.operator!= ( Point? left,
Point? right )
static

◆ operator*() [1/3]

Point livemap.data.Point.operator* ( double left,
Point right )
static

◆ operator*() [2/3]

Point livemap.data.Point.operator* ( Point left,
double right )
static

◆ operator*() [3/3]

Point livemap.data.Point.operator* ( Point left,
Point right )
static

◆ operator+() [1/3]

Point livemap.data.Point.operator+ ( double left,
Point right )
static

◆ operator+() [2/3]

Point livemap.data.Point.operator+ ( Point left,
double right )
static

◆ operator+() [3/3]

Point livemap.data.Point.operator+ ( Point left,
Point right )
static

◆ operator-() [1/3]

Point livemap.data.Point.operator- ( double left,
Point right )
static

◆ operator-() [2/3]

Point livemap.data.Point.operator- ( Point left,
double right )
static

◆ operator-() [3/3]

Point livemap.data.Point.operator- ( Point left,
Point right )
static

◆ operator/() [1/3]

Point livemap.data.Point.operator/ ( double left,
Point right )
static

◆ operator/() [2/3]

Point livemap.data.Point.operator/ ( Point left,
double right )
static

◆ operator/() [3/3]

Point livemap.data.Point.operator/ ( Point left,
Point right )
static

◆ operator==()

bool livemap.data.Point.operator== ( Point? left,
Point? right )
static

◆ Round()

Point livemap.data.Point.Round ( )

Round the point values to the nearest integer.

Returns
A new point with the values rounded to the nearest integer

◆ Subtract() [1/2]

Point livemap.data.Point.Subtract ( double num)

Subtracts the specified amount to the point's axis values.

Parameters
numThe value to subtract to the point's axis values
Returns
A new point with the subtracted axis values

◆ Subtract() [2/2]

Point livemap.data.Point.Subtract ( Point point)

Subtracts the specified point's axis values to this point's axis values.

Parameters
pointThe point to subtract to this point's axis values
Returns
A new point with the subtracted axis values

◆ ToString()

override string livemap.data.Point.ToString ( )

Property Documentation

◆ this[int index]

double livemap.data.Point.this[int index]
get

Get the axis value of the specified index.

Parameters
indexIndex of axis

Index 0 represents axis X
Index 1 represents axis Z

Exceptions
ArgumentOutOfRangeException

◆ X

double livemap.data.Point.X
get

The value of the X axis of this point.

◆ Z

double livemap.data.Point.Z
get

The value of the Z axis of this point.

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