Skip to content

Vec3 - GL Math

PHP-GLFW comes with built in fixed size vector classes. Vec3 represents a vector with 3 components ( x, y, z, ).

namespace GL\Math
{
    class Vec3 {
        public float $x;
        public float $y;
        public float $z;
    }
}

The properties of this class are virtual, meaning in this case they are not real PHP properties. But rather values stored internally that can be accessed like a property. The same values can be read and written using different names for convience:

$vec = new Vec3;
$vec->x = 42.0;
$vec->y = 42.0;
$vec->z = 42.0;

Is exactly the same as:

$vec = new Vec3;
$vec->r = 42.0;
$vec->g = 42.0;
$vec->b = 42.0;

Methods

__construct

Constructor

function __construct(?float $x = null, ?float $y = null, ?float $z = null)

normalized

Retruns a normalized version of the given Vec3 * 

$normalized = Vec3::normalize(new Vec3($x, $y, $z));


static function normalized(\GL\Math\Vec3 $vec) : \GL\Math\Vec3
arguments
  1. \Vec3 $vec The vector to normalize.
returns

\Vec3 The normalized vector.

distance

Returns the distance between the left and right vectors

static function distance(\GL\Math\Vec3 $left, \GL\Math\Vec3 $right) : float

$distance = Vec3::distance($left, $right);
arguments
  1. \Vec3 $left The left vector.
  2. \Vec3 $right The right vector.
returns

float The distance between the left and right vectors.

distance2

Returns the squared distance between the left and right vectors

static function distance2(\GL\Math\Vec3 $left, \GL\Math\Vec3 $right) : float

$distance = Vec3::distance2($left, $right);
arguments
  1. \Vec3 $left The left vector.
  2. \Vec3 $right The right vector.
returns

float The squared distance between the left and right vectors.

dot

Returns the dot product of the left and right vectors

static function dot(\GL\Math\Vec3 $left, \GL\Math\Vec3 $right) : float

$dot = Vec3::dot($left, $right);
arguments
  1. \Vec3 $left The left vector.
  2. \Vec3 $right The right vector.
returns

float The dot product of the left and right vectors.

mix

Linearly interpolates between the left and right vectors by the given t value.

static function mix(\GL\Math\Vec3 $left, \GL\Math\Vec3 $right, float $t) : \GL\Math\Vec3

$mixed = Vec3::mix($left, $right, $t);
arguments
  1. \Vec3 $left The left vector.
  2. \Vec3 $right The right vector.
  3. float $t The t value (progress / state) 0.0 == left, 1.0 == right.
returns

\Vec3 The mixed vector.

lerp

Linearly interpolates between the left and right vectors by the given t value.

static function lerp(\GL\Math\Vec3 $left, \GL\Math\Vec3 $right, float $t) : \GL\Math\Vec3

This does exactly the same as mix..

$lerped = Vec3::lerp($left, $right, $t);
arguments
  1. \Vec3 $left The left vector.
  2. \Vec3 $right The right vector.
  3. float $t The t value (progress / state) 0.0 == left, 1.0 == right.
returns

\Vec3 The lerped vector.

slerp

Spherically interpolates between the left and right vectors by the given t value.

static function slerp(\GL\Math\Vec3 $left, \GL\Math\Vec3 $right, float $t) : \GL\Math\Vec3

$slerped = Vec3::slerp($left, $right, $t);
arguments
  1. \Vec3 $left The left vector.
  2. \Vec3 $right The right vector.
  3. float $t The t value (progress / state) 0.0 == left, 1.0 == right.
returns

\Vec3 The slerped vector.

length

Returns the length of the vector

function length() : float
returns

float

distanceTo

Returns the distance between this vector and another

function distanceTo(\GL\Math\Vec3 $right) : float
returns

float

distance2To

Returns squared distance between this vector and another

function distance2To(\GL\Math\Vec3 $right) : float
returns

float

normalize

normalizes the current vector

function normalize() : void
returns

void

abs

Makes each component x if x >= 0; otherwise, -x

function abs() : void
returns

void