Safe Haskell	Safe
Language	Haskell2010

Graphics.Rendering.MiniTypeset.Box

Contents

Quads
Boxes
Absolute boxes
Concatenating boxes
Overlay boxes
Subscripts and superscripts
Above and below
Fraction
delimiters

Description

Boxes are rectangular shapes used for layouting. They are 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.

Synopsis

data Quad = Quad {
- quadTopLeft :: !(Double, Double)
- quadBotRight :: !(Double, Double)
}
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
quadsLUB :: [Quad] -> Quad
ofsLUB :: (Pos, Quad) -> (Pos, Quad) -> Quad
marginQuad :: Margin -> Quad -> Quad
data Box = Box {
- boxInnerSize :: !(Double, Double)
- boxOuterQuad :: !Quad
- boxBoundingQuad :: !Quad
- boxGapQuad :: !Quad
}
boxInnerQuad :: Box -> Quad
boxInnerWidth :: Box -> Double
boxInnerHeight :: Box -> Double
emptyBox :: Box
shiftBox :: Pos -> Box -> Box
boxSelectQuad :: WhichQuad -> Box -> Quad
data WhichQuad
- = InnerQuad
- | OuterQuad
- | BoundingQuad
- | GapQuad
realignBox :: WhichQuad -> Box -> (Pos, Box)
trimBox :: Box -> Box
data AbsBox = AbsBox {
- _aboxOffset :: !Pos
- _aboxRelBox :: !Box
}
absboxInnerQuad :: AbsBox -> Quad
absboxOuterQuad :: AbsBox -> Quad
absboxBoundingQuad :: AbsBox -> Quad
absboxGapQuad :: AbsBox -> Quad
absboxSelectQuad :: WhichQuad -> AbsBox -> Quad
hcatBox :: VAlign -> Box -> Box -> (Box, (Pos, Pos))
vcatBox :: HAlign -> Box -> Box -> (Box, (Pos, Pos))
hcatBox2 :: VAlign -> Box -> Box -> (Box, (AbsBox, AbsBox))
vcatBox2 :: HAlign -> Box -> Box -> (Box, (AbsBox, AbsBox))
hcatBoxes :: VAlign -> [Box] -> (Box, [AbsBox])
vcatBoxes :: HAlign -> [Box] -> (Box, [AbsBox])
overlayBox :: HAlign -> VAlign -> Box -> Box -> (Box, (Pos, Pos))
overlayBox2 :: HAlign -> VAlign -> Box -> Box -> (Box, (AbsBox, AbsBox))
overlayBoxes :: HAlign -> VAlign -> [Box] -> (Box, [AbsBox])
subSupScriptBox :: Box -> (Double, Box) -> (Double, Box) -> (Box, (Pos, Pos))
aboveBelowBox :: Box -> (Pos, Box) -> (Pos, Box) -> (Box, (Pos, Pos))
fractionBox :: Double -> Box -> Box -> (Box, (Pos, Pos))
delimiterBox :: (Box, Box, Box) -> [Box] -> (Box, [Pos])
interleave :: [a] -> [a] -> [a]
odds :: [a] -> [a]
evens :: [a] -> [a]

Quads

data Quad Source #

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 Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.Box Methods (==) :: Quad -> Quad -> Bool # (/=) :: Quad -> Quad -> Bool #
Show Quad Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.Box Methods showsPrec :: Int -> Quad -> ShowS # show :: Quad -> String # showList :: [Quad] -> ShowS #
Semigroup Quad Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.Box Methods (<>) :: Quad -> Quad -> Quad # sconcat :: NonEmpty Quad -> Quad # stimes :: Integral b => b -> Quad -> Quad #
Monoid Quad Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.Box Methods mempty :: Quad # mappend :: Quad -> Quad -> Quad # mconcat :: [Quad] -> Quad #
Translate Quad Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.Box Methods translate :: Pos -> Quad -> Quad Source #

quadTopRight :: Quad -> (Double, Double) Source #

quadBotLeft :: Quad -> (Double, Double) Source #

quadL :: Quad -> Double Source #

quadR :: Quad -> Double Source #

quadT :: Quad -> Double Source #

quadB :: Quad -> Double Source #

quadWidth :: Quad -> Double Source #

quadHeight :: Quad -> Double Source #

quadSize :: Quad -> (Double, Double) Source #

zeroQuad :: Quad Source #

quadLUB :: Quad -> Quad -> Quad Source #

Least upper bounding quad

quadsLUB :: [Quad] -> Quad Source #

Because it really should be a semigroup and not a monoid, it's important that it's not implemented with foldl..

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

marginQuad :: Margin -> Quad -> Quad Source #

Extend a quad with margins

Boxes

data Box Source #

A (relative) box

Constructors

Box
Fields boxInnerSize :: !(Double, Double) boxOuterQuad :: !Quad boxBoundingQuad :: !Quad boxGapQuad :: !Quad

Instances

Show Box Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.Box Methods showsPrec :: Int -> Box -> ShowS # show :: Box -> String # showList :: [Box] -> ShowS #

boxInnerQuad :: Box -> Quad Source #

boxInnerWidth :: Box -> Double Source #

boxInnerHeight :: Box -> Double Source #

emptyBox :: Box Source #

shiftBox :: Pos -> Box -> Box Source #

Translates the quads relative to the inner quad.

boxSelectQuad :: WhichQuad -> Box -> Quad Source #

data WhichQuad Source #

Enumerating the four different quads in a Box

Constructors

InnerQuad
OuterQuad
BoundingQuad
GapQuad

Instances

Eq WhichQuad Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.Box Methods (==) :: WhichQuad -> WhichQuad -> Bool # (/=) :: WhichQuad -> WhichQuad -> Bool #
Ord WhichQuad Source #
Instance details 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 Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.Box Methods showsPrec :: Int -> WhichQuad -> ShowS # show :: WhichQuad -> String # showList :: [WhichQuad] -> ShowS #

realignBox :: WhichQuad -> Box -> (Pos, Box) Source #

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

trimBox :: Box -> Box Source #

Replace the outer and gap boxes by the bounding box

Absolute boxes

data AbsBox Source #

An absolute box

Constructors

AbsBox
Fields _aboxOffset :: !Pos _aboxRelBox :: !Box

Instances

Show AbsBox Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.Box Methods showsPrec :: Int -> AbsBox -> ShowS # show :: AbsBox -> String # showList :: [AbsBox] -> ShowS #
Translate AbsBox Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.Box Methods translate :: Pos -> AbsBox -> AbsBox Source #

absboxInnerQuad :: AbsBox -> Quad Source #

absboxOuterQuad :: AbsBox -> Quad Source #

absboxBoundingQuad :: AbsBox -> Quad Source #

absboxGapQuad :: AbsBox -> Quad Source #

absboxSelectQuad :: WhichQuad -> AbsBox -> Quad Source #

Concatenating boxes

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

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)) Source #

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)) Source #

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

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

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