Wumpus.Basic.Kernel.Objects.PosObject

Extended Graphic object - a rectangular positionable Image.

This graphic object has a more flexible API for positioning than other graphic objects. Rather than a LocGraphic which supports a single method of positioning at some start-point, a PosGraphic can be drawn at its center or locations on its outer rectangle.

Positionable image

data PosObject u a

A positionable "Object".

Instances

Monad (PosObject u)

Functor (PosObject u)

Applicative (PosObject u)

DrawingCtxM (PosObject u)

(Monoid a, InterpretUnit u) => Monoid (PosObject u a)

(Monoid a, InterpretUnit u) => AlignSpace (PosObject u a)

Monoid a => Align (PosObject u a)

(Monoid a, InterpretUnit u) => CatSpace (PosObject u a)

Monoid a => Concat (PosObject u a)

(Monoid a, InterpretUnit u) => ZConcat (PosObject u a)

type DPosObject a = PosObject Double a

Version of PosObject specialized to Double for the unit type.

type PosGraphic u = PosObject u (UNil u)

Version of PosObject with answer specialized to UNil.

type DPosGraphic = PosGraphic Double

Version of PosGraphic specialized to Double for the unit type.

Operations

runPosObject :: InterpretUnit u => PosObject u a -> RectAddress -> LocImage u a

Running an PosObject produces a LocImage.

runPosObjectBBox :: InterpretUnit u => PosObject u a -> RectAddress -> LocImage u (BoundingBox u)

Run a PosObject producing a LocImage (BoundingBox u).

makePosObject :: InterpretUnit u => Query u (Orientation u) -> LocImage u a -> PosObject u a

makePosObject : object_pos * loc_image -> PosObject

Create a PosObject from an Orientation describing how it is orientated within a border rectangle and a LocImage that draws it.

This is the primary constructor for PosObjects. Because the PosObject type is considered as a specialized object it does not have the range of functions of LocImage or LocThetaImage.

emptyPosObject :: (Monoid a, InterpretUnit u) => PosObject u a

emptyPosObject : PosObject

Build an empty PosGraphicObject.

elaboratePosObject :: (Fractional u, Ord u, InterpretUnit u) => ZDeco -> RectAddress -> LocGraphic u -> PosObject u a -> PosObject u a

decoratePosObject :: InterpretUnit u => ZDeco -> (Orientation u -> LocGraphic u) -> PosObject u a -> PosObject u a

extendPosObject :: InterpretUnit u => u -> u -> u -> u -> PosObject u a -> PosObject u a

Extend the orientation.

mapOrientation :: InterpretUnit u => (Orientation u -> Orientation u) -> PosObject u a -> PosObject u a

Note - this is a bad API, it would be better to have padders and fillers and not expose the orientation directly.

illustratePosObject :: InterpretUnit u => PosObject u a -> LocGraphic u

Illustrate a PosObject by super-imposing its Orientation.

This turns the PosObject into a LocImage drawn at the locus of the PosObject.

posChar :: InterpretUnit u => Char -> PosGraphic u

Note - no margins are added to the containing rectangle.

To get a Char with margins, use posText instead:

 posText ['1']

posEscChar :: InterpretUnit u => EscapedChar -> PosGraphic u

posCharUpright :: InterpretUnit u => Char -> PosGraphic u

posEscCharUpright :: InterpretUnit u => EscapedChar -> PosGraphic u

posCharPrim :: InterpretUnit u => Either Char EscapedChar -> PosGraphic u

Primtive builder that does not add margins.

posText :: InterpretUnit u => String -> PosGraphic u

posEscText :: InterpretUnit u => EscapedText -> PosGraphic u

posTextUpright :: InterpretUnit u => String -> PosGraphic u

posEscTextUpright :: InterpretUnit u => EscapedText -> PosGraphic u

posTextPrim :: InterpretUnit u => Either String EscapedText -> PosGraphic u

Primtive builder that does not add margins.

multilinePosText :: (Fractional u, InterpretUnit u) => VAlign -> String -> PosGraphic u

multilinePosEscText :: (Fractional u, InterpretUnit u) => VAlign -> [EscapedText] -> PosGraphic u

rposText :: (Real u, Floating u, InterpretUnit u) => Radian -> String -> PosGraphic u

Note - for single line text.

rposEscText :: (Real u, Floating u, InterpretUnit u) => Radian -> EscapedText -> PosGraphic u

Note - for single line text.

posHKernText :: InterpretUnit u => [KernChar u] -> PosGraphic u

monospaceText :: InterpretUnit u => Query u u -> String -> PosGraphic u

The query should retrieve the width of one char.

monospaceEscText :: InterpretUnit u => Query u u -> EscapedText -> PosGraphic u

The query should retrieve the width of one char.