Class: RT.Coordinates.SvgInstructions

Assembly: RT.Coordinates, Version=3.7.0.0, Culture=neutral, PublicKeyToken=null
Namespace: RT.Coordinates
Show inherited types...
Inherits from:
- object

Summary

Contains instructions to control the behavior of Structure<TCell>.Svg(SvgInstructions).

Constructors

SvgInstructions()

Creates a new instance of SvgInstructions.

Static methods

string

DrawBridge(PointD center1, PointD center2, Func<double, string> r)

Provides a default implementation for SvgInstructions.BridgeSvg.

Instance methods

string

Round(double value)

Rounds a floating-point value to a number of decimal places specified by SvgInstructions.Precision. Useful to pass into methods such as GridUtils.SvgEdgesPath(IEnumerable<Link<Vertex>>, Func<Vertex, PointD>, Func<double, string>).

Instance fields

Func<object, object, string, string>	BridgeSvg	Generates SVG code for a bridge — a connection between cells that have no edges in common. The first two parameters are the cells; the third is a default SVG path `d` attribute that can optionally be used.
string	ExtraSvg1	Provides some additional SVG code to add at the start of the file.
string	ExtraSvg2	Provides some additional SVG code to add into the file after the cell highlights (SvgInstructions.HighlightCells) but before the main grid.
string	ExtraSvg3	Provides some additional SVG code to add into the file after the main grid but before SvgInstructions.PerCellAfter.
string	ExtraSvg4	Provides some additional SVG code to add at the end of the file.
Func<object, PointD?>	GetCenter	Returns the center point for the specified cell. If this is absent or returns `null`, the cell must implement IHasSvgGeometry.
Func<object, IEnumerable<Edge>>	GetEdges	Returns a collection of edges (line segments) that make up the perimeter of the specified cell. If this is absent or returns `null`, the cell must implement IHasSvgGeometry.
Func<Link<Vertex>, IList, EdgeInfo<object>>	GetEdgeType	Returns the type of edge to draw in SVG for a particular pair of vertices. The second parameter receives a list of the cells that share the edge; this will be of runtime type `System.Collections.Generic.List<TCell>`, where `TCell` is the generic type argument used on Structure<TCell>. (see also remarks)
Func<Vertex, PointD>	GetVertexPoint	Returns the 2D point for the specified vertex.
object	HighlightCells	Paints some cells with a background color. (see also remarks)
SvgColor	HighlightColor	Specifies a default color used when highlighting cells specified by SvgInstructions.HighlightCells.
double	MarginX	Amount of space to leave on the left and right side of the grid (not including the stroke width).
double	MarginY	Amount of space to leave on the top and bottom of the grid (not including the stroke width).
Func<string, string>	OutlinePath	Generates the SVG path object for the structure’s outline (perimeter), assuming SvgInstructions.OutlineSeparate is `false`. The function is invoked once only. The function parameter is the path’s `d` attribute, describing the entirety of the outline of the structure.
Func<string, object, string>	OutlinePaths	Generates SVG path objects for each segment of the outline (perimeter), assuming SvgInstructions.OutlineSeparate is `true`. The function is invoked once for each separate edge along the perimeter. The first function parameter is the path’s `d` attribute. The second parameter is the cell the edge belongs to.
bool	OutlineSeparate	If `true`, SvgInstructions.OutlinePaths is used to render each edge of the outline (perimeter) separately. Otherwise, SvgInstructions.OutlinePath is used to render the entire outline as a single SVG path.
Func<string, string>	PassagesPath	Generates the SVG path object for passable edges between cells, assuming SvgInstructions.PassagesSeparate is `false`. The function is invoked once only. The function parameter is the path’s `d` attribute, describing the entirety of all passages in the structure.
Func<string, object, object, string>	PassagesPaths	Generates SVG path objects for passable edges between cells, assuming SvgInstructions.PassagesSeparate is `true`. The function is invoked once for each separate passable edge. The first function parameter is the path’s `d` attribute. The remaining parameters are the two cells connected by the passage, in no particular order.
bool	PassagesSeparate	If `true`, SvgInstructions.PassagesPaths is used to render each passable edge separately. Otherwise, SvgInstructions.PassagesPath is used to render all passable edges as a single SVG path.
Func<object, string>	PerCellAfter	Adds extra SVG code for every cell after the SVG for the outline and walls.
Func<object, string>	PerCellBefore	Adds extra SVG code for every cell before the SVG for the outline and walls.
int?	Precision	Specifies a number of decimal places to round every coordinate to when generating SVG paths.
string	SvgAttributes	Specifies the attributes on the main `<svg>` tag. Set this to `null` to omit the SVG tag entirely.
Func<string, string>	WallsPath	Generates the SVG path object for impassable edges (walls) between cells, assuming SvgInstructions.WallsSeparate is `false`. The function is invoked once only. The function parameter is the path’s `d` attribute, describing the entirety of all walls in the structure.
Func<string, object, object, string>	WallsPaths	Generates SVG path objects for impassable edges (walls) between cells, assuming SvgInstructions.WallsSeparate is `true`. The function is invoked once for each separate impassable edge (wall). The first function parameter is the path’s `d` attribute. The remaining parameters are the two cells on either side of the wall, in no particular order.
bool	WallsSeparate	If `true`, SvgInstructions.WallsPaths is used to render each impassable edge (wall) separately. Otherwise, SvgInstructions.WallsPath is used to render all impassable edges (walls) as a single SVG path.