Cryville.EEW.Unity/Assets/Plugins/Cryville.EEW.Map.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Cryville.EEW.Map</name>
    </assembly>
    <members>
        <member name="T:Cryville.EEW.Map.EmptyMapGeneratorContext">
            <summary>
            An empty <see cref="T:Cryville.EEW.Map.IMapGeneratorContext" />.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.EmptyMapGeneratorContext.Instance">
            <summary>
            A shared instance of the <see cref="T:Cryville.EEW.Map.EmptyMapGeneratorContext" /> class.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.EmptyMapGeneratorContext.UseContinuousColor">
            <inheritdoc />
        </member>
        <member name="P:Cryville.EEW.Map.EmptyMapGeneratorContext.ColorScheme">
            <inheritdoc />
        </member>
        <member name="P:Cryville.EEW.Map.EmptyMapGeneratorContext.BorderColorScheme">
            <inheritdoc />
        </member>
        <member name="P:Cryville.EEW.Map.EmptyMapGeneratorContext.TextColorScheme">
            <inheritdoc />
        </member>
        <member name="T:Cryville.EEW.Map.GeoJSONMapUtils">
            <summary>
            Contains <see langword="static" /> utility methods that extracts coordinates from GeoJSON objects.
            </summary>
        </member>
        <member name="M:Cryville.EEW.Map.GeoJSONMapUtils.ToPoint(Cryville.EEW.Models.GeoJSON.Position)">
            <summary>
            Extracts coordinates from an instance of the <see cref="T:Cryville.EEW.Models.GeoJSON.Position" /> struct.
            </summary>
            <param name="v">The position.</param>
            <returns>The coordinates.</returns>
        </member>
        <member name="M:Cryville.EEW.Map.GeoJSONMapUtils.ToLine(Cryville.EEW.Models.GeoJSON.Position[])">
            <summary>
            Extracts coordinates from an array of instances of the <see cref="T:Cryville.EEW.Models.GeoJSON.Position" /> struct.
            </summary>
            <param name="v">the position array.</param>
            <returns>The coordinates.</returns>
        </member>
        <member name="M:Cryville.EEW.Map.GeoJSONMapUtils.ToLine(Cryville.EEW.Models.GeoJSON.LineString)">
            <summary>
            Extracts coordinates from an instance of the <see cref="T:Cryville.EEW.Models.GeoJSON.LineString" /> class.
            </summary>
            <param name="v">The line string.</param>
            <returns>The coordinates.</returns>
        </member>
        <member name="M:Cryville.EEW.Map.GeoJSONMapUtils.ToMultiLine(Cryville.EEW.Models.GeoJSON.Geometry)">
            <summary>
            Extracts coordinates from a line geometry.
            </summary>
            <param name="v">The line geometry.</param>
            <returns>The coordinates.</returns>
            <exception cref="T:System.ArgumentException"><paramref name="v" /> is not a line geometry.</exception>
        </member>
        <member name="M:Cryville.EEW.Map.GeoJSONMapUtils.ToPolygon(Cryville.EEW.Models.GeoJSON.Position[][])">
            <summary>
            Extracts coordinates from an array of instances of arrays of instances of the <see cref="T:Cryville.EEW.Models.GeoJSON.Position" /> struct.
            </summary>
            <param name="v">The position array.</param>
            <returns>The coordinates.</returns>
        </member>
        <member name="M:Cryville.EEW.Map.GeoJSONMapUtils.ToPolygon(Cryville.EEW.Models.GeoJSON.Polygon)">
            <summary>
            Extracts coordinates from an instance of the <see cref="T:Cryville.EEW.Models.GeoJSON.Polygon" /> class.
            </summary>
            <param name="v">The polygon.</param>
            <returns>The coordinates.</returns>
        </member>
        <member name="M:Cryville.EEW.Map.GeoJSONMapUtils.ToMultiPolygon(Cryville.EEW.Models.GeoJSON.Geometry)">
            <summary>
            Extracts coordinates from a polygon geometry.
            </summary>
            <param name="v">The polygon geometry.</param>
            <returns>The coordinates.</returns>
            <exception cref="T:System.ArgumentException"><paramref name="v" /> is not a polygon geometry.</exception>
        </member>
        <member name="T:Cryville.EEW.Map.IMapGeneratorContext">
            <summary>
            Represents a context used in map view generators.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.IMapGeneratorContext.UseContinuousColor">
            <summary>
            Whether to use continuous color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.IMapGeneratorContext.ColorScheme">
            <summary>
            The color scheme.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.IMapGeneratorContext.BorderColorScheme">
            <summary>
            The border color scheme.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.IMapGeneratorContext.TextColorScheme">
            <summary>
            The text color scheme.
            </summary>
        </member>
        <member name="T:Cryville.EEW.Map.ColorMask">
            <summary>
            Specifies what colors of the element are to be set.
            </summary>
        </member>
        <member name="F:Cryville.EEW.Map.ColorMask.None">
            <summary>
            None.
            </summary>
        </member>
        <member name="F:Cryville.EEW.Map.ColorMask.Fill">
            <summary>
            Fill color.
            </summary>
        </member>
        <member name="F:Cryville.EEW.Map.ColorMask.Border">
            <summary>
            Border color.
            </summary>
        </member>
        <member name="F:Cryville.EEW.Map.ColorMask.Text">
            <summary>
            Text color.
            </summary>
        </member>
        <member name="T:Cryville.EEW.Map.MapElement">
            <summary>
            A map element.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.MapElement.MaxScale">
            <summary>
            The maximum scale of the map beyond which the element no longer keeps its stroke width, but instead scales its strokes with the scale of the map.
            </summary>
        </member>
        <member name="M:Cryville.EEW.Map.MapElement.SetColor(Cryville.EEW.Map.IMapGeneratorContext,Cryville.EEW.Report.ReportViewModelPropertyType,System.IConvertible,Cryville.EEW.Map.ColorMask)">
            <summary>
            Sets the color of the element based on a map generator context and a property.
            </summary>
            <param name="context">The map generator context.</param>
            <param name="type">The type of the property.</param>
            <param name="value">The value of the property.</param>
            <param name="mask">A mask that specifies what colors of the element are to be set.</param>
            <returns>The current instance.</returns>
        </member>
        <member name="M:Cryville.EEW.Map.MapElement.SetColor(Cryville.EEW.Map.IMapGeneratorContext,System.Collections.Generic.IEnumerable{System.ValueTuple{Cryville.EEW.Report.ReportViewModelPropertyType,System.IConvertible}},Cryville.EEW.Map.ColorMask)">
            <summary>
            Sets the color of the element based on a map generator context and a set of properties.
            </summary>
            <param name="context">The map generator context.</param>
            <param name="props">The properties.</param>
            <param name="mask">A mask that specifies what colors of the element are to be set.</param>
            <returns>The current instance.</returns>
        </member>
        <member name="T:Cryville.EEW.Map.GroupElement">
            <summary>
            A map element that groups a collection of children map elements.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.GroupElement.Elements">
            <summary>
            The children map elements.
            </summary>
        </member>
        <member name="T:Cryville.EEW.Map.MaskedGroupElement">
            <summary>
            A group element that masks its children with specified masks.
            </summary>
            <param name="Masks">The masks.</param>
        </member>
        <member name="M:Cryville.EEW.Map.MaskedGroupElement.#ctor(System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{System.Drawing.PointF}}})">
            <summary>
            A group element that masks its children with specified masks.
            </summary>
            <param name="Masks">The masks.</param>
        </member>
        <member name="P:Cryville.EEW.Map.MaskedGroupElement.Masks">
            <summary>The masks.</summary>
        </member>
        <member name="T:Cryville.EEW.Map.OngoingGroupElement">
            <summary>
            A group element that represents an ongoing event.
            </summary>
            <param name="BlinkingPeriod">The blinking period of the elements in seconds.</param>
        </member>
        <member name="M:Cryville.EEW.Map.OngoingGroupElement.#ctor(System.Single)">
            <summary>
            A group element that represents an ongoing event.
            </summary>
            <param name="BlinkingPeriod">The blinking period of the elements in seconds.</param>
        </member>
        <member name="P:Cryville.EEW.Map.OngoingGroupElement.BlinkingPeriod">
            <summary>The blinking period of the elements in seconds.</summary>
        </member>
        <member name="T:Cryville.EEW.Map.HypocenterElement">
            <summary>
            A map element that represents a hypocenter.
            </summary>
            <param name="Location">The location of the hypocenter.</param>
        </member>
        <member name="M:Cryville.EEW.Map.HypocenterElement.#ctor(System.Drawing.PointF)">
            <summary>
            A map element that represents a hypocenter.
            </summary>
            <param name="Location">The location of the hypocenter.</param>
        </member>
        <member name="P:Cryville.EEW.Map.HypocenterElement.Location">
            <summary>The location of the hypocenter.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.HypocenterElement.FillColor">
            <summary>
            The fill color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.HypocenterElement.BorderColor">
            <summary>
            The border color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.HypocenterElement.IsLowQuality">
            <summary>
            Whether the hypocenter is of low quality.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.HypocenterElement.Size">
            <summary>
            The size of the hypocenter icon.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.HypocenterElement.Width">
            <summary>
            The width of the hypocenter icon.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.HypocenterElement.StrokeWidth">
            <summary>
            The stroke width of the hypocenter icon.
            </summary>
        </member>
        <member name="T:Cryville.EEW.Map.TsunamiHeightElement">
            <summary>
            A map element that represents the tsunami height at a location.
            </summary>
            <param name="Location">The location.</param>
            <param name="Height">The tsunami height.</param>
        </member>
        <member name="M:Cryville.EEW.Map.TsunamiHeightElement.#ctor(System.Drawing.PointF,System.Single)">
            <summary>
            A map element that represents the tsunami height at a location.
            </summary>
            <param name="Location">The location.</param>
            <param name="Height">The tsunami height.</param>
        </member>
        <member name="P:Cryville.EEW.Map.TsunamiHeightElement.Location">
            <summary>The location.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.TsunamiHeightElement.Height">
            <summary>The tsunami height.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.TsunamiHeightElement.FillColor">
            <summary>
            The fill color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.TsunamiHeightElement.BorderColor">
            <summary>
            The border color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.TsunamiHeightElement.IsRising">
            <summary>
            Whether the tsunami is rising.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.TsunamiHeightElement.IsOutOfRange">
            <summary>
            Whether the tsunami is out of the instrumental range.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.TsunamiHeightElement.IsMissing">
            <summary>
            Whether the tsunami height data is missing.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.TsunamiHeightElement.Width">
            <summary>
            The width of the tsunami height bar.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.TsunamiHeightElement.StrokeWidth">
            <summary>
            The stroke width of the tsunami height bar.
            </summary>
        </member>
        <member name="T:Cryville.EEW.Map.WaveCircleElement">
            <summary>
            A map element that represents a set of seismic wave circles of an earthquake.
            </summary>
            <param name="HypocenterLocation">The location of the hypocenter.</param>
            <param name="OriginTime">The origin time of the earthquake in UTC.</param>
            <param name="Depth">The hypocenter depth.</param>
        </member>
        <member name="M:Cryville.EEW.Map.WaveCircleElement.#ctor(System.Drawing.PointF,System.DateTime,System.Single)">
            <summary>
            A map element that represents a set of seismic wave circles of an earthquake.
            </summary>
            <param name="HypocenterLocation">The location of the hypocenter.</param>
            <param name="OriginTime">The origin time of the earthquake in UTC.</param>
            <param name="Depth">The hypocenter depth.</param>
        </member>
        <member name="P:Cryville.EEW.Map.WaveCircleElement.HypocenterLocation">
            <summary>The location of the hypocenter.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.WaveCircleElement.OriginTime">
            <summary>The origin time of the earthquake in UTC.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.WaveCircleElement.Depth">
            <summary>The hypocenter depth.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.WaveCircleElement.ReportTime">
            <summary>
            The time when the earthquake is reported in UTC.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.WaveCircleElement.StrokeWidth">
            <summary>
            The stroke width of the wave circles.
            </summary>
        </member>
        <member name="T:Cryville.EEW.Map.PointElement">
            <summary>
            A map element that represents a point.
            </summary>
            <param name="Location">The location of the point.</param>
        </member>
        <member name="M:Cryville.EEW.Map.PointElement.#ctor(System.Drawing.PointF)">
            <summary>
            A map element that represents a point.
            </summary>
            <param name="Location">The location of the point.</param>
        </member>
        <member name="P:Cryville.EEW.Map.PointElement.Location">
            <summary>The location of the point.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.PointElement.FillColor">
            <summary>
            The fill color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.PointElement.Size">
            <summary>
            The size of the point.
            </summary>
        </member>
        <member name="T:Cryville.EEW.Map.LabeledPointElement">
            <summary>
            A map element that represents a labeled point.
            </summary>
            <param name="Location">The location of the point.</param>
            <param name="Text">The text of the label.</param>
        </member>
        <member name="M:Cryville.EEW.Map.LabeledPointElement.#ctor(System.Drawing.PointF,System.String)">
            <summary>
            A map element that represents a labeled point.
            </summary>
            <param name="Location">The location of the point.</param>
            <param name="Text">The text of the label.</param>
        </member>
        <member name="P:Cryville.EEW.Map.LabeledPointElement.Location">
            <summary>The location of the point.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.LabeledPointElement.Text">
            <summary>The text of the label.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.LabeledPointElement.FillColor">
            <summary>
            The fill color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.LabeledPointElement.BorderColor">
            <summary>
            The border color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.LabeledPointElement.TextColor">
            <summary>
            The text color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.LabeledPointElement.IsAreaLabel">
            <summary>
            Whether the label represents an area.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.LabeledPointElement.Size">
            <summary>
            The size of the label.
            </summary>
        </member>
        <member name="T:Cryville.EEW.Map.MultiLineElement">
            <summary>
            A map element that represents multiple lines.
            </summary>
            <param name="Lines">The coordinates of the lines.</param>
        </member>
        <member name="M:Cryville.EEW.Map.MultiLineElement.#ctor(System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{System.Drawing.PointF}})">
            <summary>
            A map element that represents multiple lines.
            </summary>
            <param name="Lines">The coordinates of the lines.</param>
        </member>
        <member name="P:Cryville.EEW.Map.MultiLineElement.Lines">
            <summary>The coordinates of the lines.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.MultiLineElement.BorderColor">
            <summary>
            The border color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.MultiLineElement.StrokeWidth">
            <summary>
            The stroke width.
            </summary>
        </member>
        <member name="T:Cryville.EEW.Map.MultiPolygonElement">
            <summary>
            A map element that represents multiple polygons.
            </summary>
            <param name="Polygons">The coordinates of the polygons.</param>
        </member>
        <member name="M:Cryville.EEW.Map.MultiPolygonElement.#ctor(System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{System.Drawing.PointF}}})">
            <summary>
            A map element that represents multiple polygons.
            </summary>
            <param name="Polygons">The coordinates of the polygons.</param>
        </member>
        <member name="P:Cryville.EEW.Map.MultiPolygonElement.Polygons">
            <summary>The coordinates of the polygons.</summary>
        </member>
        <member name="P:Cryville.EEW.Map.MultiPolygonElement.FillColor">
            <summary>
            The fill color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.MultiPolygonElement.BorderColor">
            <summary>
            The border color.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.MultiPolygonElement.HasLabel">
            <summary>
            Whether the element has an associated instance of the <see cref="T:Cryville.EEW.Map.LabeledPointElement" /> class.
            </summary>
        </member>
        <member name="P:Cryville.EEW.Map.MultiPolygonElement.StrokeWidth">
            <summary>
            The stroke width.
            </summary>
        </member>
    </members>
</doc>