mapasci

Documentation

Index

• Constants
• func CharForLandFraction(fraction float64) (byte, error)
• func RenderWorldASCII(mask *LandMask, size int, supersample int, charAspect float64, marker *Marker) (string, error)
• func RenderWorldASCIIWithOptions(mask *LandMask, size int, supersample int, charAspect float64, marker *Marker, ...) (string, error)
• func SampleLandValue(mask *LandMask, lon float64, lat float64) (float64, error)
• func StreamWorldASCIIAnimation(ctx context.Context, mask *LandMask, size int, supersample int, ...) error
• type AnimationOptions
• type AnimationStyle
• type Frame
• type LandMask
  • func LoadLandMask(maskPath string) (*LandMask, error)
• type Marker
• type RenderOptions
• type Viewport

Constants

const (
	DefaultVerticalMarginRows  = 2
	DefaultVerticalPaddingRows = DefaultVerticalMarginRows
)

const (
	DefaultAnimationFPS = 2
)

Functions

func CharForLandFraction

func CharForLandFraction(fraction float64) (byte, error)

func RenderWorldASCII

func RenderWorldASCII(mask *LandMask, size int, supersample int, charAspect float64, marker *Marker) (string, error)

func RenderWorldASCIIWithOptions

func RenderWorldASCIIWithOptions(mask *LandMask, size int, supersample int, charAspect float64, marker *Marker, options *RenderOptions) (string, error)

func SampleLandValue

func SampleLandValue(mask *LandMask, lon float64, lat float64) (float64, error)

func StreamWorldASCIIAnimation

func StreamWorldASCIIAnimation(
	ctx context.Context,
	mask *LandMask,
	size int,
	supersample int,
	charAspect float64,
	marker *Marker,
	renderOpts *RenderOptions,
	animOpts *AnimationOptions,
	emit func(Frame) error,
) error

Types

type AnimationOptions

type AnimationOptions struct {
	FPS      int
	Style    AnimationStyle
	Duration time.Duration
}

type AnimationStyle

type AnimationStyle string

const (
	AnimationStylePulseColor AnimationStyle = "pulse-color"
	AnimationStyleBlink      AnimationStyle = "blink"
)

type Frame

type Frame struct {
	Text string
}

type LandMask

type LandMask struct {
	Width  int
	Height int
	Data   []float64
}

func LoadLandMask

func LoadLandMask(maskPath string) (*LandMask, error)

type Marker

type Marker struct {
	Lon        float64
	Lat        float64
	Center     rune
	Horizontal rune
	Vertical   rune
	ArmX       int
	ArmY       int
}

type RenderOptions

type RenderOptions struct {
	VerticalMarginRows  int
	VerticalPaddingRows int
	Frame               bool
	ColorMode           string
	MapColor            string
	FrameColor          string
	MarkerColor         string
	Viewport            *Viewport
}

type Viewport

type Viewport struct {
	MinLon float64
	MinLat float64
	MaxLon float64
	MaxLat float64
}