DatumHuePlatform v0.0.24datumhue.com
Contents

handle40 methods, 3 fields, 6 operators

Vec3

A 3D vector (Y-up). Construct with datumhue.math.vec3(x, y, z). #v is v:length(), not a component count.

Obtained from
datumhue.math.vec3, datumhue.time.tween (in its callback), datumhue.physics.raycast, datumhue.physics.raycast_all, datumhue.physics.shapecast, datumhue.voxel.world (in its callback), datumhue.math.vec3.from_array, Scene:raycast and 40 more
Accepted by
datumhue.math.ray, datumhue.time.tween, datumhue.physics.add_joint, datumhue.physics.point_query, datumhue.voxel.new, datumhue.voxel.world, datumhue.particles.emitter, datumhue.math.quat.from_axis_angle and 63 more
Operators
Vec3 + Vec3 -> Vec3 Component-wise addition.
Vec3 - Vec3 -> Vec3 Component-wise subtraction.
Vec3 * Vec3 | number -> Vec3 Vector or scalar multiplication.
Vec3 / Vec3 | number -> Vec3 Vector or scalar division.
-Vec3 -> Vec3 Negation.
#Vec3 -> number Magnitude (the # operator).

Fields 3

FieldTypeAccessDescription
xnumberread-onlyX component.
ynumberread-onlyY component.
znumberread-onlyZ component.

Methods 40

Vec3:length

method
Vec3:length() -> number

Magnitude.

Vec3:length_squared

method
Vec3:length_squared() -> number

Squared magnitude (no sqrt).

Vec3:min_element

method
Vec3:min_element() -> number

Smallest component.

Vec3:max_element

method
Vec3:max_element() -> number

Largest component.

Vec3:normalize

method
Vec3:normalize() -> Vec3

Unit vector. Raises if v is zero-length / non-finite; use normalize_or or try_normalize for a fallback.

Vec3:normalize_or

method
Vec3:normalize_or(fallback: Vec3) -> Vec3

Unit vector, or fallback if v is zero-length / non-finite.

Vec3:try_normalize

method
Vec3:try_normalize() -> Vec3?

Unit vector, or nil if v is zero-length / non-finite.

Vec3:distance_squared

method
Vec3:distance_squared(o: Vec3) -> number

Squared Euclidean distance to o (no sqrt).

Vec3:signum

method
Vec3:signum() -> Vec3

Component-wise sign (-1, 0, or +1).

Vec3:fract

method
Vec3:fract() -> Vec3

Component-wise fractional part (self - self.trunc()).

Vec3:recip

method
Vec3:recip() -> Vec3

Component-wise reciprocal (1/x).

Vec3:element_sum

method
Vec3:element_sum() -> number

Sum of the components.

Vec3:element_product

method
Vec3:element_product() -> number

Product of the components.

Vec3:to_array

method
Vec3:to_array() -> number[]

Components as a {x, y, z} array.

Vec3:abs

method
Vec3:abs() -> Vec3

Component-wise absolute value.

Vec3:floor

method
Vec3:floor() -> Vec3

Component-wise floor.

Vec3:ceil

method
Vec3:ceil() -> Vec3

Component-wise ceil.

Vec3:round

method
Vec3:round() -> Vec3

Component-wise round.

Vec3:any_orthogonal

method
Vec3:any_orthogonal() -> Vec3

An arbitrary vector orthogonal to v.

Vec3:dot

method
Vec3:dot(o: Vec3) -> number

Dot product.

Vec3:distance

method
Vec3:distance(o: Vec3) -> number

Euclidean distance to o.

Vec3:angle_between

method
Vec3:angle_between(o: Vec3) -> number

Unsigned angle to o in radians.

Example
-- Unsigned radians, from 0 to pi.
local x = datumhue.math.vec3(1, 0, 0)
local up = datumhue.math.vec3(0, 1, 0)
local back = datumhue.math.vec3(-1, 0, 0)
print(string.format("%.4f", x:angle_between(up))) --> 1.5708
print(string.format("%.4f", x:angle_between(back))) --> 3.1416

Vec3:cross

method
Vec3:cross(o: Vec3) -> Vec3

Cross product.

Example
-- The order matters: X cross Y is +Z, Y cross X is -Z.
local x = datumhue.math.vec3(1, 0, 0)
local y = datumhue.math.vec3(0, 1, 0)
print(x:cross(y)) --> vec3(0.0, 0.0, 1.0)
print(y:cross(x)) --> vec3(0.0, 0.0, -1.0)

Vec3:midpoint

method
Vec3:midpoint(o: Vec3) -> Vec3

Midpoint between v and o.

Vec3:reflect

method
Vec3:reflect(o: Vec3) -> Vec3

Reflect v about the normal o.

Vec3:min

method
Vec3:min(o: Vec3) -> Vec3

Component-wise minimum.

Vec3:max

method
Vec3:max(o: Vec3) -> Vec3

Component-wise maximum.

Vec3:project_onto

method
Vec3:project_onto(o: Vec3) -> Vec3

Projection of v onto o. Errors if o is zero-length.

Vec3:reject_from

method
Vec3:reject_from(o: Vec3) -> Vec3

Rejection of v from o. Errors if o is zero-length.

Vec3:lerp

method
Vec3:lerp(o: Vec3, t: number) -> Vec3

Linear interpolation toward o by t; t outside 0..1 extrapolates past the endpoints (not clamped).

Vec3:slerp

method
Vec3:slerp(o: Vec3, t: number) -> Vec3

Spherical interpolation toward o by t.

Vec3:move_towards

method
Vec3:move_towards(o: Vec3, d: number) -> Vec3

Move toward o by at most distance d.

Vec3:clamp

method
Vec3:clamp(lo: Vec3, hi: Vec3) -> Vec3

Component-wise clamp to [lo, hi].

Vec3:clamp_length

method
Vec3:clamp_length(lo: number, hi: number) -> Vec3

Clamp magnitude to [lo, hi].

Vec3:is_normalized

method
Vec3:is_normalized() -> boolean

Whether the vector is unit length.

Vec3:truncate

method
Vec3:truncate() -> Vec2

Drop the z component, returning a Vec2.

Vec3:with_x

method
Vec3:with_x(x: number) -> Vec3

Copy with x replaced.

Vec3:with_y

method
Vec3:with_y(y: number) -> Vec3

Copy with y replaced.

Vec3:with_z

method
Vec3:with_z(z: number) -> Vec3

Copy with z replaced.

Vec3:unpack

method
Vec3:unpack() -> number, number, number

Return the x, y and z components as three values.

Example
local x, y, z = datumhue.math.vec3(1, 2, 3):unpack()
print(x, y, z) --> 1.0 2.0 3.0

datumhue.com

(c) 2026 Shuusei AB. Quote excerpts of this manual, with attribution to DatumHue, in your own documentation, tutorials, course materials, reviews, and other writing or video. Republishing it in whole or in substantial part needs written permission: support@datumhue.com.

Victor Mono is licensed under the SIL Open Font License 1.1
Copyright (c) 2024, Rune Bjørnerås (https://github.com/rubjo)

This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL


-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------

PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.

The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.

DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.

"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).

"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).

"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.

"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.

PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:

1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.

2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.

3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.

4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.

5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.

TERMINATION
This license becomes null and void if any of the above conditions are
not met.

DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.

Try

    ↑↓ selectEnter openTab filter

    Settings

    Theme
    Text
    Print

    Keyboard shortcuts

    / or Ctrl KSearch
    ↑ ↓ EnterPick a result
    TabNext result filter
    j kNext or previous entry
    [ ]Previous or next page
    yCopy a link to the current entry
    ?These shortcuts
    EscClose

    On this page