rings

type Angle float64

type Arc struct {
	Theta Angle // Initial angle of an arc in radians.
	Phi   Angle // The sweep of the arc in radians.
}

type ArcOfer interface {
	Arcer

	// ArcOf must return a non-nil error if the Feature is not found by
	// the receiver or the query is nil, unless the receiver is an Arc. When
	// the receiver is an Arc the error returned is always nil.
	ArcOf(loc, f Feature) (Arc, error)
}

type Arcer interface {
	Arc() Arc
}

type Arcs struct {
	Base Arc             // Base represents the complete span of the Arcs.
	Arcs map[Feature]Arc // Arcs provides a lookup for features within the span.
}

type Axis struct {
	// Angle specifies the angular location of the axis.
	Angle Angle

	// Label describes the axis label configuration.
	Label AxisLabel

	// LineStyle is the style of the axis line.
	LineStyle draw.LineStyle

	// Tick describes the scale's tick configuration.
	Tick TickConfig

	// Grid is the style of the grid lines.
	Grid draw.LineStyle
}

type AxisLabel struct {
	// Text is the axis label string.
	Text string

	// TextStyle is the style of the axis label text.
	draw.TextStyle

	// Placement determines the text rotation and alignment.
	// If Placement is nil, DefaultPlacement is used.
	Placement TextPlacement
}

type Bezier struct {
	// Segments defines the number of segments to draw when rendering the curve.
	Segments int

	// Radius, Crest and Purity define aspects of Bézier geometry.
	//
	// See http://circos.ca/documentation/tutorials/links/geometry/images for a detailed explanation
	// of radius, crest and purity.
	//
	// Radius specifies the Bézier radius of a curve generated by the Bezier.
	Radius LengthDist
	// Crest and Purity specify the crest and purity behaviour of a curve generated by the Bezier.
	// If nil, these values are not used.
	Crest  *FactorDist
	Purity *FactorDist
}

type Blocks struct {
	// Set holds a collection of features to render.
	Set []Feature

	// Base defines the targets of the rendered blocks.
	Base ArcOfer

	// Color determines the fill color of each block. If Color is not nil each block is rendered
	// filled with the specified color, otherwise no fill is performed. This behaviour is
	// over-ridden if the feature describing the block is a FillColorer.
	Color color.Color

	// LineStyle determines the line style of each block. LineStyle behaviour
	// is over-ridden if the feature describing a block is a LineStyler.
	LineStyle draw.LineStyle

	// Inner and Outer define the inner and outer radii of the blocks.
	Inner, Outer vg.Length

	// X and Y specify rendering location when Plot is called.
	X, Y float64
}

type ColorFunc func(interface{}) color.Color

type Conformation int8

type Conformationer interface {
	Conformation() Conformation
}

type FactorDist struct {
	Factor   float64
	Min, Max *float64 // A nil value is interpreted as 1.
}

type Feature interface {
	// Start and End indicate the position of the feature within the
	// containing Parent's coordinate system.
	Start() float64
	End() float64

	// Name returns the name of the feature.
	Name() string

	// Parent returns the reference feature on which the feature is located.
	Parent() Feature
}

type FillColorer interface {
	FillColor() color.Color
}

type Heat struct {
	Palette   []color.Color
	Underflow color.Color
	Overflow  color.Color

	DrawArea draw.Canvas

	Center       vg.Point
	Inner, Outer vg.Length

	Min, Max float64
}

type Highlight struct {
	// Base describes the arc through which the highlight should be drawn.
	Base Arc

	// Color determines the fill color of the highlight.
	Color color.Color

	// LineStyle determines the line style of the highlight.
	LineStyle draw.LineStyle

	// Inner and Outer define the inner and outer radii of the blocks.
	Inner, Outer vg.Length

	// X and Y specify rendering location when Plot is called.
	X, Y float64
}

type Label string

type Labeler interface {
	Label() string
}

type Labels struct {
	// Labels contains the set of labels. Labelers that are Features and are found
	// in the Base ArcOfer will label the identified block with the string returned
	// by their Name method.
	Labels []Labeler

	// Base describes the ring holding the features to be labeled.
	Base ArcOfer

	// TextStyle determines the text style of each label. TextStyle behaviour
	// is over-ridden if the Label describing a block is a TextStyler.
	TextStyle draw.TextStyle

	// Radius defines the inner radius of the labels.
	Radius vg.Length

	// Placement determines the text rotation and alignment. If Placement is
	// nil, DefaultPlacement is used.
	Placement TextPlacement

	// X and Y specify rendering location when Plot is called.
	X, Y float64
}

type LengthDist struct {
	Length   vg.Length
	Min, Max *float64 // A nil value is interpreted as 1.
}

type LineStyleFunc func(interface{}) draw.LineStyle

type LineStyler interface {
	LineStyle() draw.LineStyle
}

type Links struct {
	// Set holds a collection of feature pairs to render.
	Set []Pair

	// Ends holds the elements that define the end targets of the rendered ribbons.
	Ends [2]ArcOfer
	// Radii indicates the distance of the ribbon end points from the center of the plot.
	Radii [2]vg.Length

	// Bezier describes the Bézier configuration for link rendering.
	Bezier *Bezier

	// LineStyle determines the line style of each link Bézier curve. LineStyle behaviour
	// is over-ridden if the Pair describing features is a LineStyler.
	LineStyle draw.LineStyle

	// X and Y specify rendering location when Plot is called.
	X, Y float64
}

type Orientation int8

type Orienter interface {
	Orientation() Orientation
}

type Pair interface {
	Features() [2]Feature
}

type Ribbons struct {
	// Set holds a collection of feature pairs to render.
	// If the features are both Orienters this is taken into account according to Twist.
	Set []Pair

	// Ends holds the elements that define the end targets of the rendered ribbons.
	Ends [2]ArcOfer
	// Radii indicates the distance of the ribbon end points from the center of the plot.
	Radii [2]vg.Length

	// Twist indicates how feature orientation should be rendered.
	//
	// None indicates no explicit twist; ribbons are drawn so that the start
	// and end positions of each feature are connected by Bézier curves.
	//
	//  f₀.Start -arc-> f₀.End -Bézier-> f₁.End -arc-> f₁.Start -Bézier-> f₀.Start
	//
	// Flat indicates ribbons should be rendered so that ribbons do not twist; paths are
	// drawn in angle sort order with each feature's end points joined by arcs.
	//
	// Individual allows a feature pair to define its ribbon twist; feature pairs where
	// both features satisfy Orienter are rendered according to the product of their
	// orientations:
	//
	//  +1 - as if the Twist flag were set, ignoring all other flags except Reverse.
	//   0 - according to the states of all other Twist flags.
	//  -1 - as if the Flat flag were set, ignoring all other flags except Reverse.
	//
	// Twisted indicates ribbons should be rendered so that ribbons twist; paths of the
	// first feature are drawn in angle sort order and paths of the second are drawn in
	// reverse angle sort order, with each feature's end points joined by arcs.
	//
	// Reverse inverts all twist behaviour.
	//
	// If Twist has both Flat and Twisted flags set, DrawAt and Plot will panic.
	Twist Twist

	// Bezier describes the Bézier configuration for ribbon rendering.
	Bezier *Bezier

	// Color determines the fill color of each ribbon. If Color is not nil each ribbon is
	// rendered filled with the specified color, otherwise no fill is performed. This
	// behaviour is over-ridden if the feature describing the block is a FillColorer.
	Color color.Color

	// LineStyle determines the line style of each ribbon. LineStyle behaviour is over-ridden
	// for end point arcs if the feature describing an end point is a LineStyler and for
	// Bézier curves if the Pair is a LineStyler.
	LineStyle draw.LineStyle

	// X and Y specify rendering location when Plot is called.
	X, Y float64
}

type Sail struct {
	// Set holds a collection of connected features to render.
	// If the features are Orienters this is taken into account according to Twist.
	Set []Feature

	// Base holds the element that defines the end targets of the rendered sail.
	Base ArcOfer
	// Radius indicates the distance of the sail end points from the center of the plot.
	Radius vg.Length

	// Twist indicates how feature orientation should be rendered.
	//
	// None indicates no explicit twist; sail ends are drawn so that the start
	// and end positions of each feature are connected by Bézier curves.
	// Thus if features are numbered in order of their appearance along an arc:
	//
	//  f₀.Start -arc-> f₀.End -Bézier-> f₁.End -arc-> f₁.Start -Bézier-> ... f₀.Start
	//
	// Flat indicates sails should be rendered so that sail ends do not twist; paths are
	// drawn in angle sort order with each feature's end points joined by arcs.
	//
	// Individual allows a feature to define the twist of its sail end depending on its
	// orientation:
	//
	//  -1 - as if the Twist flag were set, ignoring all other flags except Reverse.
	//   0 - according to the states of all other Twist flags.
	//  +1 - as if the Flat flag were set, ignoring all other flags except Reverse.
	//
	// Twisted indicates sails should be rendered so that sail ends twist; the overall
	// progression is in angle sort order with Bézier paths drawn in angle sort order
	// and each feature's end points joined by arcs in reverse angle sort order.
	//
	// Reverse inverts all twist behaviour.
	//
	// If Twist has both Flat and Twisted flags set, DrawAt and Plot will panic.
	Twist Twist

	// Bezier describes the Bézier configuration for sail rendering.
	Bezier *Bezier

	// Color determines the fill color of each sail. If Color is not nil each sail is
	// rendered filled with the specified color, otherwise no fill is performed.
	Color color.Color

	// LineStyle determines the line style of each sail. LineStyle behaviour is over-ridden
	// for end point arcs if the feature describing an end point is a LineStyler.
	LineStyle draw.LineStyle

	// X and Y specify rendering location when Plot is called.
	X, Y float64
}

type Scale struct {
	// Set holds a collection of features to render scales for.
	Set []Feature

	// Base defines the targets of the rendered blocks.
	Base ArcOfer

	// Radius defines the radius of the axis.
	Radius vg.Length

	// LineStyle is the style of the axis line.
	LineStyle draw.LineStyle

	// Tick describes the scale's tick configuration.
	Tick TickConfig

	// Grid describes the scales grid configuration.
	Grid ScaleGrid

	X, Y float64
}

type ScaleGrid struct {
	// Inner and Outer specify the extend of radial grid lines.
	Inner, Outer vg.Length

	// LineStyle is the style of the axis line.
	LineStyle draw.LineStyle
}

type ScoreRenderer interface {
	// Configure sets up the ScoreRenderer for set-wide values.
	// The min and max parameters may be ignored by an implementation.
	Configure(ca draw.Canvas, cen vg.Point, base ArcOfer, inner, outer vg.Length, min, max float64)

	// Render renders scores across the specified arc. Rendering may be
	// performed lazily.
	Render(Arc, Scorer)

	// Close finalises the rendering. For ScoreRenderers that do not
	// render lazily, this is a no-op.
	Close()
}

type Scorer interface {
	Feature
	Scores() []float64
}

type Scores struct {
	// Set holds a collection of features to render. Scores does not
	// make any check for Scorer overlap in Set.
	Set []Scorer

	// Base defines the targets of the rendered scores.
	Base ArcOfer

	// Renderer is the rendering implementation used to represent the
	// feature sets score data.
	Renderer ScoreRenderer

	// Min and Max hold the score range.
	Min, Max float64

	// Inner and Outer define the inner and outer radii of the blocks.
	Inner, Outer vg.Length

	// X and Y specify rendering location when Plot is called.
	X, Y float64
}

type Spokes struct {
	// Set holds a collection of features to render.
	Set []Feature

	// Base holds the elements that define the targets of the rendered spokes.
	Base ArcOfer

	// LineStyle determines the line style of each spoke. LineStyle is over-ridden
	// for each spoke if the feature describing the spoke is a LineStyler.
	LineStyle draw.LineStyle

	// Inner and Outer define the inner and outer radii of the spokes.
	Inner, Outer vg.Length

	// X and Y specify rendering location when Plot is called.
	X, Y float64
}

type TextPlacement func(Angle) (rot Angle, xadjust, yadjust float64)

type TextStyler interface {
	TextStyle() draw.TextStyle
}

type TickConfig struct {
	// Label is the TextStyle on the tick labels.
	Label draw.TextStyle

	// LineStyle is the LineStyle of the tick lines.
	LineStyle draw.LineStyle

	// Placement determines the text rotation and alignment.
	// If Placement is nil, DefaultPlacement is used.
	Placement TextPlacement

	// Length is the length of a major tick mark.
	// Minor tick marks are half of the length of major
	// tick marks.
	Length vg.Length

	// Marker returns the tick marks. Any tick marks
	// returned by the Marker function that are not in
	// range of the axis are not drawn.
	Marker plot.Ticker
}

type Trace struct {
	// LineStyles determines the lines style for each trace.
	LineStyles []draw.LineStyle

	// Join specifies whether adjacent features should be joined with radial lines.
	// It is overridden by the returned value of JoinTrace if the Scorer is a TraceJoiner.
	Join bool

	Base ArcOfer

	DrawArea draw.Canvas

	Center       vg.Point
	Inner, Outer vg.Length

	Min, Max float64

	// Axis represents a radial axis configuration
	Axis *Axis
	// contains filtered or unexported fields
}

type TraceJoiner interface {
	// JoinTrace returns whether the ith score value should be part of a joined trace.
	JoinTrace(i int) bool
}

type Twist uint

type XYer interface {
	XY() (x, y float64)
}