Struct SerializableGridConfiguration

Namespace

GridForge.Configuration

A Unity-serializable version of GridConfiguration for editor use.

[Serializable]
public struct SerializableGridConfiguration

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SerializableGridConfiguration(Vector3d, Vector3d, int)

Creates a dense rectangular-prism configuration with default metrics.

public SerializableGridConfiguration(Vector3d boundsMin, Vector3d boundsMax, int scanCellSize)

Parameters

boundsMin Vector3d

The inclusive minimum world bounds.

boundsMax Vector3d

The inclusive maximum world bounds.

scanCellSize int

The scan cell size.

SerializableGridConfiguration(Vector3d, Vector3d, int, GridTopologyKind, SerializableGridTopologyMetrics, GridStorageKind, SerializableSparseVoxelSet)

Creates a serializable grid configuration.

public SerializableGridConfiguration(Vector3d boundsMin, Vector3d boundsMax, int scanCellSize, GridTopologyKind topologyKind, SerializableGridTopologyMetrics topologyMetrics, GridStorageKind storageKind, SerializableSparseVoxelSet configuredSparseVoxels)

Parameters

boundsMin Vector3d

The inclusive minimum world bounds.

boundsMax Vector3d

The inclusive maximum world bounds.

scanCellSize int

The scan cell size.

topologyKind GridTopologyKind

The grid topology kind.

topologyMetrics SerializableGridTopologyMetrics

The topology metrics.

storageKind GridStorageKind

The grid storage kind.

configuredSparseVoxels SerializableSparseVoxelSet

The configured sparse voxel indices.

Properties

BoundsMax

Gets the inclusive maximum world bounds.

public readonly Vector3d BoundsMax { get; }

Property Value

Vector3d

BoundsMin

Gets the inclusive minimum world bounds.

public readonly Vector3d BoundsMin { get; }

Property Value

Vector3d

ConfiguredSparseVoxels

Gets the configured sparse voxel indices.

public readonly SerializableSparseVoxelSet ConfiguredSparseVoxels { get; }

Property Value

SerializableSparseVoxelSet

ScanCellSize

Gets the scan cell size.

public readonly int ScanCellSize { get; }

Property Value

int

StorageKind

Gets the grid storage kind.

public readonly GridStorageKind StorageKind { get; }

Property Value

GridStorageKind

TopologyKind

Gets the grid topology kind.

public readonly GridTopologyKind TopologyKind { get; }

Property Value

GridTopologyKind

TopologyMetrics

Gets the serialized topology metrics.

public readonly SerializableGridTopologyMetrics TopologyMetrics { get; }

Property Value

SerializableGridTopologyMetrics

Methods

FromGridConfiguration(GridConfiguration)

Creates a serializable version from a GridConfiguration.

public static SerializableGridConfiguration FromGridConfiguration(GridConfiguration config)

Parameters

config GridConfiguration

The runtime configuration to serialize.

Returns

SerializableGridConfiguration

The serializable configuration.

ToGridConfiguration()

Converts this Unity-serializable struct to the GridForge GridConfiguration.

public readonly GridConfiguration ToGridConfiguration()

Returns

GridConfiguration

The converted configuration.

TryGetConfiguredSparseVoxels(out VoxelIndex[], out string)

Converts configured sparse authoring data to topology-local voxel indices.

public readonly bool TryGetConfiguredSparseVoxels(out VoxelIndex[] configuredVoxels, out string failureReason)

Parameters

configuredVoxels VoxelIndex[]

Receives the topology-local voxel indices.

failureReason string

Receives the validation failure reason.

Returns

bool

true when the sparse data is valid.

TryToGridConfiguration(out GridConfiguration, out string)

Tries to convert this Unity-serializable struct to the GridForge GridConfiguration.

public readonly bool TryToGridConfiguration(out GridConfiguration config, out string failureReason)

Parameters

config GridConfiguration

Receives the converted configuration.

failureReason string

Receives the validation failure reason.

Returns

bool

true when conversion succeeds.