import {Heightfield} from 'rabbit-hole'

public class | source

Heightfield

Extends:

SignedDistanceFunction → Heightfield

Indirect Implements:

A Signed Distance Function that describes a heightfield.

Constructor Summary

Public Constructor
public	constructor(parameters: Object, material: Number) Constructs a new heightfield SDF.

Method Summary

Public Methods
public	computeBoundingBox(): Box3 Calculates the bounding box of this SDF.
public	createTransferList(transferList: Array): Transferable[] Creates a list of transferable items.
public	fromImage(image: Image): Heightfield Reads the image data of a given heightmap and converts it into a greyscale data array.
public	getHeight(x: Number, z: Number): Number Retrives the height value for the given coordinates.
public	sample(position: Vector3): Number Samples the volume's density at the given point in space.
public	serialize(deflate: Boolean): Object Serialises this SDF.

Inherited Summary

From class SignedDistanceFunction
public	inverseTransformation: Matrix4 The inverted transformation matrix.
public	material: Number A material index.
public	operation: OperationType The operation type.
public	position: Vector3 The positional translation.
public	quaternion: Quaternion The rotation.
public	scale: Vector3 The scale.
public	type: SDFType The type of this SDF.
protected	boundingBox: Box3 The axis-aligned bounding box of this SDF.
public	createTransferList(transferList: Array): Transferable[] Creates a list of transferable items.
public	getBoundingBox(recursive: Boolean): Box3 Calculates the AABB of this SDF if it doesn't exist yet and returns it.
public	getTransformation(matrix: Matrix4): Matrix4 Composes a transformation matrix using the translation, rotation and scale of this SDF.
public	intersect(sdf: SignedDistanceFunction): SignedDistanceFunction Intersects the given SDF with this one.
public	sample(position: Vector3): Number Samples the volume's density at the given point in space.
public	serialize(deflate: Boolean): Object Serialises this SDF.
public	setMaterial(material: Material): SignedDistanceFunction Sets the material.
public	setOperationType(operation: OperationType): SignedDistanceFunction Sets the CSG operation type of this SDF.
public	subtract(sdf: SignedDistanceFunction): SignedDistanceFunction Subtracts the given SDF from this one.
public	toCSG(): Operation Translates this SDF into a CSG expression.
public	toJSON(): Object Returns a plain object that describes this SDF.
public	union(sdf: SignedDistanceFunction): SignedDistanceFunction Adds the given SDF to this one.
public	updateInverseTransformation(): SignedDistanceFunction Updates the inverse transformation matrix.
protected	computeBoundingBox(): Box3 Calculates the bounding box of this SDF.

Public Constructors

public constructor(parameters: Object, material: Number) source

Constructs a new heightfield SDF.

Override:

SignedDistanceFunction#constructor

Params:

Name	Type	Attribute	Description
parameters	Object		The parameters.
parameters.width	Array	optional default: 1	The width of the heightfield.
parameters.height	Array	optional default: 1	The height of the heightfield.
parameters.smooth	Boolean	optional default: true	Whether the height data should be smoothed.
parameters.data	Uint8ClampedArray	optional default: null	The heightmap image data.
parameters.image	Image	optional	The heightmap image.
material	Number	optional	A material index.