Default Generators

Generators are responsible for producing the initial spatial coordinates for a particle effect relative to the origin. Below is a list of all built-in static factory methods available in the Generators utility class.

Point

Method: Generators.point()

Generates a single point exactly at the origin (0, 0, 0).

(No parameters required)

Line

Method: Generators.line()

Generates a straight line of particles between two specified points.

Parameter	Information
`start`	The starting `Vector` coordinate.
`end`	The ending `Vector` coordinate.
`step`	The distance gap between each individual particle along the line.

Circle

Method: Generators.circle()

Generates a flat circle on the XZ plane.

Parameter	Information
`radius`	The horizontal radius of the circle.
`points`	The total number of particles comprising the circumference.

Square

Method: Generators.square()

Generates a flat square outline on the XZ plane.

Parameter	Information
`size`	The side length of the square.
`pointsPerSide`	The number of particles plotted along each edge.

Sphere

Method: Generators.sphere()

Generates a 3D sphere using a Fibonacci spiral distribution for even particle spacing.

Parameter	Information
`radius`	The radius of the sphere.
`points`	The total number of particles defining the sphere's surface.

Cube

Method: Generators.cube()

Generates the 3D wireframe outline of a cube.

Parameter	Information
`size`	The edge length of the cube.
`resolution`	The number of particles defining each edge.

Pyramid

Method: Generators.pyramid()

Generates a 3D pyramid shape with a square base.

Parameter	Information
`size`	The width of the pyramid's base.
`height`	The total vertical height of the pyramid.
`resolution`	The particle density per horizontal layer.

Helix

Method: Generators.helix()

Generates a 3D helix (spring) shape.

Parameter	Information
`radius`	The radius of the helix curve.
`height`	The total vertical height of the structure.
`turns`	The number of complete 360-degree rotations the spiral makes.
`points`	The total number of particles.
`speed`	The dynamic rotational speed offset (for animated spinning).

Image

Method: Generators.fromImage()

Replicates a 2D BufferedImage by mapping its non-transparent pixels to 3D space.

Parameter	Information
`image`	The source `BufferedImage` to convert.
`size`	The maximum world-space size the image should occupy.
`density`	The pixel skip rate (e.g., `1` for every pixel, `2` for every other pixel).

Text

Method: Generators.text()

Converts a string of text into a particle-based layout.

Parameter	Information
`text`	The string of text to display.
`fontName`	The system font name to render with.
`style`	The font style (e.g., `Font.BOLD`).
`color`	(Optional) A `ColorProvider` for gradient or solid text coloring. Defaults to white.
`fontSize`	The internal rasterization font size.
`size`	The maximum world-space width/height of the generated text.

05 June 2026