spatial

Documentation

Index

• Constants
• type BlockPosition
  • func (lhs BlockPosition) Add(rhs BlockPosition) BlockPosition
  • func (lhs BlockPosition) AddNode(pos NodePosition) NodePosition
• type Bounds
• type NodePosition
  • func (lhs NodePosition) Add(rhs NodePosition) NodePosition
  • func (lhs NodePosition) Region() Region
• type Region
  • func (lhs Region) Intersects(rhs Region) bool
  • func (lhs Region) IsAtEdge(pos NodePosition) bool
• type TileRegion

Constants

const BlockSize = 16

const BlockVolume = BlockSize * BlockSize * BlockSize

Types

type BlockPosition

type BlockPosition struct {
	X, Y, Z int
}

BlockPosition is a block position in world space

func (BlockPosition) Add

func (lhs BlockPosition) Add(rhs BlockPosition) BlockPosition

func (BlockPosition) AddNode

func (lhs BlockPosition) AddNode(pos NodePosition) NodePosition

type Bounds

type Bounds struct {
	Min int `toml:"min"`
	Max int `toml:"max"`
}

Bounds defines the extent of a region on a single axis. It is assumed that Max is always greater or equal to Min.

type NodePosition

type NodePosition struct {
	X, Y, Z int
}

NodePosition is a node position in world space

func (NodePosition) Add

func (lhs NodePosition) Add(rhs NodePosition) NodePosition

func (NodePosition) Region

func (lhs NodePosition) Region() Region

type Region

type Region struct {
	XBounds Bounds `toml:"x_bounds"`
	YBounds Bounds `toml:"y_bounds"`
	ZBounds Bounds `toml:"z_bounds"`
}

Region defines an axis-aligned cuboid region in world space (units are nodes).

func (Region) Intersects

func (lhs Region) Intersects(rhs Region) bool

func (Region) IsAtEdge

func (lhs Region) IsAtEdge(pos NodePosition) bool

type TileRegion

type TileRegion struct {
	XBounds Bounds
	YBounds Bounds
}

TileRegion defines an axis-aligned rectangle region in tile space (units are tiles at zoom level 0). It's used to represent a projection of a Region onto the screen.