Documentation

Class

Stipple

frontend/Stippling/Stipple.Stipple(x, y, densityopt, radiusopt)

Constructor

# new Stipple(x, y, densityopt, radiusopt)

Creates a new stipple point

Parameters:
Name Type Attributes Default Description
x number

X coordinate
y number

Y coordinate
density number <optional>
 0.5

Initial density value
radius number <optional>
 0.5

Initial radius

View Source frontend/src/Stippling/Stipple.ts, line 42

Classes

Stipple

Members

# density

Density value at this point

View Source frontend/src/Stippling/Stipple.ts, line 23

number

# density

Density value at this point

View Source frontend/src/Stippling/Stipple.ts, line 211

# maxIterations

Maximum number of iterations for stipple placement

View Source frontend/src/Stippling/Stipple.ts, line 33

# progressBar

Progress bar instance

View Source frontend/src/Stippling/Stipple.ts, line 31

# progress_bar

Progress bar element

View Source frontend/src/Stippling/Stipple.ts, line 29

# radius

Radius of the stipple point

View Source frontend/src/Stippling/Stipple.ts, line 25

number

# radius

Radius of the stipple point

View Source frontend/src/Stippling/Stipple.ts, line 215

# relativeX

Relative X position (normalized)

View Source frontend/src/Stippling/Stipple.ts, line 19

number

# relativeX

Relative X position (normalized)

View Source frontend/src/Stippling/Stipple.ts, line 203

# relativeY

Relative Y position (normalized)

View Source frontend/src/Stippling/Stipple.ts, line 21

number

# relativeY

Relative Y position (normalized)

View Source frontend/src/Stippling/Stipple.ts, line 207

# stippleDebugDiv

Debug information display element

View Source frontend/src/Stippling/Stipple.ts, line 27

# x

X coordinate in world space

View Source frontend/src/Stippling/Stipple.ts, line 15

number

# x

X coordinate in world space

View Source frontend/src/Stippling/Stipple.ts, line 195

# y

Y coordinate in world space

View Source frontend/src/Stippling/Stipple.ts, line 17

number

# y

Y coordinate in world space

View Source frontend/src/Stippling/Stipple.ts, line 199

# static maxIterations

Maximum number of iterations for stipple placement

View Source frontend/src/Stippling/Stipple.ts, line 223

# static progressBar

Progress bar instance

View Source frontend/src/Stippling/Stipple.ts, line 221

# static progress_bar

Progress bar element

View Source frontend/src/Stippling/Stipple.ts, line 219

# static stippleDebugDiv

Debug information display element

View Source frontend/src/Stippling/Stipple.ts, line 217

Methods

# setPosition(x, y)

Updates the position of the stipple

Parameters:
Name Type Description
x number

New X coordinate
y number

New Y coordinate

View Source frontend/src/Stippling/Stipple.ts, line 241

# static createRandomStipples(numStipples, maxX, maxY, sampleropt) → {Array.<Stipple>}

Creates an array of randomly positioned stipples

Parameters:
Name Type Attributes Default Description
numStipples number

Number of stipples to create
maxX number

Maximum X coordinate
maxY number

Maximum Y coordinate
sampler function <optional>
 d3.randomUniform

Random number generator

View Source frontend/src/Stippling/Stipple.ts, line 252

Array of randomly positioned stipples

Array.<Stipple>

# static splitCell()

Splits a Voronoi cell into two new points

Parameters:
Type Description

View Source frontend/src/Stippling/Stipple.ts, line 283

# async static stippleDensityFunctionWithWorker(densityFunction, initialStippleRadiusopt, initialErrorThresholdopt, thresholdConvergenceRateopt, max_iteropt, bufferHandleropt) → {Promise.<{stipples: Array.<Stipple>, voronoi: Voronoi.<number>}>}

Processes density function with a web worker for stipple placement

Parameters:
Name Type Attributes Default Description
densityFunction DensityFunction2D

Density function to process
initialStippleRadius number <optional>
 2.0

Initial radius for stipples
initialErrorThreshold number <optional>
 0.0

Initial error threshold
thresholdConvergenceRate number <optional>
 0.01

Rate of convergence
max_iter number <optional>
 100

Maximum iterations
bufferHandler BufferHandler <optional>
 null

Optional buffer handler for updates

View Source frontend/src/Stippling/Stipple.ts, line 275

Final stipple positions and Voronoi diagram

Promise.<{stipples: Array.<Stipple>, voronoi: Voronoi.<number>}>

# static stipplesToCircles(stipples) → {Array.<Circle>}

Converts an array of stipples to circles for rendering

Parameters:
Name Type Description
stipples Array.<Stipple>

Array of stipples to convert

View Source frontend/src/Stippling/Stipple.ts, line 260

Array of circles for rendering

Array.<Circle>