Graphics -- Graphics

Description

This package provides graphic primitives and functions to turn them into pictures in different formats. The formats supported include svg and pgf/tikz.

Authors

Baptiste Calmes
Viktor Petrov

Version

This documentation describes version 0.3 of Graphics.

Citation

If you have used this package in your research, please cite it as follows:

@misc{GraphicsSource,
  title = {{Graphics: create graphics. Version~0.3}},
  author = {Baptiste Calmes and Viktor Petrov},
  howpublished = {A \emph{Macaulay2} package available at
    \url{https://github.com/Macaulay2/M2/tree/master/M2/Macaulay2/packages}}
}

Exports

Types
- Circle -- the class of a circle in a 2D space
- FormattedGraphicPrimitives -- the class of lists of graphic primitives together with formatting options
- GraphicPrimitive -- the class of all graphic primitives
- Picture -- the class of pictures containing several FormattedGraphicPrimitives
- Point2D -- the class of a point in a 2D space
- Point3D -- the class of a point in a 3D space
- Polygon2D -- the class of a polygon in a 2D space
- Polygon3D -- the class of a polygon in a 3D space
- Segment2D -- the class of a line segment in a 2D space
- Segment3D -- the class of a line segment in a 3D space
- Sphere -- the class of a sphere in a 3D space
- TextTag -- the class of a text tag
Functions and commands
- circle -- create a circle from a point and a radius
- defaultSVGOpening -- the default SVG opening
- formatGraphicPrimitives -- create a FormattedGraphicPrimitives object
- mergeFormattedGraphicPrimitives -- merge two lists of graphic primitives with options
- pgfObject -- create a pgf object
- pgfPicture -- create a pgf picture
- picture -- create a Picture object
- pictureZone -- find the zone in which a picture lies
- point -- create a point
- polygon -- create a polygon from a list of points
- segment -- create a line segment
- sphere -- create a sphere from a point and a radius
- svgObject -- create an SVG object
- svgPicture -- create an SVG picture
- textTag -- create a text tag at a position
- viewPicture -- view a picture in a browser
Methods
- circle(Point2D,RR) -- a circle from a center and a radius
- circle(Point2D,ZZ) -- a circle from a center and a radius
- defaultSVGOpening(ZZ,ZZ) -- default SVG opening for a picture of a given size
- formatGraphicPrimitives(BasicList,HashTable) -- create a formatted graphic primitive object
- mergeFormattedGraphicPrimitives(FormattedGraphicPrimitives,FormattedGraphicPrimitives) -- merge two lists of graphic primitives with options
- pgfObject(Circle,HashTable) -- create the string describing a circle in pgf
- pgfObject(FormattedGraphicPrimitives) -- create the string describing a series of graphic primitives in pgf
- pgfObject(Picture) -- create the string describing a series of graphic primitives in pgf
- pgfObject(Point2D,HashTable) -- create the string describing a point in pgf
- pgfObject(Polygon2D,HashTable) -- create the string describing a circle in pgf
- pgfObject(Segment2D,HashTable) -- create the string describing a line segment in pgf
- pgfObject(TextTag,HashTable) -- create the string describing a circle in pgf
- pgfPicture(Picture) -- create a pgf picture from a Picture object
- pgfPicture(Picture,HashTable) -- create a pgf picture from a Picture object with some options
- pgfPicture(Picture,HashTable,String) -- create a pgf picture from a Picture object with options and store it in a file
- pgfPicture(Picture,String) -- create a pgf picture from a Picture object and store it in a file
- picture(BasicList) -- create a picture object
- pictureZone(Circle) -- find the zone that contains the circle
- pictureZone(FormattedGraphicPrimitives) -- find the zone that contains the whole list of graphic primitive
- pictureZone(Picture) -- find the zone that contains the whole picture
- pictureZone(Point2D) -- find the zone that contains the point
- pictureZone(Point3D) -- find the zone that contains the point
- pictureZone(Polygon2D) -- find the zone that contains the polygon
- pictureZone(Polygon3D) -- find the zone that contains the polygon
- pictureZone(Segment2D) -- find the zone that contains the line segment
- pictureZone(Segment3D) -- find the zone that contains the line segment
- pictureZone(Sphere) -- find the zone that contains the sphere
- pictureZone(TextTag) -- find the zone that contains the tag
- point(RR,RR) -- a point from two coordinates
- point(RR,RR,RR) -- a point from three coordinates
- point(ZZ,ZZ) -- a point from two coordinates
- point(ZZ,ZZ,ZZ) -- a point from three coordinates
- polygon(List) -- a polygon from a list of points
- segment(Point2D,Point2D) -- a line segment from two points
- segment(Point3D,Point3D) -- a line segment from two points
- sphere(Point3D,RR) -- a sphere from a center and a radius
- sphere(Point3D,ZZ) -- a sphere from a center and a radius
- svgObject(Circle,HashTable) -- create the string describing a circle in SVG
- svgObject(FormattedGraphicPrimitives) -- create a string describing in SVG a list of formatted graphic primitive object
- svgObject(Picture) -- create a string describing the picture in SVG
- svgObject(Point2D,HashTable) -- create the string describing a point in SVG
- svgObject(Polygon2D,HashTable) -- create the string describing a circle in SVG
- svgObject(Segment2D,HashTable) -- create the string describing a line segment in SVG
- svgObject(TextTag,HashTable) -- create the string describing a circle in SVG
- svgPicture(Picture) -- create an SVG picture from a Picture object
- svgPicture(Picture,String) -- create an SVG picture from a Picture object and store it in a file
- svgPicture(Picture,ZZ,ZZ) -- create an SVG picture from a Picture object
- svgPicture(Picture,ZZ,ZZ,String) -- create an SVG picture from a Picture object and store it in a file
- textTag(Point2D,String) -- a text tag at a position
- textTag(Point3D,String) -- a text tag at a position
- viewPicture(String) -- view a Picture in a browser
Mutable symbols
- defaultPGFOptions -- the default pgf options
- defaultPGFValues -- the default pgf values
- defaultSVGClosing -- the default SVG closing
- defaultSVGHeading -- the default SVG heading
- defaultSVGOptions -- the default SVG options
- defaultSVGValues -- the default SVG values of coordinates
- possiblePGFOptions -- the possible pgf options
- possibleSVGOptions -- the possible SVG options
Other things
- defaultPGFOptions -- the default pgf options
- defaultPGFValues -- the default pgf values
- defaultSVGClosing -- the default SVG closing
- defaultSVGHeading -- the default SVG heading
- defaultSVGOptions -- the default SVG options
- defaultSVGValues -- the default SVG values of coordinates
- possiblePGFOptions -- the possible pgf options
- possibleSVGOptions -- the possible SVG options

For the programmer

The object Graphics is a package, defined in Graphics.m2.

The source of this document is in Graphics.m2:547:0.