Variable

Static Public Summary
public	Action: Object An enumeration of worker actions.
public	Material: Object An enumeration of material constants.
public	OperationType: Object An enumeration of CSG operation types.
public	SDFType: Object An enumeration of SDF types.
public	SuperPrimitivePreset: Object An enumeration of super primitive presets.
public	cellProcEdgeMask: Uint8Array[] An edge mask for cell processing.
public	cellProcFaceMask: Uint8Array[] A face mask for cell processing.
public	edgeMask: Uint8Array An edge mask.
public	edgeProcEdgeMask: Array<Uint8Array[]> An edge mask for edge processing.
public	error: ClipmapEvent Signals the occurrence of an unexpected error.
public	error: TerrainEvent Signals the occurrence of an unexpected error.
public	extractionend: TerrainEvent Signals the end of an extraction task.
public	extractionstart: TerrainEvent Signals the start of an extraction task.
public	faceMap: Uint8Array[] A face map.
public	faceProcEdgeMask: Array<Uint8Array[]> An edge mask for face processing.
public	faceProcFaceMask: Array<Uint8Array[]> A face mask for face processing.
public	load: TerrainEvent Signals the end of a volume data loading process.
public	load: SDFLoaderEvent A load event.
public	message: WorkerEvent A worker message event.
public	modificationend: TerrainEvent Signals the end of a modification task.
public	modificationstart: TerrainEvent Signals the start of a modification task.
public	procEdgeMask: Uint8Array[] An edge mask.
public	update: ClipmapEvent Signals the end of a clipmap update for a single LOD shell.

Static Public

public Action: Object source

import {Action} from 'rabbit-hole'

An enumeration of worker actions.

Properties:

Name	Type	Attribute	Description
EXTRACT	String		Isosurface extraction signal.
MODIFY	String		Data modification signal.
CONFIGURE	String		General configuration signal.
CLOSE	String		Thread termination signal.

public Material: Object source

import {Material} from 'rabbit-hole'

An enumeration of material constants.

Properties:

Name	Type	Attribute	Description
AIR	Number		Indicates empty space.
SOLID	Number		Indicates solid material.

public OperationType: Object source

import {OperationType} from 'rabbit-hole'

An enumeration of CSG operation types.

Properties:

Name	Type	Attribute	Description
UNION	String		Indicates a union of volume data.
DIFFERENCE	String		Indicates a subtraction of volume data.
INTERSECTION	String		Indicates an intersection of volume data.
DENSITY_FUNCTION	String		Indicates volume data generation.

public SDFType: Object source

import {SDFType} from 'rabbit-hole'

An enumeration of SDF types.

Properties:

Name	Type	Attribute	Description
HEIGHTFIELD	String		A heightfield description.
FRACTAL_NOISE	String		A fractal noise description.
SUPER_PRIMITIVE	String		A super primitive description.

public SuperPrimitivePreset: Object source

import {SuperPrimitivePreset} from 'rabbit-hole'

An enumeration of super primitive presets.

Properties:

Name	Type	Attribute	Description
CUBE	Number		A cube.
CYLINDER	Number		A cylinder.
CONE	Number		A cone.
PILL	Number		A pill.
SPHERE	Number		A sphere.
PELLET	Number		A pellet.
TORUS	Number		A torus.
PIPE	Number		A pipe.
CORRIDOR	Number		A corridor.

public cellProcEdgeMask: Uint8Array[] source

import {cellProcEdgeMask} from 'rabbit-hole'

An edge mask for cell processing.

public cellProcFaceMask: Uint8Array[] source

import {cellProcFaceMask} from 'rabbit-hole'

A face mask for cell processing.

public edgeMask: Uint8Array source

import {edgeMask} from 'rabbit-hole'

An edge mask.

public edgeProcEdgeMask: Array<Uint8Array[]> source

import {edgeProcEdgeMask} from 'rabbit-hole'

An edge mask for edge processing.

public error: ClipmapEvent source

import {error} from 'rabbit-hole'

Signals the occurrence of an unexpected error.

This event is dispatched by Clipmap.

Example:

terrain.addEventListener("error", myListener);

public error: TerrainEvent source

import {error} from 'rabbit-hole'

Signals the occurrence of an unexpected error.

This event is dispatched by Terrain.

Example:

terrain.addEventListener("error", myListener);

public extractionend: TerrainEvent source

import {extractionend} from 'rabbit-hole'

Signals the end of an extraction task.

This event is dispatched by Terrain.

Example:

terrain.addEventListener("extractionend", myListener);

public extractionstart: TerrainEvent source

import {extractionstart} from 'rabbit-hole'

Signals the start of an extraction task.

This event is dispatched by Terrain.

Example:

terrain.addEventListener("extractionstart", myListener);

public faceMap: Uint8Array[] source

import {faceMap} from 'rabbit-hole'

A face map.

public faceProcEdgeMask: Array<Uint8Array[]> source

import {faceProcEdgeMask} from 'rabbit-hole'

An edge mask for face processing.

public faceProcFaceMask: Array<Uint8Array[]> source

import {faceProcFaceMask} from 'rabbit-hole'

A face mask for face processing.

public load: TerrainEvent source

import {load} from 'rabbit-hole'

Signals the end of a volume data loading process.

This event is dispatched by Terrain.

Example:

terrain.addEventListener("load", myListener);

public load: SDFLoaderEvent source

import {load} from 'rabbit-hole'

A load event.

This event is dispatched by SDFLoader.

Example:

sdfLoader.addEventListener("load", myListener);

public message: WorkerEvent source

import {message} from 'rabbit-hole'

A worker message event.

This event is dispatched by ThreadPool.

Example:

threadPool.addEventListener("message", myListener);

public modificationend: TerrainEvent source

import {modificationend} from 'rabbit-hole'

Signals the end of a modification task.

This event is dispatched by Terrain.

Example:

terrain.addEventListener("modificationend", myListener);

public modificationstart: TerrainEvent source

import {modificationstart} from 'rabbit-hole'

Signals the start of a modification task.

This event is dispatched by Terrain.

Example:

terrain.addEventListener("modificationstart", myListener);

public procEdgeMask: Uint8Array[] source

import {procEdgeMask} from 'rabbit-hole'

An edge mask.

public update: ClipmapEvent source

import {update} from 'rabbit-hole'

Signals the end of a clipmap update for a single LOD shell.

This event is dispatched by Clipmap.

Example:

terrain.addEventListener("update", myListener);