API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

classLine

@codexo/exojs / math / stable

Mutable line segment defined by two endpoint positions. Implements Collidable for intersection tests against all shape types. Note: `collidesWith` always returns `null` - lines support boolean intersection only; SAT response is not implemented for line segments. `contains(x, y, threshold)` tests whether `(x, y)` lies on the segment within a configurable threshold (default `0.1`). `Line.temp` is a shared scratch instance.

props

methods

events

Import

import { Line } from '@codexo/exojs'

Mutable line segment defined by two endpoint positions. Implements Collidable for intersection tests against all shape types.

Note: `collidesWith` always returns `null` - lines support boolean intersection only; SAT response is not implemented for line segments. `contains(x, y, threshold)` tests whether `(x, y)` lies on the segment within a configurable threshold (default `0.1`).

`Line.temp` is a shared scratch instance.

Constructors1

new(x1: number, y1: number, x2: number, y2: number): Line

Methods11

clone(): this

collidesWith(_target: CollidableContract for objects that participate in collision detection. Implemented by all concrete shape classes as well as `SceneNode`.): CollisionResponseResult of a successful Collidable.collidesWith call. Contains the two participating shapes, the penetration depth, containment flags, and the minimum-translati… | null

Always returns null. SAT collision response is not defined for line segments - use Line.intersectsWith for boolean intersection tests against any shape.

contains(x: number, y: number, threshold: number): boolean

Returns true if the point (x, y) is inside this shape.

copy(line: Line): this

destroy(): void

equals(__namedParameters: Partial<Line>): boolean

getBounds(out: RectangleMutable axis-aligned rectangle defined by a top-left origin `(x, y)` and dimensions `(width, height)`. Implements Collidable with full SAT collision response f…): RectangleMutable axis-aligned rectangle defined by a top-left origin `(x, y)` and dimensions `(width, height)`. Implements Collidable with full SAT collision response f…

The axis-aligned bounding box of this object. Pass out to write into a rectangle you own - every implementer honours it, so this form is always safe to retain and never allocates. Without out, the math shape values (Rectangle, Circle, Polygon, ...) return a **fresh** rectangle, while a node or view that maintains a cached box (see SceneNode.getBounds) returns that cached instance, which the next invalidation overwrites.

getNormals(): VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…[]

Return the outward-facing edge normals used by the SAT solver. The array should be cached and reused across calls.

intersectsWith(target: CollidableContract for objects that participate in collision detection. Implemented by all concrete shape classes as well as `SceneNode`.): boolean

Test whether this shape overlaps target using a fast boolean algorithm (no penetration depth or normal computed). Prefer this over collidesWith when only the yes/no result is needed.

project(_axis: VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…, result: IntervalA closed scalar interval `[min, max]` used by the SAT collision solver to represent the projection of a shape onto a separating axis. `Interval.temp` provides…): IntervalA closed scalar interval `[min, max]` used by the SAT collision solver to represent the projection of a shape onto a separating axis. `Interval.temp` provides…

Project this shape onto axis and write the scalar min/max into interval. Used internally by the SAT solver.

set(x1: number, y1: number, x2: number, y2: number): this

Properties8

collisionType: CollisionTypeDiscriminant tag carried by every Collidable so that intersection and collision routines can dispatch to the correct algorithm without `instanceof` checks.

fromPosition: VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…

fromX: number

fromY: number

toPosition: VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…

toX: number

toY: number

temp: Line

Source

src/math/Line.ts