nav_ladder.go

/*
	gonav - A Source Engine navigation mesh file parser written in Go.
	Copyright (C) 2016  Matt Razza

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as published
	by the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.

	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

// Package gonav provides functionality related to CS:GO Nav Meshes
package gonav

// NavLadderDirection represents the direction between a ladder and its connection
type NavLadderDirection int

const (
	// NavLadderDirectionUp means up the ladder
	NavLadderDirectionUp NavLadderDirection = iota

	// NavLadderDirectionDown means down the ladder
	NavLadderDirectionDown

	// NavLadderDirectionMax the max value for NavLadderDirection's
	NavLadderDirectionMax
)

// NavLadderConnection represents a connection between an area and a ladder
type NavLadderConnection struct {
	SourceArea   *NavArea           // The area that is the source of this NavConnection
	TargetID     uint32             // The ID of the ladder target
	TargetLadder *NavLadder         // The ladder
	Direction    NavLadderDirection // The direction of this connection
}

// NavLadder represents a ladder within the world
type NavLadder struct {
	ID               uint32             // The ID of the ladder
	Width            float32            // The width of the ladder
	Length           float32            // The length of the ladder
	Top              Vector3            // The location of the center of the top of the ladder
	Bottom           Vector3            // The location of the center of the bottom of the ladder
	Direction        NavLadderDirection // The direction of the NavLadder
	TopForwardAreaID uint32             // ID of the area connected to the top-forward position of the ladder
	TopForwardArea   *NavArea           // The area connected to the top-forward position of the ladder
	TopLeftAreaID    uint32             // ID of the area connected to the top-left position of the ladder
	TopLeftArea      *NavArea           // The area connected to the top-forward position of the ladder
	TopRightAreaID   uint32             // ID of the area connected to the top-right position of the ladder
	TopRightArea     *NavArea           // The area connected to the top-right position of the ladder
	TopBehindAreaID  uint32             // ID of area connected to the top-behind position of the ladder
	TopBehindArea    *NavArea           // The area connected to the top-behind position of the ladder
	BottomAreaID     uint32             // ID of the area connected to the bottom of the ladder
	BottomArea       *NavArea           // The area connected to the bottom of the ladder
}

func (conn *NavLadderConnection) connectGraph(mesh *NavMesh) {
	conn.TargetLadder = mesh.Ladders[conn.TargetID]
}