class PixelPyramidShape in Tinman.Terrain.Pyramids

sealed class

PixelPyramidShape

implements

IMapShapeGeneric<PixelPyramidShape>

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<PixelPyramidShape>
value	[not-null]	The configurator object.

ToConfig

Returns the configuration value that describes this object.

public method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
implements	IConfigurable.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.

Public / Attributes

Layer

The layer of the shape.

public property	Layer { get }
type	int32
value		The shape layer.
implements	IMapShape.Layer

Remarks:

Map shapes with higher layer values are rendered on top.

Levels

The range of pyramid levels (see Levels) on which the shape shall be visible.

public property	Levels { get }
type	RangeI
value		The pyramid level range.

Remarks:

By default, the shape will be visible on all pyramid levels.

MapShape

The vector shape to render.

public property	MapShape { get }
type	IShape
value	[not-null]	The vector shape.
implements	IMapShape.MapShape

Mode

The color operation to use for combining the rasterized shape pixels with the current buffer contents.

public property	Mode { get }
type	ColorOp
value		The color operation.

Remarks:

Defaults to Blend.

Rasterizer

The shape rasterizer.

public property	Rasterizer { get }
type	IShapeRasterizer<ColorBuffer>
value		The current rasterizer or null.

Public / Constructors

For

Creates a new instance of PixelPyramidShape.

public static method	For (IShape shape, int32 layer = 0)
type	PixelPyramidShape
params	shape	[not-null]	The vector shape.
	layer		The shape layer (see Layer). Defaults to 0.
returns		[not-null]	The pixel pyramid shape.

Public / Methods

LayerSet

Sets the map shape layer (see Layer).

public method	LayerSet (int32 layer)
type	PixelPyramidShape
params	layer		The shape layer.
returns		[not-null]	The resulting map shape.
implements	IMapShapeGeneric.LayerSet

LevelFrom

Set the minimum pyramid level (see Levels).

public method	LevelFrom (int32 from)
type	PixelPyramidShape
params	from		The minimum level (inclusive).
returns		[not-null]	The resulting pixel pyramid shape.

LevelRange

Set the pyramid levels (see Levels).

public method	LevelRange (RangeI range)
type	PixelPyramidShape
params	range		The levels.
returns		[not-null]	The resulting pixel pyramid shape.

---

Set the pyramid levels (see Levels).

public method	LevelRange (int32 from, int32 to)
type	PixelPyramidShape
params	from		The minimum level (inclusive).
	to		The maximum level (inclusive).
returns		[not-null]	The resulting pixel pyramid shape.

LevelTo

Set the maximum pyramid level (see Levels).

public method	LevelTo (int32 to)
type	PixelPyramidShape
params	to		The maximum level (inclusive).
returns		[not-null]	The resulting pixel pyramid shape.

MapShapeCubemap

Converts the map shape to a cubemap, if necessary.

public method	MapShapeCubemap (float64 accuracy = 0)
type	PixelPyramidShape
params	accuracy	[>=0]	Optional accuracy to use for subdivision of edges. Given as a maximum error in the target coordinate system. Set to 0 to disable edge subdivision. Defaults to 0.
returns		[not-null]	The resulting map shape.
implements	IMapShapeGeneric.MapShapeCubemap

See also:

IShape.TransformCubemap

MapShapeSet

Sets the map shape (see MapShape).

public method	MapShapeSet (IShape shape)
type	PixelPyramidShape
params	shape		The new shape.
returns			The resulting map shape or null if shape is null.
implements	IMapShapeGeneric.MapShapeSet

MapShapeTransform

Converts the map shape to the given coordinate system.

public method	MapShapeTransform (CoordinateSystem coordSys, float64 accuracy = 0)
type	PixelPyramidShape
params	coordSys	[not-null]	The target coordinate system.
	accuracy	[>=0]	Optional accuracy to use for subdivision of edges. Given as a maximum error in the target coordinate system. Set to 0 to disable edge subdivision. Defaults to 0.
returns			The resulting map shape or null if empty.
implements	IMapShapeGeneric.MapShapeTransform

Rasterize

Sets the rasterizer (see ShapeRasterizer) to use for this shape.

public method	Rasterize (IShapeRasterizerFactory<ColorBuffer> rasterizer, ColorOp mode = ColorOp.Blend)
type	PixelPyramidShape
params	rasterizer	[not-null]	The rasterizer to use.
	mode		The color mode. Defaults to Blend.
returns		[not-null]	The resulting pixel pyramid shape.

RasterizeColorRamp

Set a rasterizer via RasterizerFactory, using the given settings.

public method	RasterizeColorRamp (IColorRamp colorRamp, int64 color = Colors.White, float64 offset = 0, float64 scale = 1, ColorOp mode = ColorOp.Blend)
type	PixelPyramidShape
params	colorRamp	[not-null]	The color ramp to use.
	color		The modulate color (see Modulate). Defaults to White.
	offset		The distance offset value (see Transform). Defaults to 0.
	scale		The distance scale factor (see Transform). Defaults to 1.
	mode		The color mode. Defaults to Blend.
returns		[not-null]	The resulting pixel pyramid shape.

RasterizeOutline

Set a rasterizer via RasterizerFactory, using the given settings and the default Outline color ramp.

public method	RasterizeOutline (int64 color = Colors.White, float64 offset = 0, float64 scale = 1, ColorOp mode = ColorOp.Blend)
type	PixelPyramidShape
params	color		The modulate color (see Modulate). Defaults to White.
	offset		The distance offset value (see Transform). Defaults to 0.
	scale		The distance scale factor (see Transform). Defaults to 1.
	mode		The color mode. Defaults to Blend.
returns		[not-null]	The resulting pixel pyramid shape.