Leadwerks Game Engine

Documentation › API Reference › Object › World

Pick

This function performs a pick operation on all entities in a world that intersect the specified line.

Syntax

bool Pick( Vec3 p0, Vec3 p1, PickInfo pickinfo,number radius=0.0, bool closest=false,number collisiontype=0)

Parameters

p0: the origin of the ray.
p1: the terminal end of the ray.
pickinfo: a pick info object to contain pick information.
radius: the radius of the ray. If the radius is greater than 0.0, a slower swept sphere collision will be performed.
closest: if set to true, the closest intersection will be found, otherwise the operation will return as soon as a single intersection is found.
collisiontype: if specified, the entity collision type will be tested against this, and only colliding entities will be tested.

Returns

Returns true if anything is hit, otherwise false is returned.

Example

--Create a window
window = Window:Create()
context = Context:Create(window)
world = World:Create() 
local camera = Camera:Create() 
camera:Move(0,0,-8) 
local light = DirectionalLight:Create() 
light:SetRotation(35,35,0) 
        
--Create a model
local model1 = Model:Box() 
model1:SetPosition(2,0,0) 

local model2 = Model:Box() 
model2:SetPosition(-2,0,0) 
model2:SetPickMode(0) -- Disable picking on the first hit entity

--Create a sphere to indicate where the pick hits
local picksphere = Model:Sphere() 
picksphere:SetColor(1.0,0.0,0.0) 
picksphere:SetPickMode(0) 

local pickradius = 0.5 
picksphere:SetScale(pickradius*2.0) 

world:Update() 
local pickinfo = PickInfo() 
if (world:Pick(-10,0.75,0,10,0.75,0,pickinfo,pickradius,true)) then
        
        picksphere:SetPosition(pickinfo.position) 

        --Make sure the pick mode equals Entity:PolygonPick
        Debug:Assert(pickinfo.entity:GetPickMode()==Entity.PolygonPick) 
        
else
        
        picksphere:Release() 
end

while true do        
        if window:Closed() or window:KeyHit(Key.Escape) then return false end
        
        Time:Update() 
        world:Update() 
        world:Render() 
        context:Sync() 

end