Class TrailblazerHeightmapService

Namespace

Trailblazer.Heightmaps

Assembly

Trailblazer.dll

Context-owned API for registering and sampling deterministic heightmap layers.

public sealed class TrailblazerHeightmapService

Inheritance

object

TrailblazerHeightmapService

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

IsRegistered(string)

Returns true when a layer with the supplied name is registered.

public bool IsRegistered(string layerName)

Parameters

layerName string

Returns

bool

Register(HeightmapSurface, Fixed64, Fixed64, int)

Registers a heightmap layer for this context.

public bool Register(HeightmapSurface surface, Fixed64 minSelectionY, Fixed64 maxSelectionY, int priority = 0)

Parameters

surface HeightmapSurface

minSelectionY Fixed64

maxSelectionY Fixed64

priority int

Returns

bool

Reset()

Clears all heightmap layers registered to this context.

public void Reset()

TryGetRegistration(string, out HeightmapLayerRegistration)

Attempts to retrieve context-local registration metadata for a layer.

public bool TryGetRegistration(string layerName, out HeightmapLayerRegistration registration)

Parameters

layerName string

registration HeightmapLayerRegistration

Returns

bool

TrySampleGround(Vector3d, string?, out HeightmapSample)

Attempts to sample the preferred layer when valid, then falls back to deterministic candidate selection.

public bool TrySampleGround(Vector3d worldPosition, string? preferredLayerName, out HeightmapSample sample)

Parameters

worldPosition Vector3d

preferredLayerName string

sample HeightmapSample

Returns

bool

TrySampleGround(Vector3d, out HeightmapSample)

Attempts to sample the best deterministic registered layer that contains the query X/Z and contact Y.

public bool TrySampleGround(Vector3d worldPosition, out HeightmapSample sample)

Parameters

worldPosition Vector3d

sample HeightmapSample

Returns

bool

Unregister(string)

Unregisters a heightmap layer by name.

public bool Unregister(string layerName)

Parameters

layerName string

Returns

bool