import {HermiteData} from 'rabbit-hole'

public class | source

HermiteData

Implements:

Hermite data.

Static Member Summary

Static Public Members
public static get	isovalue: Number The global isovalue.
public static set	isovalue: Number Warning: changing the isovalue is not recommended.
public static get	resolution: Number The material grid resolution.
public static set	resolution: Number Warning: this value should only be set once.

Constructor Summary

Public Constructor
public	constructor(initialize: Boolean) Constructs a new set of Hermite data.

Member Summary

Public Members
public get	compressed: Boolean Indicates whether this data is currently compressed.
public	edgeData: EdgeData The edge data.
public get	empty: Boolean Indicates whether this data container is empty.
public get	full: Boolean Indicates whether this data container is full.
public	materialIndices: Uint8Array The grid points.
public	materials: Number Describes how many material indices are currently solid:
public get	neutered: Boolean Indicates whether this data is currently gone.
public	runLengths: Uint32Array Run-length compression data.

Method Summary

Public Methods
public	clear(): HermiteData Removes all data.
public	compress(target: HermiteData): HermiteData Compresses this data.
public	createTransferList(transferList: Array): Transferable[] Creates a list of transferable items.
public	decompress(target: HermiteData): HermiteData Decompresses this data.
public	deserialize(object: Object): Deserializable Adopts the given serialised data.
public	serialize(deflate: Boolean): Object Serialises this data.
public	set(data: HermiteData): HermiteData Adopts the given data.
public	setMaterialIndex(index: Number, value: Number) Sets the specified material index.

Static Public Members

public static get isovalue: Number source

The global isovalue.

A constant distance value that denotes the boundaries of SDFs.

public static set isovalue: Number source

Warning: changing the isovalue is not recommended.

public static get resolution: Number source

The material grid resolution.

The effective resolution of a chunk of Hermite data is the distance between two adjacent grid points with respect to the size of the containing world octant.

public static set resolution: Number source

Warning: this value should only be set once.

The upper limit is 256.

Public Constructors

public constructor(initialize: Boolean) source

Constructs a new set of Hermite data.

Params:

Name	Type	Attribute	Description
initialize	Boolean	optional default: true	Whether the data should be initialised immediately.

Public Members

public get compressed: Boolean source

Indicates whether this data is currently compressed.

public edgeData: EdgeData source

The edge data.

public get empty: Boolean source

Indicates whether this data container is empty.

public get full: Boolean source

Indicates whether this data container is full.

public materialIndices: Uint8Array source

The grid points.

public materials: Number source

Describes how many material indices are currently solid:

The chunk lies outside the volume if there are no solid grid points.
The chunk lies completely inside the volume if all points are solid.

public get neutered: Boolean source

Indicates whether this data is currently gone.

public runLengths: Uint32Array source

Run-length compression data.

Public Methods

public clear(): HermiteData source

Removes all data.

Return:

HermiteData

This data.

public compress(target: HermiteData): HermiteData source

Compresses this data.

Params:

Name	Type	Attribute	Description
target	HermiteData	optional default: this	A target data set. The compressed data will be assigned to this set.

Return:

HermiteData

The target data set.

public createTransferList(transferList: Array): Transferable[] source

Creates a list of transferable items.

Params:

Name	Type	Attribute	Description
transferList	Array	optional	An optional target list. The transferable items will be added to this list.

Return:

Transferable[]

The transfer list.

public decompress(target: HermiteData): HermiteData source

Decompresses this data.

Params:

Name	Type	Attribute	Description
target	HermiteData	optional default: this	A target data set. If none is provided, the compressed data will be replaced with the decompressed data.