Documentation
¶
Index ¶
- Constants
- func Create(fsys rwfs.FS, name string, page *pageparser.ContentFrontMatter) error
- func IsSourceFile(name string) bool
- func Read(fsys rwfs.FS, name string) (pageparser.ContentFrontMatter, error)
- func Update(fsys rwfs.FS, name string, page *pageparser.ContentFrontMatter) error
- type BlipParameters
- type Orientation
- type Percentage
- type Position
- type RadarOptions
- type RadarParameters
- type Section
- type Tier
Constants ¶
View Source
const ( Quadrants = 4 Tiers = 4 )
Variables ¶
This section is empty.
Functions ¶
func Create ¶
func Create(fsys rwfs.FS, name string, page *pageparser.ContentFrontMatter) error
func IsSourceFile ¶
func Read ¶
func Read(fsys rwfs.FS, name string) (pageparser.ContentFrontMatter, error)
func Update ¶
func Update(fsys rwfs.FS, name string, page *pageparser.ContentFrontMatter) error
Types ¶
type BlipParameters ¶
type Orientation ¶
type Orientation = [2]float64
type Percentage ¶
type Percentage = float64
type Position ¶
type Position = Orientation
func CalculatePosition ¶
func CalculatePosition(radar *RadarParameters, blip *BlipParameters) (Position, error)
type RadarOptions ¶
type RadarOptions struct {
// Tiers names of tiers from the innermost to the outermost
Tiers [4]string
// Quadrants names of quadrants in a clockwise order starting with the top-left one
Quadrants [4]string
// Proportion of each tier rim relative to the radar radius. It must sum to a 100%
Proportion [4]Percentage
// Angle maximum angle the blips will end up
Angle float64
// BlipRadius the radius of blips plotted on the radar
BlipRadius float64
// Radius the radar maximum radius
Radius float64
}
type RadarParameters ¶
type RadarParameters struct {
QuadrantOrientation map[string]Orientation
TierRadius map[string]float64
TierOffset map[string]float64
Angle float64
BlipRadius float64
Radius float64
}
func NewRadar ¶
func NewRadar(options RadarOptions) (*RadarParameters, error)
Source Files
Click to show internal directories.
Click to hide internal directories.