VoxelMeshSdf

public VoxelMeshSdf.BakeModeEnum BakeMode { get; set; }

Selects the algorithm that will be used to compute SDF from the mesh.

public bool BoundarySignFixEnabled { get; set; }

Some algorithms might fail to properly compute the sign of distances on their own. Usually outside the shape has positive sign, and inside the shape has negative sign. Errors can cause the wrong sign to "leak" and propagate outside the shape. This option attempts to fix this when it happens by assuming that the border of the baked region is always outside, and propagates positive signs inwards to ensure no negative signs leak.

public int CellCount { get; set; }

Controls the resolution of the baked SDF, proportionally to one side of the 3D voxel buffer. Higher increases quality, but is slower to bake and uses more memory.

public float MarginRatio { get; set; }

Controls the addition of extra space around the mesh's baking area. Proper SDF buffers should have some margin in order to capture outside gradients. Without margin, the outside could appear cutoff or blocky when remeshed. This property adds margin based on a ratio of the size of the mesh. For example, if the mesh is 100 units wide, a margin of 0.1 will add 10 extra units of space around it.

public Mesh Mesh { get; set; }

Mesh that will be baked when calling the VoxelMeshSdf.Bake function, or when pressing the Bake button in the editor. Setting this property back to null will not erase the baked result, so you don't need the original mesh to be loaded in order to use the SDF.

public int PartitionSubdiv { get; set; }

Controls how many subdivisions to use across the baking area when using the VoxelMeshSdf.BakeModeEnum.AccuratePartitioned and VoxelMeshSdf.BakeModeEnum.ApproxFloodfill modes. When using VoxelMeshSdf.BakeModeEnum.AccuratePartitioned, that value may be proportionally adjusted based on the amount of triangles the mesh has, due to an imperfection of the algorithm. If the mesh has few triangles, lower values will perform better. If it has a lot of small triangles, higher values will perform better. However, if triangles are large or few and the value is big, this will also potentially create artifacts.

public void Bake();

Bakes the SDF on the calling thread, using the currently assigned VoxelMeshSdf.Mesh. Might cause the game to stall if done on the main thread.

public void BakeAsync(EntityTree sceneTree);

Bakes the SDF on a separate thread, using the currently assigned VoxelMeshSdf.Mesh. See also VoxelMeshSdf.IsBaking, VoxelMeshSdf.IsBaked and VoxelMeshSdf.Baked.

public Reckfell.Collections.Array DebugCheckSdf(Mesh mesh);

Experimental. Runs some checks to verify if the baked SDF contains errors. The mesh to pass should be the mesh that was used for baking. If there are errors, the returned array will contain information about up to 2 cells of the buffer containing wrong values, in the following format:

[
    cell0_position: Vector3,
    cell0_triangle_v0: Vector3,
    cell0_triangle_v1: Vector3,
    cell0_triangle_v2: Vector3,
    cell1_position: Vector3,
    cell1_triangle_v0: Vector3,
    cell1_triangle_v1: Vector3,
    cell1_triangle_v2: Vector3,
]

If there are no errors, the returned array will be empty. This method is a leftover from when this resource was initially implemented, as an attempt to automate checks when debugging. Errors might not always indicate an unusable SDF, depending on the use case. It might be removed or changed in the future.

public Aabb GetAabb();

Get the reference bounding box of the baked shape. This may be a bit larger than the original mesh's AABB because of the VoxelMeshSdf.MarginRatio property.

public VoxelBuffer GetVoxelBuffer();

Get the VoxelBuffer containing the baked distance field. Results will be stored in the SDF channel. This buffer should not be modified.

public bool IsBaked();

Gets whether the resource contains baked SDF data.

public bool IsBaking();

Gets whether a asynchronous baking operation is pending.

public event Action Baked;

Emitted when asynchronous baking is complete.