Copyright	Anthony Wang 2021
License	MIT
Maintainer	anthony.y.wang.math@gmail.com
Safe Haskell	Safe-Inferred
Language	Haskell2010

TikzObjects

Description

TikzObjects defines data structures to represent objects such as coordinates and paths. See the tikzpgf manual for more details.

Synopsis

class ShowLatex a where
- showLatex :: a -> String
data TikzCoordinate
- = Canvas {
  - canvas_x :: !Float
  - canvas_y :: !Float
  }
- | NamedCoordinate {
  - coord_name :: !String
  }
data TikzPathOperation
- = PathOpMoveTo {
  - pop_move_to_coord :: !TikzCoordinate
  }
- | PathOpLineTo {
  - pop_line_to_coord :: !TikzCoordinate
  }
- | PathOpVertHorz {
  - pop_vert_horz_coord :: !TikzCoordinate
  }
- | PathOpHorzVert {
  - pop_horz_vert_coord :: !TikzCoordinate
  }
- | PathOpCurveToOneControl {
  - pop_curve_to_1c_coord :: !TikzCoordinate
  - pop_curve_to_1c_control :: !TikzCoordinate
  }
- | PathOpCurveToTwoControls {
  }
- | PathOpOption {
  - pop_option_string :: !String
  }
- | PathOpScopedOption {
  - pop_scoped_option_string :: !String
  - pop_scoped_option_scope :: !TikzPath
  }
- | PathOpCycle
- | PathOpRectangle {
  - pop_rectangle_corner :: !TikzCoordinate
  }
- | PathOpNode {
  - pop_node_options :: !String
  - pop_node_name :: !String
  - pop_node_coordinate :: !TikzCoordinate
  - pop_node_text :: !String
  }
- | PathOpCoordinate {
  - pop_coord_options :: !String
  - pop_coord_name :: !String
  - pop_coord_coordinate :: !TikzCoordinate
  }
- | PathOpRelativeNode {
  - pop_rel_node_options :: !String
  - pop_rel_node_text :: !String
  }
toNamedCoord :: TikzPathOperation -> Maybe TikzCoordinate
type TikzPath = [TikzPathOperation]
partialShowLatex :: TikzPath -> String

Documentation

class ShowLatex a where Source #

A class for data structures which can be converted into LaTeX code.

Methods

showLatex :: a -> String Source #

Instances

Instances details

ShowLatex TikzPath Source #
Instance details Defined in TikzObjects Methods showLatex :: TikzPath -> String Source #
ShowLatex TikzPathOperation Source #
Instance details Defined in TikzObjects Methods showLatex :: TikzPathOperation -> String Source #
ShowLatex TikzCoordinate Source #
Instance details Defined in TikzObjects Methods showLatex :: TikzCoordinate -> String Source #
ShowLatex TikzStringDiagram Source #
Instance details Defined in TikzStringDiagram Methods showLatex :: TikzStringDiagram -> String Source #

data TikzCoordinate Source #

Data structure representing points on a 2 dimensional TikZ canvas.

Constructors

Canvas	Specifies a point by its coordinates
Fields canvas_x :: !Float canvas_y :: !Float
NamedCoordinate	Specifies a coordinate by a name. A node or coordinate path operation can create a new named coordinate.
Fields coord_name :: !String

Instances

Instances details

Show TikzCoordinate Source #
Instance details Defined in TikzObjects Methods showsPrec :: Int -> TikzCoordinate -> ShowS # show :: TikzCoordinate -> String # showList :: [TikzCoordinate] -> ShowS #
ShowLatex TikzCoordinate Source #
Instance details Defined in TikzObjects Methods showLatex :: TikzCoordinate -> String Source #

data TikzPathOperation Source #

A data structure for specifying path operations, which are chained to create paths. See the tikz manual for details on these operations.

Constructors

PathOpMoveTo
Fields pop_move_to_coord :: !TikzCoordinate
PathOpLineTo
Fields pop_line_to_coord :: !TikzCoordinate
PathOpVertHorz
Fields pop_vert_horz_coord :: !TikzCoordinate
PathOpHorzVert
Fields pop_horz_vert_coord :: !TikzCoordinate
PathOpCurveToOneControl
Fields pop_curve_to_1c_coord :: !TikzCoordinate pop_curve_to_1c_control :: !TikzCoordinate
PathOpCurveToTwoControls
Fields pop_curve_to_2c_coord :: !TikzCoordinate pop_curve_to_2c_control1 :: !TikzCoordinate pop_curve_to_2c_control2 :: !TikzCoordinate
PathOpOption
Fields pop_option_string :: !String
PathOpScopedOption
Fields pop_scoped_option_string :: !String pop_scoped_option_scope :: !TikzPath
PathOpCycle
PathOpRectangle
Fields pop_rectangle_corner :: !TikzCoordinate
PathOpNode
Fields pop_node_options :: !String pop_node_name :: !String pop_node_coordinate :: !TikzCoordinate pop_node_text :: !String
PathOpCoordinate
Fields pop_coord_options :: !String pop_coord_name :: !String pop_coord_coordinate :: !TikzCoordinate
PathOpRelativeNode
Fields pop_rel_node_options :: !String pop_rel_node_text :: !String

Instances

Instances details

Show TikzPathOperation Source #
Instance details Defined in TikzObjects Methods showsPrec :: Int -> TikzPathOperation -> ShowS # show :: TikzPathOperation -> String # showList :: [TikzPathOperation] -> ShowS #
ShowLatex TikzPath Source #
Instance details Defined in TikzObjects Methods showLatex :: TikzPath -> String Source #
ShowLatex TikzPathOperation Source #
Instance details Defined in TikzObjects Methods showLatex :: TikzPathOperation -> String Source #

toNamedCoord :: TikzPathOperation -> Maybe TikzCoordinate Source #

If a path operation has a name, it defines a NamedCoordinate. toNamedCoord of a path operation returns Just this named coordinate for operations with names, otherwise it returns Nothing.

type TikzPath = [TikzPathOperation] Source #

A TikzPath is made by sequencing TikzPathOperations.

partialShowLatex :: TikzPath -> String Source #

A helper function used to define showLatex of a TikzPath.