Camera:Pick

This function performs a raycast at the specified screen coordinate.

Syntax

• PickInfo Pick(framebuffer, x, y, radius = 0.0, closest = false, filter(entity, object) = nil, extra = nil)
• PickInfo Pick(buffer, screencoord, radius = 0.0, closest = false, filter(entity, object) = nil, extra = nil)

Returns

Returns a PickInfo structure. If the success member of the structure is true, an object was hit. Otherwise, it will be false.

If a filter callback is provided, it will be called for each entity that is evaluated. If the callback returns true, the entity will be tested. Otherwise, it will be skipped.

Example

-- Function to be used as a filter callback
local function PickFilter(entity, extra)
    return true
end

-- Get the displays
local displays = GetDisplays()

-- Create a window
local window = CreateWindow("Ultra Engine", 0, 0, 1280, 720, displays[1], WINDOW_CENTER + WINDOW_TITLEBAR)

-- Create a world
local world = CreateWorld()

-- Create a framebuffer
local framebuffer = CreateFramebuffer(window)

-- Create light
local light = CreateBoxLight(world)
light:SetRange(-10, 10)
light:SetRotation(15, 15, 0)
light:SetColor(2)

-- Create camera
local camera = CreateCamera(world)
camera:SetClearColor(0.125)
camera:SetPosition(0, 0, -3)
camera:SetFov(70)

-- Create scenery
local box = CreateBox(world)

local cone = CreateCone(world)
cone:SetPosition(1.25, 0, 0)

local sphere = CreateSphere(world)
sphere:SetPosition(-1.25, 0, 0)

-- Main loop
while not window:Closed() and not window:KeyDown(KEY_ESCAPE) do
    -- Click on an object to change its color
    if window:MouseHit(MOUSE_LEFT) then
        box:SetColor(1, 1, 1)
        cone:SetColor(1, 1, 1)
        sphere:SetColor(1, 1, 1)
        local mousepos = window:GetMousePosition()
        local pick = camera:Pick(framebuffer, mousepos.x, mousepos.y, 0, true, PickFilter, nil)
        if pick.success then
            pick.entity:SetColor(1, 0, 0)
        end
    end

    world:Update()
    world:Render(framebuffer)
end