Struct SerializableSparseVoxelSet

Namespace

GridForge.Configuration

Unity-serializable sparse voxel authoring data.

[Serializable]
public struct SerializableSparseVoxelSet

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SerializableSparseVoxelSet(IEnumerable<SerializableVoxelIndex>)

Creates a sparse voxel set from serializable indices.

public SerializableSparseVoxelSet(IEnumerable<SerializableVoxelIndex> indices)

Parameters

indices IEnumerable<SerializableVoxelIndex>

The indices to copy.

Properties

Count

Gets the number of configured indices.

public readonly int Count { get; }

Property Value

int

Empty

Gets an empty sparse voxel set.

public static SerializableSparseVoxelSet Empty { get; }

Property Value

SerializableSparseVoxelSet

HasConfiguredVoxels

Gets whether at least one voxel index is configured.

public readonly bool HasConfiguredVoxels { get; }

Property Value

bool

Indices

Gets the runtime list of serializable indices.

public readonly SwiftList<SerializableVoxelIndex> Indices { get; }

Property Value

SwiftList<SerializableVoxelIndex>

Methods

FromVoxelIndices(IEnumerable<VoxelIndex>)

Creates serializable sparse data from runtime indices.

public static SerializableSparseVoxelSet FromVoxelIndices(IEnumerable<VoxelIndex> indices)

Parameters

indices IEnumerable<VoxelIndex>

The runtime indices to copy.

Returns

SerializableSparseVoxelSet

The serializable sparse voxel set.

TryToVoxelIndices(out VoxelIndex[], out string)

Validates and converts the configured values to runtime indices.

public readonly bool TryToVoxelIndices(out VoxelIndex[] indices, out string failureReason)

Parameters

indices VoxelIndex[]

Receives the runtime indices.

failureReason string

Receives the validation failure reason.

Returns

bool

true when all configured indices are valid.