NavigationSystem

NavigationSystem

Functions

• delete
• draw
• loadMapData
• navigateTo
• new
• onNavigationMarkerLoaded
• saveToXMLFile
• stop
• updateMarker

delete

Description

Definition

delete()

Code

function NavigationSystem:delete()
    if self.loadRequestId ~ = nil then
        g_i3DManager:cancelStreamI3DFile( self.loadRequestId)
        self.loadRequestId = nil
    end

    if self.positionNode ~ = nil then
        delete( self.positionNode)
        self.positionNode = nil
    end

    if self.navigationMarker ~ = nil then
        self.navigationMarker:delete()
        self.navigationMarker = nil
    end
end

draw

Description

Definition

draw()

Code

function NavigationSystem:draw()
    self.navigationMarker:render()
end

loadMapData

Description

Load data on map load

Definition

loadMapData()

Arguments

any	xmlFile
any	missionInfo
any	baseDirectory

Return Values

any	true	if loading was successful else false

Code

function NavigationSystem:loadMapData(xmlFile, missionInfo, baseDirectory)

    local filepath = Utils.getFilename( "$data/shared/assets/marker/navigationMarker.i3d" , baseDirectory)
    self.loadRequestId = g_i3DManager:loadI3DFileAsync(filepath, true , true , self.onNavigationMarkerLoaded, self , nil )

    return true
end

navigateTo

Description

Definition

navigateTo()

Arguments

any	x
any	y
any	z
any	dirX
any	dirY
any	dirZ

Code

function NavigationSystem:navigateTo(x, y, z, dirX, dirY, dirZ)
    self.navigationMarker:setWorldPosition(x, y + 1.4 , z)
    self.navigationMarker:setVisibility( true )

    self.targetX = x
    self.targetY = y
    self.targetZ = z

    self.targetDirX = dirX
    self.targetDirY = dirY
    self.targetDirZ = dirZ

    g_currentMission:addDrawable( self )

    self:updateMarker()
end

new

Description

Definition

new()

Arguments

any	customMt

Code

function NavigationSystem.new(customMt)
    local self = setmetatable( { } , customMt or NavigationSystem _mt)

    self.navigationMarker = NavigationMarker.new()

    self.positionNode = nil
    self.directionNode = nil

    return self
end

onNavigationMarkerLoaded

Description

Definition

onNavigationMarkerLoaded()

Arguments

any	i3dNode
any	failedReason
any	args

Code

function NavigationSystem:onNavigationMarkerLoaded(i3dNode, failedReason, args)
    if failedReason = = LoadI3DFailedReason.NONE then
        self.positionNode = getChildAt(i3dNode, 0 )
        self.directionNode = getChildAt( self.positionNode, 0 )
        setVisibility( self.positionNode, false )
        setVisibility( self.directionNode, false )
        link(getRootNode(), self.positionNode)

        self:updateMarker()

        delete(i3dNode)
    end

    self.loadRequestId = nil
end

saveToXMLFile

Description

Definition

saveToXMLFile()

Arguments

any	xmlFilename

Code

function NavigationSystem:saveToXMLFile(xmlFilename)
    local xmlFile = XMLFile.create( "navigationSystem" , xmlFilename, "navigationSystem" , NavigationSystem.xmlSchema)

    if self.targetX ~ = nil then
        xmlFile:setValue( "navigationSystem.target#position" , self.targetX, self.targetY, self.targetZ)

        if self.targetDirX ~ = nil then
            xmlFile:setValue( "navigationSystem.target#direction" , self.targetDirX, self.targetDirY, self.targetDirZ)
        end
    end

    xmlFile:save()
    xmlFile:delete()
end

stop

Description

Definition

stop()

Code

function NavigationSystem:stop()
    self.targetX = nil
    self.targetY = nil
    self.targetZ = nil

    self.targetDirX = nil
    self.targetDirY = nil
    self.targetDirZ = nil

    g_currentMission:removeDrawable( self )

    self:updateMarker()
end

updateMarker

Description

Definition

updateMarker()

Code

function NavigationSystem:updateMarker()
    local isActive = self.targetX ~ = nil
    local isActiveDir = self.targetDirX ~ = nil

    if self.navigationMarker ~ = nil then
        self.navigationMarker:setVisibility(isActive)
    end

    if self.positionNode~ = nil then
        setVisibility( self.positionNode, isActive)
        setVisibility( self.directionNode, isActiveDir)

        setWorldTranslation( self.positionNode, self.targetX or 0 , self.targetY or 0 , self.targetZ or 0 )

        if self.targetDirX ~ = nil then
            setVisibility( self.directionNode, true )
            setWorldDirection( self.directionNode, self.targetDirX, self.targetDirY, self.targetDirZ, 0 , 1 , 0 )
        end
    end
end