Graphics.Rendering.MiniTypeset.Box

Boxes are rectangular shapes used for layouting. They consisting of several quads having a relative position to each other:

• "inner boxes" are used for aligning several boxes together
• "outer boxes" describe the logical extent
• "bounding boxes" are the bounding boxes of the actual content abstracted by the box
• "gap boxes" control the gap between boxes placed next to each other.

Relative boxes has their origin at the top-left corner of their inner box. Absolute boxes has an absolute offset.

We use screen-space coordinate system (Y increase downwards).

In case of font glyphs, the inner box has height 0, and it coincides with the base line of the glyph; while the outer box is defined by the ascent and the descent. Both have horizontal dimensions equal to the advance width.

Quads

data Quad

A quad is a rectangular region, defined by its top-left and bottom-right corner

Constructors

Quad

Fields

• quadTopLeft :: !(Double, Double)
• quadBotRight :: !(Double, Double)

Instances

Eq Quad

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

(==) :: Quad -> Quad -> Bool

(/=) :: Quad -> Quad -> Bool

Show Quad

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

showsPrec :: Int -> Quad -> ShowS

show :: Quad -> String

showList :: [Quad] -> ShowS

Semigroup Quad

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

(<>) :: Quad -> Quad -> Quad

sconcat :: NonEmpty Quad -> Quad

stimes :: Integral b => b -> Quad -> Quad

Monoid Quad

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

mempty :: Quad

mappend :: Quad -> Quad -> Quad

mconcat :: [Quad] -> Quad

Translate Quad

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

translate :: Pos -> Quad -> Quad

quadTopRight :: Quad -> (Double, Double)

quadBotLeft :: Quad -> (Double, Double)

quadL :: Quad -> Double

quadR :: Quad -> Double

quadT :: Quad -> Double

quadB :: Quad -> Double

quadWidth :: Quad -> Double

quadHeight :: Quad -> Double

quadSize :: Quad -> (Double, Double)

zeroQuad :: Quad

quadLUB :: Quad -> Quad -> Quad

Least upper bounding quad

ofsLUB :: (Pos, Quad) -> (Pos, Quad) -> Quad

marginQuad :: Margin -> Quad -> Quad

Extend a quad with margins

Boxes

data Box

A (relative) box

Constructors

Box

Fields

• boxInnerSize :: !(Double, Double)
• boxOuterQuad :: !Quad
• boxBoundingQuad :: !Quad
• boxGapQuad :: !Quad

Instances

Show Box

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

showsPrec :: Int -> Box -> ShowS

show :: Box -> String

showList :: [Box] -> ShowS

boxInnerQuad :: Box -> Quad

emptyBox :: Box

data WhichQuad

Enumerating the four different quads in a Box

Constructors

InnerQuad

OuterQuad

BoundingQuad

GapQuad

Instances

Eq WhichQuad

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

(==) :: WhichQuad -> WhichQuad -> Bool

(/=) :: WhichQuad -> WhichQuad -> Bool

Ord WhichQuad

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

compare :: WhichQuad -> WhichQuad -> Ordering

(<) :: WhichQuad -> WhichQuad -> Bool

(<=) :: WhichQuad -> WhichQuad -> Bool

(>) :: WhichQuad -> WhichQuad -> Bool

(>=) :: WhichQuad -> WhichQuad -> Bool

max :: WhichQuad -> WhichQuad -> WhichQuad

min :: WhichQuad -> WhichQuad -> WhichQuad

Show WhichQuad

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

showsPrec :: Int -> WhichQuad -> ShowS

show :: WhichQuad -> String

showList :: [WhichQuad] -> ShowS

realignBox :: WhichQuad -> Box -> Box

Replace the inner box by the given box. Since the inner box is used for alignment, this amounts to changing the alignment

data AbsBox

An absolute box

Constructors

AbsBox

Fields

• _aboxOffset :: !Pos
• _aboxRelBox :: !Box

Instances

Show AbsBox

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

showsPrec :: Int -> AbsBox -> ShowS

show :: AbsBox -> String

showList :: [AbsBox] -> ShowS

Translate AbsBox

Defined in Graphics.Rendering.MiniTypeset.Box

Methods

translate :: Pos -> AbsBox -> AbsBox

absboxInnerQuad :: AbsBox -> Quad

absboxOuterQuad :: AbsBox -> Quad

absboxBoundingQuad :: AbsBox -> Quad

absboxGapQuad :: AbsBox -> Quad

Concatenating boxes

hcatBox :: VAlign -> Box -> Box -> (Box, (Pos, Pos))

Concatantes two boxes horizontally, using the inner boxes to align them. The two positions we return are relative positions of the two boxes from the origin (top-left inner corner) of the concatenated box.

vcatBox :: HAlign -> Box -> Box -> (Box, (Pos, Pos))

Concatantes two boxes vertically, using the inner boxes to align them. The two positions we return are relative positions of the two boxes from the origin (top-left inner corner) of the concatenated box.

hcatBox2 :: VAlign -> Box -> Box -> (Box, (AbsBox, AbsBox))

vcatBox2 :: HAlign -> Box -> Box -> (Box, (AbsBox, AbsBox))

hcatBoxes :: VAlign -> [Box] -> (Box, [AbsBox])

vcatBoxes :: HAlign -> [Box] -> (Box, [AbsBox])

Overlay boxes

overlayBox :: HAlign -> VAlign -> Box -> Box -> (Box, (Pos, Pos))

Overlay two boxes (so the corners given by the alignments coincide)

overlayBox2 :: HAlign -> VAlign -> Box -> Box -> (Box, (AbsBox, AbsBox))

overlayBoxes :: HAlign -> VAlign -> [Box] -> (Box, [AbsBox])

Subscripts and superscripts

subSupScriptBox :: Box -> (Double, Box) -> (Double, Box) -> (Box, (Pos, Pos))

Subscripts/superscripts are special enough that it seems simpler to just add a specific combinator for them.

Above and below

aboveBelowBox :: Box -> (Pos, Box) -> (Pos, Box) -> (Box, (Pos, Pos))

Positions are relative!