Parasol Framework Manual

Extends the Vector class with support for spiral path generation.

The VectorSpiral class generates spiral paths that extend from a central point.

Structure

The VectorSpiral class consists of the following fields:

Access	Name	Type	Comment
	CenterX	DOUBLE	The horizontal center of the spiral. Expressed as a fixed or scaled coordinate.
The horizontal center of the spiral is defined here as either a fixed or scaled value.
	CenterY	DOUBLE	The vertical center of the spiral. Expressed as a fixed or scaled coordinate.
The vertical center of the spiral is defined here as either a fixed or scaled value.
	Height	DOUBLE	The height (vertical diameter) of the spiral.
The height of the spiral is expressed as `Radius * 2.0`.
	LoopLimit	DOUBLE	Used to limit the number of loops produced by the spiral path generator.
The LoopLimit can be used to impose a limit on the total number of loops that are performed by the spiral path generator. It can be used as an alternative to, or conjunction with the Radius value to limit the final spiral size. If the LoopLimit is not set, the Radius will take precedence.
	Offset	DOUBLE	Offset the starting coordinate of the spiral by this value.
The generation of a spiral's path can be offset by specifying a positive value in the Offset field. By default the Offset is set to zero.
	PathLength	INT	Calibrates the user agent's distance-along-a-path calculations with that of the author.
The author's computation of the total length of the path, in user units. This value is used to calibrate the user agent's own distance-along-a-path calculations with that of the author. The user agent will scale all distance-along-a-path computations by the ratio of PathLength to the user agent's own computed value for total path length.
	Radius	DOUBLE	The radius of the spiral. Expressed as a fixed or scaled coordinate.
The radius of the spiral is defined here as either a fixed or scaled value. If zero, preference is given to LoopLimit.
	Spacing	DOUBLE	Declares the amount of empty space between each loop of the spiral.
Spacing tightly controls the computation of the spiral path, ensuring that a specific amount of empty space is left between each loop. The space is declared in pixel units. If Spacing is undeclared, the spiral expands at an incremental rate of `Step * 0.1`.
	Step	DOUBLE	Determines the distance between each vertex in the spiral's path.
The Step value affects the distance between each vertex in the spiral path during its generation. The default value is `1.0`. Using larger values will create a spiral with jagged corners due to the reduction in vertices.
	Width	DOUBLE	The width (horizontal diameter) of the spiral.
The width of the spiral is expressed as `Radius * 2.0`.

VectorSpiral Class

Structure