Geometry

Geometry

SplashKit’s geometry functions assist with geometry-related computations.

Functions

Center Point

Returns the center point of the circle.

Parameters:

Name	Type	Description
c	Circle	The circle to get the center point

Return Type: Point 2d

Signatures:

C++

point_2d center_point(const circle &c)

C#

public static Point2D SplashKit.CenterPoint(Circle c);

Python

def center_point(c):

Pascal

function CenterPoint(const c: Circle): Point2D

---

Circle At

Note

This function is overloaded. The following versions exist:

• Circle At (pt: point_2d, radius: double)
• Circle At (x: double, y: double, radius: double)

Circle At

Returns a circle at the indicated point and radius.

Parameters:

Name	Type	Description
pt	Point 2d	The location of the center of the circle
radius	Double	The radius of the circle

Return Type: Circle

Signatures:

C++

circle circle_at(const point_2d &pt, double radius)

C#

public static Circle SplashKit.CircleAt(Point2D pt, double radius);

Python

def circle_at(pt, radius):

Pascal

function CircleAt(const pt: Point2D; radius: Double): Circle

---

Circle At

Returns a circle at the indicated point and radius.

Parameters:

Name	Type	Description
x	Double	The x location of the circle
y	Double	The y location of the circle
radius	Double	The radius of the circle

Return Type: Circle

Signatures:

C++

circle circle_at(double x, double y, double radius)

C#

public static Circle SplashKit.CircleAt(double x, double y, double radius);

Python

def circle_at_from_points(x, y, radius):

Pascal

function CircleAt(x: Double; y: Double; radius: Double): Circle

---

Circle Radius

Returns the circle radius.

Parameters:

Name	Type	Description
c	Circle	The circle

Return Type: Float

Signatures:

C++

float circle_radius(const circle c)

C#

public static float SplashKit.CircleRadius(Circle c);

Python

def circle_radius(c):

Pascal

function CircleRadius(c: Circle): Single

---

Circle Triangle Intersect

Note

This function is overloaded. The following versions exist:

• Circle Triangle Intersect (c: circle, tri: triangle)
• Circle Triangle Intersect (c: circle, tri: triangle, p: point_2d)

Circle Triangle Intersect

Detects if a circle intersects with a triangle.

Parameters:

Name	Type	Description
c	Circle	The circle to test
tri	Triangle	The triangle to test

Return Type: Boolean

Signatures:

C++

bool circle_triangle_intersect(const circle &c, const triangle &tri)

C#

public static bool SplashKit.CircleTriangleIntersect(Circle c, Triangle tri);

Python

def circle_triangle_intersect(c, tri):

Pascal

function CircleTriangleIntersect(const c: Circle; const tri: Triangle): Boolean

---

Circle Triangle Intersect

Detects if a circle intersects with a triangle. The closest point on the triangle to the circle is assigned to p, even if the circle and triangle do not intersect. If the centre of the circle is inside the triangle, the point assigned to p is the centre of the circle.

Parameters:

Name	Type	Description
c	Circle	The circle to test
tri	Triangle	The triangle to test
p	Point 2d	The point to set to the closest point on the triangle to the circle

Return Type: Boolean

Signatures:

C++

bool circle_triangle_intersect(const circle &c, const triangle &tri, point_2d &p)

C#

public static bool SplashKit.CircleTriangleIntersect(Circle c, Triangle tri, ref Point2D p);

Python

def circle_triangle_intersect_get_closest_point(c, tri, p):

Pascal

function CircleTriangleIntersect(const c: Circle; const tri: Triangle; var p: Point2D): Boolean

---

Circle X

Returns the circle x value.

Parameters:

Name	Type	Description
c	Circle	The circle

Return Type: Float

Signatures:

C++

float circle_x(const circle &c)

C#

public static float SplashKit.CircleX(Circle c);

Python

def circle_x(c):

Pascal

function CircleX(const c: Circle): Single

---

Circle Y

Returns the circle y value.

Parameters:

Name	Type	Description
c	Circle	The circle

Return Type: Float

Signatures:

C++

float circle_y(const circle &c)

C#

public static float SplashKit.CircleY(Circle c);

Python

def circle_y(c):

Pascal

function CircleY(const c: Circle): Single

---

Circles Intersect

Note

This function is overloaded. The following versions exist:

• Circles Intersect (c1: circle, c2: circle)
• Circles Intersect (c1_x: double, c1_y: double, c1_radius: double, c2_x: double, c2_y: double, c2_radius: double)

Circles Intersect

Detects if two circles intersect. This can be used to detect collisions between bounding circles.

Parameters:

Name	Type	Description
c1	Circle	The circle to test if intersects with c2
c2	Circle	The circle to test if intersects with c1

Return Type: Boolean

Signatures:

C++

bool circles_intersect(circle c1, circle c2)

C#

public static bool SplashKit.CirclesIntersect(Circle c1, Circle c2);

Python

def circles_intersect(c1, c2):

Pascal

function CirclesIntersect(c1: Circle; c2: Circle): Boolean

---

Circles Intersect

Detects if two circles intersect. This can be used to detect collisions between bounding circles. The circle data is passed in as individual values.

Parameters:

Name	Type	Description
c1_x	Double	the x location of the first circle
c1_y	Double	the y location of the first circle
c1_radius	Double	the radius of the first circle
c2_x	Double	the x location of the second circle
c2_y	Double	the y location of the second circle
c2_radius	Double	the radius of the second circle

Return Type: Boolean

Signatures:

C++

bool circles_intersect(double c1_x, double c1_y, double c1_radius, double c2_x, double c2_y, double c2_radius)

C#

public static bool SplashKit.CirclesIntersect(double c1X, double c1Y, double c1Radius, double c2X, double c2Y, double c2Radius);

Python

def circles_intersect_using_values(c1_x, c1_y, c1_radius, c2_x, c2_y, c2_radius):

Pascal

function CirclesIntersect(c1X: Double; c1Y: Double; c1Radius: Double; c2X: Double; c2Y: Double; c2Radius: Double): Boolean

---

Closest Point On Circle

The closest point on the circle to the given point.

Parameters:

Name	Type	Description
from_pt	Point 2d	The point to test from
c	Circle	The circle you want to get a point on its circumference

Return Type: Point 2d

Signatures:

C++

point_2d closest_point_on_circle(const point_2d &from_pt, const circle &c)

C#

public static Point2D SplashKit.ClosestPointOnCircle(Point2D fromPt, Circle c);

Python

def closest_point_on_circle(from_pt, c):

Pascal

function ClosestPointOnCircle(const fromPt: Point2D; const c: Circle): Point2D

---

Closest Point On Line From Circle

Returns the closest point on a line to a circle.

Parameters:

Name	Type	Description
c	Circle	The circle
l	Line	The line

Return Type: Point 2d

Signatures:

C++

point_2d closest_point_on_line_from_circle(const circle &c, const line &l)

C#

public static Point2D SplashKit.ClosestPointOnLineFromCircle(Circle c, Line l);

Python

def closest_point_on_line_from_circle(c, l):

Pascal

function ClosestPointOnLineFromCircle(const c: Circle; const l: Line): Point2D

---

Closest Point On Rect From Circle

Returns the closest point on a rectangle to a circle.

Parameters:

Name	Type	Description
c	Circle	The circle
rect	Rectangle	The rectangle

Return Type: Point 2d

Signatures:

C++

point_2d closest_point_on_rect_from_circle(const circle &c, const rectangle &rect)

C#

public static Point2D SplashKit.ClosestPointOnRectFromCircle(Circle c, Rectangle rect);

Python

def closest_point_on_rect_from_circle(c, rect):

Pascal

function ClosestPointOnRectFromCircle(const c: Circle; const rect: Rectangle): Point2D

---

Closest Point On Triangle From Circle

Calculates the closest point on a triangle to a circle. If the circle and triangle do not intersect, the closest point on the triangle to the circle is returned. If the circle and triangle do intersect, the center of the circle is returned.

Parameters:

Name	Type	Description
c	Circle	The circle to test
tri	Triangle	The triangle to test

Return Type: Point 2d

Signatures:

C++

point_2d closest_point_on_triangle_from_circle(const circle &c, const triangle &tri)

C#

public static Point2D SplashKit.ClosestPointOnTriangleFromCircle(Circle c, Triangle tri);

Python

def closest_point_on_triangle_from_circle(c, tri):

Pascal

function ClosestPointOnTriangleFromCircle(const c: Circle; const tri: Triangle): Point2D

---

Distant Point On Circle

The furthest point on the circle to the given point.

Parameters:

Name	Type	Description
pt	Point 2d	The point to test from
c	Circle	The circle you want to get a point on its circumference

Return Type: Point 2d

Signatures:

C++

point_2d distant_point_on_circle(const point_2d &pt, const circle &c)

C#

public static Point2D SplashKit.DistantPointOnCircle(Point2D pt, Circle c);

Python

def distant_point_on_circle(pt, c):

Pascal

function DistantPointOnCircle(const pt: Point2D; const c: Circle): Point2D

---

Distant Point On Circle Heading

Determines the opposite side of a circle given a collision point and a heading.

Parameters:

Name	Type	Description
pt	Point 2d	The point from which the test is being made
c	Circle	The circle
heading	Vector 2d	The direction the point is heading
opposite_pt	Point 2d	After the call, this is set to the point on the opposite side of the circle from pt when it is heading in the given direction.

Return Type: Boolean

Signatures:

C++

bool distant_point_on_circle_heading(const point_2d &pt, const circle &c, const vector_2d &heading, point_2d &opposite_pt)

C#

public static bool SplashKit.DistantPointOnCircleHeading(Point2D pt, Circle c, Vector2D heading, ref Point2D oppositePt);

Python

def distant_point_on_circle_heading(pt, c, heading, opposite_pt):

Pascal

function DistantPointOnCircleHeading(const pt: Point2D; const c: Circle; const heading: Vector2D; var oppositePt: Point2D): Boolean

---

Ray Circle Intersect Distance

Calculates the distance from a ray cast from a point to a given circle.

Parameters:

Name	Type	Description
ray_origin	Point 2d	The origin of the ray
ray_heading	Vector 2d	The direction of the ray
c	Circle	The circle being tested

Return Type: Float

Signatures:

C++

float ray_circle_intersect_distance(const point_2d &ray_origin, const vector_2d &ray_heading, const circle &c)

C#

public static float SplashKit.RayCircleIntersectDistance(Point2D rayOrigin, Vector2D rayHeading, Circle c);

Python

def ray_circle_intersect_distance(ray_origin, ray_heading, c):

Pascal

function RayCircleIntersectDistance(const rayOrigin: Point2D; const rayHeading: Vector2D; const c: Circle): Single

---

Tangent Points

Returns the two tangent points on the circle given the indicated point.

Parameters:

Name	Type	Description
from_pt	Point 2d	The source point
c	Circle	The circle
p1	Point 2d	If this returns true, then p1 contains one of the points
p2	Point 2d	If this returns true, then p2 contains one of the points

Return Type: Boolean

Signatures:

C++

bool tangent_points(const point_2d &from_pt, const circle &c, point_2d &p1, point_2d &p2)

C#

public static bool SplashKit.TangentPoints(Point2D fromPt, Circle c, ref Point2D p1, ref Point2D p2);

Python

def tangent_points(from_pt, c, p1, p2):

Pascal

function TangentPoints(const fromPt: Point2D; const c: Circle; var p1: Point2D; var p2: Point2D): Boolean

---

Widest Points

Calculates the two points on a circles radius that lie along the given vector. This represents the points on the circle when the vector is placed at the circle’s center point.

Parameters:

Name	Type	Description
c	Circle	The circle
along	Vector 2d	The vector representing the line along which the points lie.
pt1	Point 2d	After the call, this is set to one of the widest points
pt2	Point 2d	After the call, this is set to one of the widest points

Signatures:

C++

void widest_points(const circle &c, const vector_2d &along, point_2d &pt1, point_2d &pt2)

C#

public static void SplashKit.WidestPoints(Circle c, Vector2D along, ref Point2D pt1, ref Point2D pt2);

Python

def widest_points(c, along, pt1, pt2):

Pascal

procedure WidestPoints(const c: Circle; const along: Vector2D; var pt1: Point2D; var pt2: Point2D)

---

Cosine

Returns the cosine of the supplied angle (in degrees).

Parameters:

Name	Type	Description
degrees	Float	The angle in degrees

Return Type: Float

Signatures:

C++

float cosine(float degrees)

C#

public static float SplashKit.Cosine(float degrees);

Python

def cosine(degrees):

Pascal

function Cosine(degrees: Single): Single

---

Sine

Returns the sine of the supplied angle (in degrees).

Parameters:

Name	Type	Description
degrees	Float	The angle in degrees

Return Type: Float

Signatures:

C++

float sine(float degrees)

C#

public static float SplashKit.Sine(float degrees);

Python

def sine(degrees):

Pascal

function Sine(degrees: Single): Single

---

Tangent

Returns the tangent of the supplied angle (in degrees).

Parameters:

Name	Type	Description
degrees	Float	The angle in degrees

Return Type: Float

Signatures:

C++

float tangent(float degrees)

C#

public static float SplashKit.Tangent(float degrees);

Python

def tangent(degrees):

Pascal

function Tangent(degrees: Single): Single

---

Closest Point On Line

Gets the closest point on the line to a given point.

Parameters:

Name	Type	Description
from_pt	Point 2d	The point to test (usually somewhere near the line)
l	Line	The line

Return Type: Point 2d

Signatures:

C++

point_2d closest_point_on_line(const point_2d from_pt, const line &l)

C#

public static Point2D SplashKit.ClosestPointOnLine(Point2D fromPt, Line l);

Python

def closest_point_on_line(from_pt, l):

Pascal

function ClosestPointOnLine(fromPt: Point2D; const l: Line): Point2D

---

Closest Point On Lines

Get the point closest to from pt that is on one of the supplied lines.

Parameters:

Name	Type	Description
from_pt	Point 2d	The point to test
lines	Vector	The lines to check
line_idx	Integer	After the call this will store the index of the line that had the matching point.

Return Type: Point 2d

Signatures:

C++

point_2d closest_point_on_lines(const point_2d from_pt, const vector<line> &lines, int &line_idx)

C#

public static Point2D SplashKit.ClosestPointOnLines(Point2D fromPt, List<Line> lines, ref int lineIdx);

Python

def closest_point_on_lines(from_pt, lines, line_idx):

Pascal

function ClosestPointOnLines(fromPt: Point2D; const lines: ArrayOfLine; var lineIdx: Integer): Point2D

---

Line From

Note

This function is overloaded. The following versions exist:

• Line From (start: point_2d, end_pt: point_2d)
• Line From (start: point_2d, offset: vector_2d)
• Line From (v: vector_2d)
• Line From (x1: double, y1: double, x2: double, y2: double)

Line From

Create a line from one point to another.

Parameters:

Name	Type	Description
start	Point 2d	The start of the line
end_pt	Point 2d	The end of the line

Return Type: Line

Signatures:

C++

line line_from(const point_2d &start, const point_2d &end_pt)

C#

public static Line SplashKit.LineFrom(Point2D start, Point2D endPt);

Python

def line_from_point_to_point(start, end_pt):

Pascal

function LineFrom(const start: Point2D; const endPt: Point2D): Line

---

Line From

Creates a line that starts at a point, and follows a given vector.

Parameters:

Name	Type	Description
start	Point 2d	The start of the line
offset	Vector 2d	The offset to the end of the line

Return Type: Line

Signatures:

C++

line line_from(const point_2d &start, const vector_2d &offset)

C#

public static Line SplashKit.LineFrom(Point2D start, Vector2D offset);

Python

def line_from_start_with_offset(start, offset):

Pascal

function LineFrom(const start: Point2D; const offset: Vector2D): Line

---

Line From

Gets a line that goes from the origin and ends at the end of the vector.

Parameters:

Name	Type	Description
v	Vector 2d	The offset from the origin for the end of the line

Return Type: Line

Signatures:

C++

line line_from(const vector_2d &v)

C#

public static Line SplashKit.LineFrom(Vector2D v);

Python

def line_from_vector(v):

Pascal

function LineFrom(const v: Vector2D): Line

---

Line From

Create a line from one point to another.

Parameters:

Name	Type	Description
x1	Double	The x value of the start of the line
y1	Double	The y value of the start of the line
x2	Double	The x value of the end of the line
y2	Double	The y value of the end of the line

Return Type: Line

Signatures:

C++

line line_from(double x1, double y1, double x2, double y2)

C#

public static Line SplashKit.LineFrom(double x1, double y1, double x2, double y2);

Python

def line_from(x1, y1, x2, y2):

Pascal

function LineFrom(x1: Double; y1: Double; x2: Double; y2: Double): Line

---

Line Intersection Point

Returns the point at which two lines would intersect. This point may lie past the end of one or both lines.

Parameters:

Name	Type	Description
line1	Line	The first line
line2	Line	The other line
pt	Point 2d	The resulting point where they intersect

Return Type: Boolean

Signatures:

C++

bool line_intersection_point(const line &line1, const line &line2, point_2d &pt)

C#

public static bool SplashKit.LineIntersectionPoint(Line line1, Line line2, ref Point2D pt);

Python

def line_intersection_point(line1, line2, pt):

Pascal

function LineIntersectionPoint(const line1: Line; const line2: Line; var pt: Point2D): Boolean

---

Line Intersects Circle

Returns true if the line intersects the circle.

Parameters:

Name	Type	Description
l	Line	The line
c	Circle	The circle

Return Type: Boolean

Signatures:

C++

bool line_intersects_circle(const line &l, const circle &c)

C#

public static bool SplashKit.LineIntersectsCircle(Line l, Circle c);

Python

def line_intersects_circle(l, c):

Pascal

function LineIntersectsCircle(const l: Line; const c: Circle): Boolean

---

Line Intersects Lines

Returns true if the line intersects any of the lines.

Parameters:

Name	Type	Description
l	Line	The line to check
lines	Vector	The lines to check against

Return Type: Boolean

Signatures:

C++

bool line_intersects_lines(const line &l, const vector<line> &lines)

C#

public static bool SplashKit.LineIntersectsLines(Line l, List<Line> lines);

Python

def line_intersects_lines(l, lines):

Pascal

function LineIntersectsLines(const l: Line; const lines: ArrayOfLine): Boolean

---

Line Intersects Rect

Returns true if the line intersects the rectangle.

Parameters:

Name	Type	Description
l	Line	The line
rect	Rectangle	The rectangle

Return Type: Boolean

Signatures:

C++

bool line_intersects_rect(const line &l, const rectangle &rect)

C#

public static bool SplashKit.LineIntersectsRect(Line l, Rectangle rect);

Python

def line_intersects_rect(l, rect):

Pascal

function LineIntersectsRect(const l: Line; const rect: Rectangle): Boolean

---

Line Length

Returns the length of a line.

Parameters:

Name	Type	Description
l	Line	The line

Return Type: Float

Signatures:

C++

float line_length(const line &l)

C#

public static float SplashKit.LineLength(Line l);

Python

def line_length(l):

Pascal

function LineLength(const l: Line): Single

---

Line Length Squared

Returns the squared length of the line. You can also get the Line Length.

Parameters:

Name	Type	Description
l	Line	The line

Return Type: Float

Signatures:

C++

float line_length_squared(const line &l)

C#

public static float SplashKit.LineLengthSquared(Line l);

Python

def line_length_squared(l):

Pascal

function LineLengthSquared(const l: Line): Single

---

Line Mid Point

Returns the center point of the line.

Parameters:

Name	Type	Description
l	Line	The line

Return Type: Point 2d

Signatures:

C++

point_2d line_mid_point(const line &l)

C#

public static Point2D SplashKit.LineMidPoint(Line l);

Python

def line_mid_point(l):

Pascal

function LineMidPoint(const l: Line): Point2D

---

Line Normal

The line normal (a perpendicular vector).

Parameters:

Name	Type	Description
l	Line	The line

Return Type: Vector 2d

Signatures:

C++

vector_2d line_normal(const line &l)

C#

public static Vector2D SplashKit.LineNormal(Line l);

Python

def line_normal(l):

Pascal

function LineNormal(const l: Line): Vector2D

---

Line To String

Returns a text description of the line.

Parameters:

Name	Type	Description
ln	Line	The line

Return Type: String

Signatures:

C++

string line_to_string(const line &ln)

C#

public static string SplashKit.LineToString(Line ln);

Python

def line_to_string(ln):

Pascal

function LineToString(const ln: Line): String

---

Lines From

Note

This function is overloaded. The following versions exist:

• Lines From (rect: rectangle)
• Lines From (t: triangle)

Lines From

Returns an array of lines from a supplied rectangle.

Parameters:

Name	Type	Description
rect	Rectangle	The rectangle to get the lines from

Return Type: Vector

Signatures:

C++

vector<line> lines_from(const rectangle &rect)

C#

public static List<Line> SplashKit.LinesFrom(Rectangle rect);

Python

def lines_from_rectangle(rect):

Pascal

function LinesFrom(const rect: Rectangle): ArrayOfLine

---

Lines From

Returns an array of lines from the details in the triangle.

Parameters:

Name	Type	Description
t	Triangle	The triangle

Return Type: Vector

Signatures:

C++

vector<line> lines_from(const triangle &t)

C#

public static List<Line> SplashKit.LinesFrom(Triangle t);

Python

def lines_from_triangle(t):

Pascal

function LinesFrom(const t: Triangle): ArrayOfLine

---

Lines Intersect

Returns true if the two lines intersect.

Parameters:

Name	Type	Description
l1	Line	The first line
l2	Line	The other line

Return Type: Boolean

Signatures:

C++

bool lines_intersect(const line &l1, const line &l2)

C#

public static bool SplashKit.LinesIntersect(Line l1, Line l2);

Python

def lines_intersect(l1, l2):

Pascal

function LinesIntersect(const l1: Line; const l2: Line): Boolean

---

Point At

Returns a point at the given location.

Parameters:

Name	Type	Description
x	Double	The x value of the coordinate
y	Double	The y value of the coordinate

Return Type: Point 2d

Signatures:

C++

point_2d point_at(double x, double y)

C#

public static Point2D SplashKit.PointAt(double x, double y);

Python

def point_at(x, y):

Pascal

function PointAt(x: Double; y: Double): Point2D

---

Point At Origin

Returns a point representing the origin.

Return Type: Point 2d

Signatures:

C++

point_2d point_at_origin()

C#

public static Point2D SplashKit.PointAtOrigin();

Python

def point_at_origin():

Pascal

function PointAtOrigin(): Point2D

---

Point In Circle

Note

This function is overloaded. The following versions exist:

• Point In Circle (pt: point_2d, c: circle)
• Point In Circle (ptx: double, pty: double, cx: double, cy: double, radius: double)

Point In Circle

Returns true if the point pt is in the circle c.

Parameters:

Name	Type	Description
pt	Point 2d	The point to test
c	Circle	The circle to check

Return Type: Boolean

Signatures:

C++

bool point_in_circle(const point_2d &pt, const circle &c)

C#

public static bool SplashKit.PointInCircle(Point2D pt, Circle c);

Python

def point_in_circle(pt, c):

Pascal

function PointInCircle(const pt: Point2D; const c: Circle): Boolean

---

Point In Circle

Return true if the point is in the circle.

Parameters:

Name	Type	Description
ptx	Double	the x value of the point
pty	Double	the y value of the point
cx	Double	the x value of the centre of the circle
cy	Double	the y value of the centre of the circle
radius	Double	the radius of the circle

Return Type: Boolean

Signatures:

C++

bool point_in_circle(double ptx, double pty, double cx, double cy, double radius)

C#

public static bool SplashKit.PointInCircle(double ptx, double pty, double cx, double cy, double radius);

Python

def point_in_circle_with_values(ptx, pty, cx, cy, radius):

Pascal

function PointInCircle(ptx: Double; pty: Double; cx: Double; cy: Double; radius: Double): Boolean

---

Point In Quad

Tests if a point is in a quad.

Parameters:

Name	Type	Description
pt	Point 2d	The point to test.
q	Quad	The quad to check if the point is within.

Return Type: Boolean

Signatures:

C++

bool point_in_quad(const point_2d &pt, const quad &q)

C#

public static bool SplashKit.PointInQuad(Point2D pt, Quad q);

Python

def point_in_quad(pt, q):

Pascal

function PointInQuad(const pt: Point2D; const q: Quad): Boolean

---

Point In Rectangle

Note

This function is overloaded. The following versions exist:

• Point In Rectangle (pt: point_2d, rect: rectangle)
• Point In Rectangle (ptx: double, pty: double, rect_x: double, rect_y: double, rect_width: double, rect_height: double)

Point In Rectangle

Returns true if point pt is in the Rectangle rect.

Parameters:

Name	Type	Description
pt	Point 2d	The point to test
rect	Rectangle	The rectangle to check

Return Type: Boolean

Signatures:

C++

bool point_in_rectangle(const point_2d &pt, const rectangle &rect)

C#

public static bool SplashKit.PointInRectangle(Point2D pt, Rectangle rect);

Python

def point_in_rectangle(pt, rect):

Pascal

function PointInRectangle(const pt: Point2D; const rect: Rectangle): Boolean

---

Point In Rectangle

Returns true if the point is within the bounds of a Rectangle.

Parameters:

Name	Type	Description
ptx	Double	the x value of the point
pty	Double	the y value of the point
rect_x	Double	x value of the rectangle
rect_y	Double	y value of the rectangle
rect_width	Double	width of the rectangle
rect_height	Double	height of the rectangle

Return Type: Boolean

Signatures:

C++

bool point_in_rectangle(double ptx, double pty, double rect_x, double rect_y, double rect_width, double rect_height)

C#

public static bool SplashKit.PointInRectangle(double ptx, double pty, double rectX, double rectY, double rectWidth, double rectHeight);

Python

def point_in_rectangle_with_values(ptx, pty, rect_x, rect_y, rect_width, rect_height):

Pascal

function PointInRectangle(ptx: Double; pty: Double; rectX: Double; rectY: Double; rectWidth: Double; rectHeight: Double): Boolean

---

Point In Triangle

Returns true if the point pt is in the Triangle tri.

Parameters:

Name	Type	Description
pt	Point 2d	The point to test
tri	Triangle	The triangle to check

Return Type: Boolean

Signatures:

C++

bool point_in_triangle(const point_2d &pt, const triangle &tri)

C#

public static bool SplashKit.PointInTriangle(Point2D pt, Triangle tri);

Python

def point_in_triangle(pt, tri):

Pascal

function PointInTriangle(const pt: Point2D; const tri: Triangle): Boolean

---

Point Line Distance

Returns the distance from a point to a line.

Parameters:

Name	Type	Description
pt	Point 2d	The point
l	Line	The line

Return Type: Float

Signatures:

C++

float point_line_distance(const point_2d &pt, const line &l)

C#

public static float SplashKit.PointLineDistance(Point2D pt, Line l);

Python

def point_line_distance(pt, l):

Pascal

function PointLineDistance(const pt: Point2D; const l: Line): Single

---

Point Offset By

Calculate the Point 2d that is offset from the start_point by the offset

Parameters:

Name	Type	Description
start_point	Point 2d	The starting point
offset	Vector 2d	The distance and direction to move

Return Type: Point 2d

Signatures:

C++

point_2d point_offset_by(const point_2d &start_point, const vector_2d &offset)

C#

public static Point2D SplashKit.PointOffsetBy(Point2D startPoint, Vector2D offset);

Python

def point_offset_by(start_point, offset):

Pascal

function PointOffsetBy(const startPoint: Point2D; const offset: Vector2D): Point2D

---

Point Offset From Origin

Returns the point offset from the origin by the provided vector.

Parameters:

Name	Type	Description
offset	Vector 2d	The distance and direction to move

Return Type: Point 2d

Signatures:

C++

point_2d point_offset_from_origin(const vector_2d &offset)

C#

public static Point2D SplashKit.PointOffsetFromOrigin(Vector2D offset);

Python

def point_offset_from_origin(offset):

Pascal

function PointOffsetFromOrigin(const offset: Vector2D): Point2D

---

Point On Line

Note

This function is overloaded. The following versions exist:

• Point On Line (pt: point_2d, l: line)
• Point On Line (pt: point_2d, l: line, proximity: float)

Point On Line

Returns true if point pt is on the line l.

Parameters:

Name	Type	Description
pt	Point 2d	The point to test
l	Line	The line to check

Return Type: Boolean

Signatures:

C++

bool point_on_line(const point_2d &pt, const line &l)

C#

public static bool SplashKit.PointOnLine(Point2D pt, Line l);

Python

def point_on_line(pt, l):

Pascal

function PointOnLine(const pt: Point2D; const l: Line): Boolean

---

Point On Line

Returns true when the point pt is on the line l. The proximity value is used to set the sensitivity — higher values effectively make the line thicker.

Parameters:

Name	Type	Description
pt	Point 2d	The point to test
l	Line	The line to check
proximity	Float	The sensitivity to allow close approximities

Return Type: Boolean

Signatures:

C++

bool point_on_line(const point_2d &pt, const line &l, float proximity)

C#

public static bool SplashKit.PointOnLine(Point2D pt, Line l, float proximity);

Python

def point_on_line_with_proximity(pt, l, proximity):

Pascal

function PointOnLine(const pt: Point2D; const l: Line; proximity: Single): Boolean

---

Point Point Angle

Returns the angle between two points in degrees.

Parameters:

Name	Type	Description
pt1	Point 2d	The first point
pt2	Point 2d	The other point

Return Type: Float

Signatures:

C++

float point_point_angle(const point_2d &pt1, const point_2d &pt2)

C#

public static float SplashKit.PointPointAngle(Point2D pt1, Point2D pt2);

Python

def point_point_angle(pt1, pt2):

Pascal

function PointPointAngle(const pt1: Point2D; const pt2: Point2D): Single

---

Point Point Distance

Returns the distance between two points.

Parameters:

Name	Type	Description
pt1	Point 2d	The first point
pt2	Point 2d	The other point

Return Type: Float

Signatures:

C++

float point_point_distance(const point_2d &pt1, const point_2d &pt2)

C#

public static float SplashKit.PointPointDistance(Point2D pt1, Point2D pt2);

Python

def point_point_distance(pt1, pt2):

Pascal

function PointPointDistance(const pt1: Point2D; const pt2: Point2D): Single

---

Point To String

Get a text description of the Point 2d.

Parameters:

Name	Type	Description
pt	Point 2d	The point details

Return Type: String

Signatures:

C++

string point_to_string(const point_2d &pt)

C#

public static string SplashKit.PointToString(Point2D pt);

Python

def point_to_string(pt):

Pascal

function PointToString(const pt: Point2D): String

---

Random Bitmap Point

Returns a random point within the bounds of the bitmap.

Parameters:

Name	Type	Description
bmp	Bitmap	The bitmap

Return Type: Point 2d

Signatures:

C++

point_2d random_bitmap_point(bitmap bmp)

C#

public static Point2D SplashKit.RandomBitmapPoint(Bitmap bmp);

Python

def random_bitmap_point(bmp):

Pascal

function RandomBitmapPoint(bmp: Bitmap): Point2D

---

Random Screen Point

Returns a random point on the current window.

Return Type: Point 2d

Signatures:

C++

point_2d random_screen_point()

C#

public static Point2D SplashKit.RandomScreenPoint();

Python

def random_screen_point():

Pascal

function RandomScreenPoint(): Point2D

---

Random Window Point

Returns a random point on the provided window.

Parameters:

Name	Type	Description
wind	Window	The window

Return Type: Point 2d

Signatures:

C++

point_2d random_window_point(window wind)

C#

public static Point2D SplashKit.RandomWindowPoint(Window wind);

Python

def random_window_point(wind):

Pascal

function RandomWindowPoint(wind: Window): Point2D

---

Same Point

Returns True of pt1 is at the same point as pt2. This checks at an integer level, indicating the two points refer to the same pixel.

Parameters:

Name	Type	Description
pt1	Point 2d	The first point
pt2	Point 2d	The other point

Return Type: Boolean

Signatures:

C++

bool same_point(const point_2d &pt1, const point_2d &pt2)

C#

public static bool SplashKit.SamePoint(Point2D pt1, Point2D pt2);

Python

def same_point(pt1, pt2):

Pascal

function SamePoint(const pt1: Point2D; const pt2: Point2D): Boolean

---

Quad From

Note

This function is overloaded. The following versions exist:

• Quad From (p1: point_2d, p2: point_2d, p3: point_2d, p4: point_2d)
• Quad From (rect: rectangle)
• Quad From (rect: rectangle, transform: matrix_2d)
• Quad From (x_top_left: double, y_top_left: double, x_top_right: double, y_top_right: double, x_bottom_left: double, y_bottom_left: double, x_bottom_right: double, y_bottom_right: double)

Quad From

Returns a quad from the passed in points.

Parameters:

Name	Type	Description
p1	Point 2d	The top left of the quad.
p2	Point 2d	The top right of the quad
p3	Point 2d	The bottom left of the quad
p4	Point 2d	The bottom right of the quad

Return Type: Quad

Signatures:

C++

quad quad_from(const point_2d &p1, const point_2d &p2, const point_2d &p3, const point_2d &p4)

C#

public static Quad SplashKit.QuadFrom(Point2D p1, Point2D p2, Point2D p3, Point2D p4);

Python

def quad_from_points(p1, p2, p3, p4):

Pascal

function QuadFrom(const p1: Point2D; const p2: Point2D; const p3: Point2D; const p4: Point2D): Quad

---

Quad From

Returns a quad from the x-y points of a given recatangle

Parameters:

Name	Type	Description
rect	Rectangle	The rectangle to convert to a quad

Return Type: Quad

Signatures:

C++

quad quad_from(const rectangle &rect)

C#

public static Quad SplashKit.QuadFrom(Rectangle rect);

Python

def quad_from_rectangle(rect):

Pascal

function QuadFrom(const rect: Rectangle): Quad

---

Quad From

Returns a quad from the rectangle, then applies the transformation to the quads points.

Parameters:

Name	Type	Description
rect	Rectangle	The rectangle to transform to a quad.
transform	Matrix 2d	A transform to apply to the resulting quad.

Return Type: Quad

Signatures:

C++

quad quad_from(const rectangle &rect, const matrix_2d &transform)

C#

public static Quad SplashKit.QuadFrom(Rectangle rect, Matrix2D transform);

Python

def quad_from_rectangle_with_transformation(rect, transform):

Pascal

function QuadFrom(const rect: Rectangle; const transform: Matrix2D): Quad

---

Quad From

Returns a quad for the passed in x & y points.

Parameters:

Name	Type	Description
x_top_left	Double	X coordinate of the top left of the quad
y_top_left	Double	Y coordinate of the top left of the quad
x_top_right	Double	X coordinate of the top right of the quad
y_top_right	Double	Y coordinate of the top right of the quad
x_bottom_left	Double	X coordinate of the bottom left of the quad
y_bottom_left	Double	Y coordinate of the bottom left of the quad
x_bottom_right	Double	X coordinate of the bottom right of the quad
y_bottom_right	Double	Y coordinate of the bottom right of the quad

Return Type: Quad

Signatures:

C++

quad quad_from(double x_top_left, double y_top_left, double x_top_right, double y_top_right, double x_bottom_left, double y_bottom_left, double x_bottom_right, double y_bottom_right)

C#

public static Quad SplashKit.QuadFrom(double xTopLeft, double yTopLeft, double xTopRight, double yTopRight, double xBottomLeft, double yBottomLeft, double xBottomRight, double yBottomRight);

Python

def quad_from(x_top_left, y_top_left, x_top_right, y_top_right, x_bottom_left, y_bottom_left, x_bottom_right, y_bottom_right):

Pascal

function QuadFrom(xTopLeft: Double; yTopLeft: Double; xTopRight: Double; yTopRight: Double; xBottomLeft: Double; yBottomLeft: Double; xBottomRight: Double; yBottomRight: Double): Quad

---

Quads Intersect

Returns true if two quads intersect.

Parameters:

Name	Type	Description
q1	Quad	The first quad
q2	Quad	The second quad

Return Type: Boolean

Signatures:

C++

bool quads_intersect(const quad &q1, const quad &q2)

C#

public static bool SplashKit.QuadsIntersect(Quad q1, Quad q2);

Python

def quads_intersect(q1, q2):

Pascal

function QuadsIntersect(const q1: Quad; const q2: Quad): Boolean

---

Set Quad Point

Change a point in a quad.

Parameters:

Name	Type	Description
q	Quad	The quad to change
idx	Integer	The index of the point: 0 is top left, 1 is top right, 2 is bottom left, and 3 is bottom right
value	Point 2d	The new value for that point in the quad

Signatures:

C++

void set_quad_point(quad &q, int idx, const point_2d &value)

C#

public static void SplashKit.SetQuadPoint(ref Quad q, int idx, Point2D value);

Python

def set_quad_point(q, idx, value):

Pascal

procedure SetQuadPoint(var q: Quad; idx: Integer; const value: Point2D)

---

Triangles From

Returns the two triangles that make up a quad in a vector.

Parameters:

Name	Type	Description
q	Quad	The quad

Return Type: Vector

Signatures:

C++

vector<triangle> triangles_from(const quad &q)

C#

public static List<Triangle> SplashKit.TrianglesFrom(Quad q);

Python

def triangles_from(q):

Pascal

function TrianglesFrom(const q: Quad): ArrayOfTriangle

---

Inset Rectangle

Return a rectangle that is inset an amount from a given rectangle.

Parameters:

Name	Type	Description
rect	Rectangle	The rectangle to inset
inset_amount	Float	The amount to inset the rectangle

Return Type: Rectangle

Signatures:

C++

rectangle inset_rectangle(const rectangle &rect, float inset_amount)

C#

public static Rectangle SplashKit.InsetRectangle(Rectangle rect, float insetAmount);

Python

def inset_rectangle(rect, inset_amount):

Pascal

function InsetRectangle(const rect: Rectangle; insetAmount: Single): Rectangle

---

Intersection

Returns a rectangle that represents the intersection of two rectangles.

Parameters:

Name	Type	Description
rect1	Rectangle	The first rectangle
rect2	Rectangle	The second rectangle

Return Type: Rectangle

Signatures:

C++

rectangle intersection(const rectangle &rect1, const rectangle &rect2)

C#

public static Rectangle SplashKit.Intersection(Rectangle rect1, Rectangle rect2);

Python

def intersection(rect1, rect2):

Pascal

function Intersection(const rect1: Rectangle; const rect2: Rectangle): Rectangle

---

Rectangle Around

Note

This function is overloaded. The following versions exist:

• Rectangle Around (c: circle)
• Rectangle Around (l: line)
• Rectangle Around (q: quad)
• Rectangle Around (t: triangle)

Rectangle Around

Returns a rectangle that surrounds a given circle

Parameters:

Name	Type	Description
c	Circle	The circle

Return Type: Rectangle

Signatures:

C++

rectangle rectangle_around(const circle &c)

C#

public static Rectangle SplashKit.RectangleAround(Circle c);

Python

def rectangle_around_circle(c):

Pascal

function RectangleAround(const c: Circle): Rectangle

---

Rectangle Around

Returns a rectangle that surrounds a given line segment

Parameters:

Name	Type	Description
l	Line	The line

Return Type: Rectangle

Signatures:

C++

rectangle rectangle_around(const line &l)

C#

public static Rectangle SplashKit.RectangleAround(Line l);

Python

def rectangle_around_line(l):

Pascal

function RectangleAround(const l: Line): Rectangle

---

Rectangle Around

Returns a rectangle that surrounds a given quad.

Parameters:

Name	Type	Description
q	Quad	The quad

Return Type: Rectangle

Signatures:

C++

rectangle rectangle_around(const quad &q)

C#

public static Rectangle SplashKit.RectangleAround(Quad q);

Python

def rectangle_around_quad(q):

Pascal

function RectangleAround(const q: Quad): Rectangle

---

Rectangle Around

Returns a rectangle that surrounds a given triangle

Parameters:

Name	Type	Description
t	Triangle	The triangle

Return Type: Rectangle

Signatures:

C++

rectangle rectangle_around(const triangle &t)

C#

public static Rectangle SplashKit.RectangleAround(Triangle t);

Python

def rectangle_around_triangle(t):

Pascal

function RectangleAround(const t: Triangle): Rectangle

---

Rectangle Bottom

The location of the bottom of the rectangle.

Parameters:

Name	Type	Description
rect	Rectangle	The rectangle.

Return Type: Float

Signatures:

C++

float rectangle_bottom(const rectangle &rect)

C#

public static float SplashKit.RectangleBottom(Rectangle rect);

Python

def rectangle_bottom(rect):

Pascal

function RectangleBottom(const rect: Rectangle): Single

---

Rectangle Center

Returns the center point of a given rectangle

Parameters:

Name	Type	Description
rect	Rectangle	The rectangle

Return Type: Point 2d

Signatures:

C++

point_2d rectangle_center(const rectangle &rect)

C#

public static Point2D SplashKit.RectangleCenter(Rectangle rect);

Python

def rectangle_center(rect):

Pascal

function RectangleCenter(const rect: Rectangle): Point2D

---

Rectangle From

Note

This function is overloaded. The following versions exist:

• Rectangle From (pt: point_2d, width: double, height: double)
• Rectangle From (pt1: point_2d, pt2: point_2d)
• Rectangle From (x: double, y: double, width: double, height: double)

Rectangle From

Returns a rectangle at the specified point with a given width and height

Parameters:

Name	Type	Description
pt	Point 2d	The origin for the rectangle
width	Double	Its width
height	Double	Its height

Return Type: Rectangle

Signatures:

C++

rectangle rectangle_from(const point_2d pt, const double width, const double height)

C#

public static Rectangle SplashKit.RectangleFrom(Point2D pt, double width, double height);

Python

def rectangle_from_point_and_size(pt, width, height):

Pascal

function RectangleFrom(pt: Point2D; width: Double; height: Double): Rectangle

---

Rectangle From

Returns a rectangle with pt1 and pt2 defining the two distant edge points.

Parameters:

Name	Type	Description
pt1	Point 2d	The first point
pt2	Point 2d	The second point

Return Type: Rectangle

Signatures:

C++

rectangle rectangle_from(const point_2d pt1, const point_2d pt2)

C#

public static Rectangle SplashKit.RectangleFrom(Point2D pt1, Point2D pt2);

Python

def rectangle_from_points(pt1, pt2):

Pascal

function RectangleFrom(pt1: Point2D; pt2: Point2D): Rectangle

---

Rectangle From

Returns a rectangle from a given x,y location with the specified width and height.

Parameters:

Name	Type	Description
x	Double	The x coordinate of the rectangle
y	Double	The y coordinate of the rectangle
width	Double	The width of the rectangle
height	Double	The height of the rectangle

Return Type: Rectangle

Usage:

See Implemenations in Guides

• Reading Text

Signatures:

C++

rectangle rectangle_from(double x, double y, double width, double height)

C#

public static Rectangle SplashKit.RectangleFrom(double x, double y, double width, double height);

Python

def rectangle_from(x, y, width, height):

Pascal

function RectangleFrom(x: Double; y: Double; width: Double; height: Double): Rectangle

---

Rectangle Left

The location of the left edge of the rectangle.

Parameters:

Name	Type	Description
rect	Rectangle	The rectangle.

Return Type: Float

Signatures:

C++

float rectangle_left(const rectangle &rect)

C#

public static float SplashKit.RectangleLeft(Rectangle rect);

Python

def rectangle_left(rect):

Pascal

function RectangleLeft(const rect: Rectangle): Single

---

Rectangle Offset By

Returns a rectangle that is moved by the provided vector.

Parameters:

Name	Type	Description
rect	Rectangle	The original rectangle
offset	Vector 2d	The amount and direction for the rectangle to move

Return Type: Rectangle

Signatures:

C++

rectangle rectangle_offset_by(const rectangle &rect, const vector_2d &offset)

C#

public static Rectangle SplashKit.RectangleOffsetBy(Rectangle rect, Vector2D offset);

Python

def rectangle_offset_by(rect, offset):

Pascal

function RectangleOffsetBy(const rect: Rectangle; const offset: Vector2D): Rectangle

---

Rectangle Right

The location of the right edge of the rectangle.

Parameters:

Name	Type	Description
rect	Rectangle	The rectangle.

Return Type: Float

Signatures:

C++

float rectangle_right(const rectangle &rect)

C#

public static float SplashKit.RectangleRight(Rectangle rect);

Python

def rectangle_right(rect):

Pascal

function RectangleRight(const rect: Rectangle): Single

---

Rectangle To String

Get a text representation of the passed in rectangle.

Parameters:

Name	Type	Description
rect	Rectangle	The rectangle

Return Type: String

Signatures:

C++

string rectangle_to_string(const rectangle &rect)

C#

public static string SplashKit.RectangleToString(Rectangle rect);

Python

def rectangle_to_string(rect):

Pascal

function RectangleToString(const rect: Rectangle): String

---

Rectangle Top

The top of the rectangle.

Parameters:

Name	Type	Description
rect	Rectangle	The rectangle.

Return Type: Float

Signatures:

C++

float rectangle_top(const rectangle &rect)

C#

public static float SplashKit.RectangleTop(Rectangle rect);

Python

def rectangle_top(rect):

Pascal

function RectangleTop(const rect: Rectangle): Single

---

Rectangles Intersect

Returns true if the two rectangles intersect.

Parameters:

Name	Type	Description
rect1	Rectangle	The first rectangle
rect2	Rectangle	The second rectangle

Return Type: Boolean

Signatures:

C++

bool rectangles_intersect(const rectangle &rect1, const rectangle &rect2)

C#

public static bool SplashKit.RectanglesIntersect(Rectangle rect1, Rectangle rect2);

Python

def rectangles_intersect(rect1, rect2):

Pascal

function RectanglesIntersect(const rect1: Rectangle; const rect2: Rectangle): Boolean

---

Triangle Barycenter

Return the barycenter of the triangle. This is one way of calculating the center point of a triangle.

Parameters:

Name	Type	Description
tri	Triangle	The triangle to get the center of

Return Type: Point 2d

Signatures:

C++

point_2d triangle_barycenter(const triangle &tri)

C#

public static Point2D SplashKit.TriangleBarycenter(Triangle tri);

Python

def triangle_barycenter(tri):

Pascal

function TriangleBarycenter(const tri: Triangle): Point2D

---

Triangle From

Note

This function is overloaded. The following versions exist:

• Triangle From (p1: point_2d, p2: point_2d, p3: point_2d)
• Triangle From (x1: double, y1: double, x2: double, y2: double, x3: double, y3: double)

Triangle From

Generate a triangle from a set of points.

Parameters:

Name	Type	Description
p1	Point 2d	The first point of the triangle
p2	Point 2d	The second point of the triangle
p3	Point 2d	The third point of the triangle

Return Type: Triangle

Signatures:

C++

triangle triangle_from(const point_2d &p1, const point_2d &p2, const point_2d &p3)

C#

public static Triangle SplashKit.TriangleFrom(Point2D p1, Point2D p2, Point2D p3);

Python

def triangle_from(p1, p2, p3):

Pascal

function TriangleFrom(const p1: Point2D; const p2: Point2D; const p3: Point2D): Triangle

---

Triangle From

Generate a triangle from a set of points.

Parameters:

Name	Type	Description
x1	Double	The x coordinate for the first point
y1	Double	The y coordinate for the first point
x2	Double	The x coordinate for the second point
y2	Double	The y coordinate for the second point
x3	Double	The x coordinate for the third point
y3	Double	The y coordinate for the third point

Return Type: Triangle

Signatures:

C++

triangle triangle_from(double x1, double y1, double x2, double y2, double x3, double y3)

C#

public static Triangle SplashKit.TriangleFrom(double x1, double y1, double x2, double y2, double x3, double y3);

Python

def triangle_from__from_coordinates(x1, y1, x2, y2, x3, y3):

Pascal

function TriangleFrom(x1: Double; y1: Double; x2: Double; y2: Double; x3: Double; y3: Double): Triangle

---

Triangle Rectangle Intersect

Returns true if the triangle intersects with the rectangle.

Parameters:

Name	Type	Description
tri	Triangle	The triangle to test
rect	Rectangle	The rectangle to test

Return Type: Boolean

Signatures:

C++

bool triangle_rectangle_intersect(const triangle &tri, const rectangle &rect)

C#

public static bool SplashKit.TriangleRectangleIntersect(Triangle tri, Rectangle rect);

Python

def triangle_rectangle_intersect(tri, rect):

Pascal

function TriangleRectangleIntersect(const tri: Triangle; const rect: Rectangle): Boolean

---

Triangle To String

Returns a text description of the triangle.

Parameters:

Name	Type	Description
tri	Triangle	The triangle

Return Type: String

Signatures:

C++

string triangle_to_string(const triangle &tri)

C#

public static string SplashKit.TriangleToString(Triangle tri);

Python

def triangle_to_string(tri):

Pascal

function TriangleToString(const tri: Triangle): String

---

Triangles Intersect

Returns true if the two triangles intersect.

Parameters:

Name	Type	Description
t1	Triangle	The first triangle
t2	Triangle	The other triangle

Return Type: Boolean

Signatures:

C++

bool triangles_intersect(const triangle &t1, const triangle &t2)

C#

public static bool SplashKit.TrianglesIntersect(Triangle t1, Triangle t2);

Python

def triangles_intersect(t1, t2):

Pascal

function TrianglesIntersect(const t1: Triangle; const t2: Triangle): Boolean

---