package.facepunch.libsdf

Base interface for shapes that can be added to or subtracted from a .

Axis aligned bounds that fully encloses the surface of this shape.

Find the signed distance of a point from the surface of this shape. Positive values are outside, negative are inside, and 0 is exactly on the surface.

Position to sample at A signed distance from the surface of this shape

Some extension methods for .

Moves the given SDF by the specified offset.

SDF type SDF to translate Offset to translate by A translated version of

Scales, rotates, and translates the given SDF.

SDF type SDF to transform Transformation to apply A transformed version of

Scales, rotates, and translates the given SDF.

SDF type SDF to transform Offset to translate by Rotation to apply Scale multiplier to apply A transformed version of

Expands the surface of the given SDF by the specified margin.

SDF type SDF to expand Distance to expand by An expanded version of

Describes an axis-aligned rectangle with rounded corners.

Position of the corner with smallest X and Y values Position of the corner with largest X and Y values Controls the roundness of corners, or 0 for (approximately) sharp corners

Describes an axis-aligned rectangle with rounded corners.

Position of the corner with smallest X and Y values Position of the corner with largest X and Y values Controls the roundness of corners, or 0 for (approximately) sharp corners

Position of the corner with smallest X and Y values

Position of the corner with largest X and Y values

Controls the roundness of corners, or 0 for (approximately) sharp corners

Describes an axis-aligned rectangle with rounded corners.

Size and position of the box Controls the roundness of corners, or 0 for (approximately) sharp corners

Describes a circle with a position and radius.

Position of the center of the circle Distance from the center to the edge of the circle

Describes a circle with a position and radius.

Position of the center of the circle Distance from the center to the edge of the circle

Position of the center of the circle

Distance from the center to the edge of the circle

Describes a line between two points with rounded ends of a given radius.

Start point of the line End point of the line Radius of the end caps, and half the width of the line Internal helper vector for optimization. Please use the other constructor instead of specifying this yourself.

Describes a line between two points with rounded ends of a given radius.

Start point of the line

End point of the line

Radius of the end caps, and half the width of the line

Internal helper vector for optimization. Please use the other constructor instead of specifying this yourself.

Describes a line between two points with rounded ends of a given radius.

Start point of the line End point of the line Radius of the end caps, and half the width of the line

RGBA pixel color channel.

Red component.

Green component.

Blue component.

Alpha component.

A SDF loaded from a .

A SDF loaded from a color channel from a . By default, bright values represent the exterior, and light values represent the interior.

Texture to read from Distance, in pixels, between the lightest and darkest values of gradients in The desired width of the resulting SDF. The height will be determined using 's aspect ratio. Relative position of the origin in this SDF. This is also the point that the SDF will rotate around. (0, 0) is the bottom-left, (1, 1) is the top-right, and therefore (0.5, 0.5) is the center (default). Color channel to read from If false (default), bright values are external. If true, bright values are internal.

Helper struct returned by

Array containing raw SDF samples for a .

Represents chunks in a . Each chunk contains an SDF for a sub-region of one specific layer.

Options for how front / back faces connect to the cut face in a .

The two faces meet at a 90 degree angle.

The two faces are connected by a 45 degree bevel.

The two faces smoothly join with a rounded edge.

Controls the appearance and physical properties of a layer in a .

How wide this layer is in the z-axis. This can help prevent z-fighting for overlapping layers.

How far to offset this layer in the z-axis. Useful for things like background / foreground layers.

How wide a single tile of the texture should be.

Material used by the front face of this layer.

Material used by the back face of this layer.

Material used by the cut face connecting the front and back of this layer.

Options for how front / back faces connect to the cut face.

Angles below this will have smooth normals.

How wide the connecting edge should be between front / back faces and the cut face.

How many faces to use for rounded connecting edges between front / back faces and the cut face.


            c - d
            |   |
            a - b

Main entity for creating a set of 2D surfaces that can be added to and subtracted from. Each surface is aligned to the same plane, but can have different offsets, depths, and materials.

Represents a 2D rotation around the Z axis.

Cosine of the rotation angle. Sine of the rotation angle.

Represents a 2D rotation around the Z axis.

Cosine of the rotation angle. Sine of the rotation angle.

Cosine of the rotation angle.

Sine of the rotation angle.

Converts an angle in degrees to a .

Angle in degrees. Rotation corresponding to the given angle.

Converts a rotation to its vector representation.

Converts a rotation from its vector representation.

Represents a rotation of 0 degrees.

Applies a rotation to a vector.

Rotation to apply. Vector to rotate. A rotated vector.

Combines two rotations.

First rotation. Second rotation. A combined rotation.

Result of rotating (1, 0) by this rotation.

Result of rotating (0, 1) by this rotation.

Inverse of this rotation.

A normalized version of this rotation, in case ^2 + ^2 != 1.

Represents a 2D rotation around the Z axis.

Angle in degrees. Translation this transform will apply. Rotation this transform will apply. Scale this transform will apply. Inverse of . Translation this transform will apply. Rotation this transform will apply. Scale this transform will apply. Inverse of .

Translation this transform will apply.

Rotation this transform will apply.

Scale this transform will apply.

Inverse of .

Represents no transformation.

Translation this transform will apply. Rotation this transform will apply. Scale this transform will apply.

Apply this transformation to a position.

Position to transform. Transformed position.

Apply the inverse of this transformation to a position.

Position to transform. Transformed position.

Base interface for shapes that can be added to or subtracted from a .

Axis aligned bounds that fully encloses the surface of this shape.

Find the signed distance of a point from the surface of this shape. Positive values are outside, negative are inside, and 0 is exactly on the surface.

Position to sample at A signed distance from the surface of this shape

Sample an axis-aligned box shaped region, writing to an array.

Transformation to apply to the SDF. Array to write signed distance values to. Dimensions of the array.

Some extension methods for .

Moves the given SDF by the specified offset.

SDF type SDF to translate Offset to translate by A translated version of

Scales, rotates, and translates the given SDF.

SDF type SDF to transform Transformation to apply A transformed version of

Scales, rotates, and translates the given SDF.

SDF type SDF to transform Offset to translate by Rotation to apply Scale multiplier to apply A transformed version of

Expands the surface of the given SDF by the specified margin.

SDF type SDF to expand Distance to expand by An expanded version of

Describes an axis-aligned box with rounded corners.

Position of the corner with smallest X, Y and Z values Position of the corner with largest X, Y and Z values Controls the roundness of corners, or 0 for (approximately) sharp corners

Describes an axis-aligned box with rounded corners.

Position of the corner with smallest X, Y and Z values Position of the corner with largest X, Y and Z values Controls the roundness of corners, or 0 for (approximately) sharp corners

Position of the corner with smallest X, Y and Z values

Position of the corner with largest X, Y and Z values

Controls the roundness of corners, or 0 for (approximately) sharp corners

Describes an axis-aligned box with rounded corners.

Size and position of the box Controls the roundness of corners, or 0 for (approximately) sharp corners

Describes a sphere with a position and radius.

Position of the center of the sphere Distance from the center to the surface of the sphere

Describes a sphere with a position and radius.

Position of the center of the sphere Distance from the center to the surface of the sphere

Position of the center of the sphere

Distance from the center to the surface of the sphere

Describes two spheres connected by a cylinder, all with a common radius.

Center of the first sphere Center of the second sphere Radius of the spheres and connecting cylinder Internal helper vector for optimization. Please use the other constructor instead of specifying this yourself.

Describes two spheres connected by a cylinder, all with a common radius.

Center of the first sphere

Center of the second sphere

Radius of the spheres and connecting cylinder

Internal helper vector for optimization. Please use the other constructor instead of specifying this yourself.

Describes two spheres connected by a cylinder, all with a common radius.

Center of the first sphere Center of the second sphere Radius of the spheres and connecting cylinder

Helper struct returned by

Networked array containing raw SDF samples for a .

Represents chunks in a . Each chunk contains an SDF for a sub-region of one specific volume.


            Z = 0   Z = 1
            c - d   g - h
            |   |   |   |
            a - b   e - f

Controls the appearance and physical properties of a volume in a .

Material used to render this volume.

Main entity for creating a 3D surface that can be added to and subtracted from. Multiple volumes can be added to this entity with different materials.

Base class for networked arrays containing raw SDF samples as bytes.

Interface for SDFs that can modify the array

How far outside the chunk boundary should samples be stored. This is used to ensure generated normals are smooth when on a chunk boundary.

Spacial dimensions of the array (2D / 3D).

Quality settings, affecting the resolution of the array.

Actual raw samples, encoded as bytes. A value of 0 is -, 255 is +, and 127.5 is on the surface.

Number of samples stored in one dimension of this array.

Total number of samples stored in the entire array. Equal to to the power of .

Distance between samples in one axis.

Inverse of .

Creates an array with a given number of spacial dimensions.

Spacial dimensions of the array (2D / 3D).

Gets the min and max index for a local-space range of samples, clamped to the array bounds.

Minimum position in local-space along the axis Maximum position in local-space along the axis Minimum (inclusive) and maximum (exclusive) indices

Encodes a distance value to a byte.

Distance to encode. - encodes to 0, + encodes to 255, and therefore 0 becomes ~128.

Lazily creates / updates a texture containing the encoded samples for use in shaders.

Implements creating a texture containing the encoded samples.

A 2D / 3D texture containing the samples

Implements updating a texture containing the encoded samples.

Implements adding a local-space shape to the samples in this array.

SDF type Shape to add True if any geometry was modified

Implements subtracting a local-space shape from the samples in this array.

SDF type Shape to subtract True if any geometry was modified

Sets every sample to solid or empty.

Solidity to set each sample to.

Invalidates the texture, and collision / render meshes for the chunk this array represents. This doesn't trigger a net write.

Base class for chunks in a . Each chunk contains an SDF for a sub-region of one specific volume / layer resource.

Non-abstract world type Non-abstract chunk type Volume / layer resource Integer coordinates used to index a chunk Type of used to contain samples Interface for SDF shapes used to make modifications

Array storing SDF samples for this chunk.

World that owns this chunk.

Volume or layer resource controlling the rendering and collision of this chunk.

Position index of this chunk in the world.

If this chunk has collision, the generated physics mesh for this chunk.

If this chunk is rendered, the scene object containing the generated mesh.

Called after the chunk is added to the .

Sets every sample in this chunk's SDF to solid or empty.

Solidity to set each sample to.

Add a world-space shape to this chunk.

SDF type Shape to add True if any geometry was modified

Subtract a world-space shape from this chunk.

SDF type Shape to subtract True if any geometry was modified

Implements updating the render / collision meshes of this chunk.

Task that completes when the meshes have finished updating.

Asynchronously updates the collision shape to the defined mesh.

Collision mesh vertices Collision mesh indices

Updates the collision shape to the defined mesh. Must be called on the main thread.

Collision mesh vertices Collision mesh indices

Updates this chunk's model to use the given set of meshes. Must be called on the main thread.

Set of meshes this model should use

References a layer or volume that will be used as a texture when rendering.

Material attribute name to set for the materials used by this layer or volume.

Source layer or volume that will provide the texture. The texture will have a single channel, with 0 representing - of the source layer, and 1 representing +.

Base class for SDF volume / layer resources.

If true, this layer or volume is only used as a texture source by other layers or volumes. This will disable collision shapes and render mesh generation for this layer or volume.

Tags that physics shapes created by this layer or volume should have, separated by spaces. If empty, no physics shapes will be created.

Array of tags that physics shapes created by this layer or volume should have. If empty, no physics shapes will be created.

If true, this resource will have a collision mesh. True if has any items and is false.

Controls mesh visual quality, affecting performance and networking costs.

How many rows / columns of samples are stored per chunk. Higher means more needs to be sent over the network, and more work for the mesh generator. Medium quality is 16 for 2D layers.

How wide / tall a chunk is in world space. If you'll always make small edits to this layer, you can reduce this to add detail. Medium quality is 256 for 2D layers.

Largest absolute value stored in a chunk's SDF. Higher means more samples are written to when doing modifications. I'd arbitrarily recommend ChunkSize / ChunkResolution * 4.

References to layers or volumes that will be used as textures when rendering this layer or volume. All referenced layers or volumes must have the same chunk size as this layer or volume.

Base type for entities representing a set of volumes / layers containing geometry generated from signed distance fields.

Non-abstract world type Non-abstract chunk type Volume / layer resource Integer coordinates used to index a chunk Type of used to contain samples Interface for SDF shapes used to make modifications

Spacial dimensions. 2 for , 3 for .

How many times this world has been cleared.

How many modifications have been applied since the last time this world was cleared.

Removes all layers / volumes, making this equivalent to a brand new empty world.

Removes the given layer or volume.

Layer or volume to clear

Add a shape to the given layer or volume.

SDF type Shape to add Layer or volume to add to True if any geometry was modified

Subtract a shape from the given layer or volume.

SDF type Shape to subtract Layer or volume to subtract from True if any geometry was modified

Subtract a shape from all layers.

SDF type Shape to subtract True if any geometry was modified

Disable to not generate any collision meshes.

Implements getting the indices of chunks within the bounds of the given SDF.

SDF type. SDF to check the bounds of. Quality setting that affects chunk size. Indices of possible affected chunks.

Preset quality settings for .

Cheap and cheerful, suitable for frequent (per-frame) edits.

Recommended quality for most cases.

More expensive to update and network, but a much smoother result.

Only use this for small, detailed objects!

Manually tweak quality parameters.

Quality settings for .

Distance between samples in one axis.

Read an instance of from a er.

Write this instance to a er. Can be read with .

Helper class for building 3D meshes based on a 2D polygon. Supports concave polygons with holes, although edges must not intersect.

Add faces starting at each active edge, traveling inwards and upwards to produce a bevel. If the bevel distance is large enough the mesh will become closed. Otherwise, you can use to add a flat face after the bevel.

Total distance inwards. Total distance upwards, away from the plane of the polygon.

Add faces starting at each active edge, traveling inwards and upwards to produce a bevel. Use and to control the normal directions at the start and end of the bevel faces. Angles are in radians, with 0 pointing outwards along the plane of the polygon, and PI/2 pointing upwards away from the plane. If the bevel distance is large enough the mesh will become closed. Otherwise, you can use to add a flat face after the bevel.

Total distance inwards. Total distance upwards, away from the plane of the polygon. Angle, in radians, to use for normals at the outside of the bevel.

Find when the start vertex of would cut .

Triangulate any remaining active edges so that the generated mesh is closed.

Difference to this vertex from the previous one.

Add all supported paths from the given SVG document.

SVG document contents. Options for generating vertices from paths. Rescale and translate the imported SVG to fill the given bounds

Add an individual path from an SVG document, if supported.

SVG path element. Options for generating vertices from paths. Rescale and translate the imported SVG to fill the given bounds

Number of edges that will be affected by calls to methods like , , and .

If true, no active edges remain because the mesh is fully closed.

Corners of the original polygon with an interior or exterior angle less than this (in radians) will have smooth normals.

If true, don't bother generating normals / tangents.

Positions of each vertex in the generated mesh.

Normals of each vertex in the generated mesh.

U-tangents, and the signs of the V-tangents, of each vertex in the generated mesh.

Positions, normals, and tangents of each vertex.

Indices of vertices describing the triangulation of the generated mesh.

Clear all geometry from this builder.

Reset this builder to be like a new instance.

Add a set of active edges forming a loop. Clockwise loops will be a solid polygon, and count-clockwise will form a hole. Holes must be inside of solid polygons, otherwise the mesh can't be closed correctly.

List of vertices to read a range from. Index of the first vertex in the loop. Number of vertices in the loop. If true, reverse the order of the vertices in the loop.

Add a raw set of edges. Be careful to ensure that each loop of edges is fully closed.

Positions of vertices to connect with edges. Indices of the start and end vertices of each edge.

Add faces on each active edge extending upwards by the given height.

Total distance upwards, away from the plane of the polygon.

Add faces on each active edge extending inwards by the given width. This will close the mesh if is large enough.

Total distance inwards.

Mirrors all previously created faces. The mirror plane is normal to the Z axis, with a given distance from the origin.

Distance of the mirror plane from the origin.

Perform successive s so that the edge of the polygon curves inwards in a quarter circle arc.

Radius of the arc. How many bevels to split the rounded edge into. If true, use smooth normals rather than flat shading. If true, the faces will be pointing outwards from the center of the arc.

Perform successive s so that the edge of the polygon curves inwards in a quarter circle arc.

Total distance inwards. Total distance upwards, away from the plane of the polygon. How many bevels to split the rounded edge into. If true, use smooth normals rather than flat shading. If true, the faces will be pointing outwards from the center of the arc.

Options for .

If true, any unsupported path types will throw an exception. Defaults to false.

Maximum distance between vertices on curved paths. Defaults to 1.

Scalable Vector Graphics source string for this model.