Function HeightFieldDecoder

HeightFieldDecoder(
    boundary: BoundaryField,
): {
    metadata: {
        boundary: {
            description: string;
            displayName: string;
            mathFunction: string;
        };
        decoder: { description: string; displayName: string };
    };
    sample(position: Vector3): number;
}
Generates a height-based scalar field from a boundary field.

For each position, samples the boundary to obtain its height and returns the difference between the position's z coordinate and that height.

Positive values indicate positions above the boundary, while negative values indicate positions below it.
Parameters
- boundary: BoundaryField
Returns {
    metadata: {
        boundary: {
            description: string;
            displayName: string;
            mathFunction: string;
        };
        decoder: { description: string; displayName: string };
    };
    sample(position: Vector3): number;
}
- Defined in decoders.ts:65

Index

Properties

Engine

Properties

metadata

metadata: DecoderMetadata