Leadwerks Game Engine

Documentation › API Reference › Object › Math › Transform

Point

This function transforms a point from one space to another.

Syntax

Vec3 Point(Vec3 point, Entity src, Entity dst)
Vec3 Point(number x,number y,number z, Entity src, Entity dst)
Vec3 Point(Vec3 point, Mat4 src,Mat4 dst)
Vec3 Point(number x,number y,number z, Mat4 src, Mat4 dst)

Parameters

point: the point to be transformed.
x: the X component of the point to be transformed.
y: the Y component of the point to be transformed.
z: the Z component of the point to be transformed.
src: the source entity or 4x4 matrix to transform the point from.
dst: the destination entity or 4x4 matrix to transform the point to.

Returns

Returns the transformed point.

Example

--Create a window
window = Window:Create()

context = Context:Create(window)

world = World:Create()

local camera = Camera:Create() 
camera:Move(0,0,-3) 

local light = DirectionalLight:Create() 
light:SetRotation(35,35,0) 

--Create a model
model = Model:Box() 
model:SetColor(0.0,0.0,1.0) 
model:SetPosition(3,0,0)

while true do
        if window:Closed() or window:KeyHit(Key.Escape) then return false end

        Time:Update()
        world:Update()
        world:Render()

        --We're going to transform the position (2,0,0) from global space to the model's local space
        --Because the model is positioned at (3,0,0) the point will be at (-1,0,0) in local space (relative to the model).
        local position = Transform:Point(2,0,0,nil,model)
        context:SetBlendMode(Blend.Alpha) 
        context:DrawText(position:ToString(),2,2) 
        context:SetBlendMode(Blend.Solid) 
        context:Sync()
end