gtree

type AlignedNode struct {
	ID           int
	HeadingTexts TextSection
	DetailTexts  TextSection
	Tags         []string

	// Text          []string
	CentreText          bool         // true if the text for this blurb is better presented as centred
	Width               Pixel        // Width is the horizontal extent of the Blurb
	AbsolutePositioning bool         // when true, the position of the blurb is controlled by TopPos and LeftPos, otherwise it is calculated relative to neighbours
	TopPos              Pixel        // TopPos is the absolute vertical position of the upper edge of the Blurb
	LeftPos             Pixel        // LeftPos is the absolute horizontal position of the left edge of the Blurb
	Height              Pixel        // Height is the vertical extent of the Blurb
	Col                 int          // column the blurb appears in for layouts that use columns
	Row                 int          // row the blurb appears in for layouts that use rows
	LeftPad             Pixel        // required padding to left of blurb to separate families
	NoShift             bool         // when true the left shift will not be changed
	KeepTightRight      *AlignedNode // the blurb to the right that this blurb should keep as close as possible to
	LeftNeighbour       *AlignedNode // the blurb to the left of this one, when non-nil will be used for horizontal positioning
	Parent              *AlignedNode
	TopHookOffset       Pixel // TopHookOffset is the offset from the left of the blurb where any dropped connecting line should finish (ensures it is within the bounds of the name, even if subsequent detail lines are longer)
	SideHookOffset      Pixel // SideHookOffset is the offset from the top of the blurb where any connecting line should finish

	FirstChild *AlignedNode
	LastChild  *AlignedNode
}

type Alignment int

type AncestorChart struct {
	Title string
	Notes []string
	Root  *AncestorPerson
}

type AncestorLayout struct {
	// contains filtered or unexported fields
}

type AncestorLayoutOptions struct {
	Debug bool

	LineWidth Pixel // width of any drawn lines
	Margin    Pixel // margin to add to entire drawing
	Hspace    Pixel // the horizontal space to leave between nodes in different generations
	Vspace    Pixel // the vertical space to leave between nodes in the same generation
	LineGap   Pixel // the distance to leave between a connecting line and any text

	HookLength Pixel // the length of the line drawn from the parent or a child to the vertical line that joins them

	TitleStyle   TextStyleOption // TitleStyle is the style of the font to use for the title of the chart.
	NoteStyle    TextStyleOption // NoteStyle is the style of the font to use for the notes of the chart.
	HeadingStyle TextStyleOption // HeadingStyle is the style of the font to use for the first line of each node.
	DetailStyle  TextStyleOption // DetailStyle is the style of the font to use for the subsequent lines of each node after the first.

	DetailWrapWidth Pixel // DetailWrapWidth is the maximum width of detail text before wrapping to a new line.

	BackgroundColor string // BackgroundColor is the color of the background, empty for transparent/no-background fill
}

type AncestorPerson struct {
	ID       int
	Headings []string
	Details  []string
	Father   *AncestorPerson
	Mother   *AncestorPerson
}

type Blurb struct {
	Texts     []TextSection
	Alignment Alignment

	X        Pixel   // the vertical position of the centre of the Blurb
	Y        Pixel   // the horizontal position of the centre of the Blurb
	Width    Pixel   // the horizontal extent of the Blurb
	Height   Pixel   // the vertical extent of the Blurb
	Rotation float64 //
}

type ButterflyChart struct {
	TitleLine1 string
	TitleLine2 string
	Note       string
	Root       *ButterflyPerson
}

type ButterflyLayoutOptions struct {
	Debug bool

	// Horizontals are x coordinates by generation
	// if paternal then use 5-gen to find coord
	// if maternal then use 6+gen to find coord
	Horizontals [12]float64

	// Verticals are y coordinates by generation, 6 generations
	Verticals [6][]float64

	// BoxWidths are widths of each box, by generation
	BoxWidths [6]float64

	// BoxHeights are heights of each box, by generation
	BoxHeights [6]float64

	// AscenderHorizontals are the horizontal positions of each ascender, by generation
	// if paternal then use 4-gen to find coord
	// if maternal then use 5+gen to find coord
	AscenderHorizontals [10]float64

	// AscenderVerticals are the vertical psotions of each ascender by generation, 5 generations
	AscenderVerticals       [5][]float64
	AscenderVerticalOffset  [5]float64
	AscenderVerticalSpacing [5]float64
}

type ButterflyPerson struct {
	ID            int
	Forenames     string
	Surname       string
	DetailLine1   string
	DetailLine2   string
	MarriageLine1 string // only used for male
	MarriageLine2 string
	Father        *ButterflyPerson
	Mother        *ButterflyPerson
}

type Connector struct {
	Points []Point
}

type DescendantChart struct {
	Title string
	Notes []string
	Root  *DescendantPerson
}

type DescendantFamily struct {
	Other    *DescendantPerson
	Details  []string
	Children []*DescendantPerson
}

type DescendantLayout struct {
	// contains filtered or unexported fields
}

type DescendantPerson struct {
	ID       int
	Headings []string
	Details  []string
	Families []*DescendantFamily
	Tags     []string
}

type Extent struct {
	Width  Pixel
	Height Pixel
}

type FanChart struct {
	Title     string     // Title displayed on the diagram.
	PreTitle  string     // A line of text to place above the title, uses subtitle style
	PostTitle string     // A line of text to place below the title, uses subtitle style
	Notes     []string   // Optional lines of annotation, shown at the edge of the layout.
	Root      *FanPerson // The subject of the chart (generation 0). All ancestors trace back from this person.
}

type FanLayout struct {
	// contains filtered or unexported fields
}

type FanLayoutOptions struct {
	MaxGenerations int // Maximum number of generations to layout.
	Margin         Millimetre
	RadiusStep     float64 // Radial distance (in pixels) between generations.
	BaseFontSize   float64 // Font size for the closest generation (generation 0).
	GenScaleFactor float64 // Scaling factor applied to font size per generation (e.g. 0.85).
	AngularSpanDeg float64 // Total angular spread of the fan in degrees (e.g. 120 for 120°).
	Debug          bool
	TitleStyle     TextStyleOption // TitleStyle is the style of the font to use for the title of the chart.
	SubTitleStyle  TextStyleOption // SubTitleStyle is the style of the font to use for the pre and post titles of the chart.
	NoteStyle      TextStyleOption // NoteStyle is the style of the font to use for the notes of the chart.
	HeadingStyle   TextStyleOption // HeadingStyle is the style of the font to use for the heading lines of each node.
	DetailStyle    TextStyleOption // DetailStyle is the style of the font to use for the subsequent lines of each node after the first.
	DPI            int

	BackgroundColor string // BackgroundColor is the color of the background, empty for transparent/no-background fill
	// contains filtered or unexported fields
}

type FanPerson struct {
	ID       int        // Unique ID used to identify this person within the chart.
	Headings []string   // Main lines of text (e.g. name), usually rendered in larger or bolder type.
	Details  []string   // Secondary lines (e.g. birth/death years, occupation).
	Father   *FanPerson // Pointer to the father, if known. nil if unknown.
	Mother   *FanPerson // Pointer to the mother, if known. nil if unknown.
}

type Font struct {
	Name  string
	Bytes []byte
	// contains filtered or unexported fields
}

type FontData struct {
	Font  *opentype.Font
	Bytes []byte
}

type Layout interface {
	Height() Pixel
	Width() Pixel
	Margin() Pixel
	Legend() *Blurb
	Blurbs() []*Blurb
	Connectors() []*Connector
	Debug() bool
	Background() string // raw svg to use as a background
	BackgroundColor() string
}

type LayoutOptions struct {
	Debug      bool // Debug indicates whether to emit logging and debug information.
	Iterations int  // Number of iterations of adjustment to run

	Hspace     Pixel // Hspace is the horizontal spacing between nodes within the same family.
	LineWidth  Pixel // LineWidth is the width of the lines connecting nodes.
	Margin     Pixel // Margin is the margin added to the entire drawing.
	FamilyDrop Pixel // FamilyDrop is the length of the line drawn from parents to the children group line.
	ChildDrop  Pixel // ChildDrop is the length of the line drawn from the children group line to a child.
	LineGap    Pixel // LineGap is the distance between a connecting line and any text.

	TitleStyle   TextStyleOption // TitleStyle is the style of the font to use for the title of the chart.
	NoteStyle    TextStyleOption // NoteStyle is the style of the font to use for the notes of the chart.
	HeadingStyle TextStyleOption // HeadingStyle is the style of the font to use for the first line of each node.
	DetailStyle  TextStyleOption // DetailStyle is the style of the font to use for the subsequent lines of each node after the first.

	DetailWrapWidth Pixel // DetailWrapWidth is the maximum width of detail text before wrapping to a new line.

	BackgroundColor string // BackgroundColor is the color of the background, empty for transparent/no-background fill
}

type Millimetre float64

type PaperSize struct {
	Width  Millimetre // width in millimetres
	Height Millimetre // height in millimetres
}

type Parser struct {
	SurnameSeparateLine bool // if true the parser puts the surname on a second header line
}

type Pixel int

type Point struct {
	X Pixel
	Y Pixel
}

type SpreadingDescendantArranger struct{}

type TextSection struct {
	Lines []string
	Style TextStyle
}

type TextStyle struct {
	FontSize   Pixel // FontSize is the size of the font to use for the text of each blurb.
	FontFamily string
	LineHeight Pixel // LineHeight is the vertical distance between lines of text of the same style.
	Font       *Font
	Color      string // Color is the color of the text. The default is black #000000.
}

type TextStyleOption struct {
	FontNames  []string // list of font names in priority order
	FontSize   Pixel    // FontSize is the size of the font to use for the text of each node.
	Color      string   // Color is the color of the text. The default is black #000000.
	LineHeight Pixel    // TODO: remove
}