ImFusion Web SDK

Data

A dataset held by the Web SDK.

Extends

Extended by

Accessors

AccessorAccessTypeDescription
nameget/setstringThe name of the dataset

Methods

MethodDescription
kind()Returns the kind of this data.
modality()Returns the modality of this data.
bounds()Returns the axis-aligned bounding box of this data in world space.

Inherited from ClassHandle

MethodDescription
isAliasOf()Returns true if this handle and other alias the same underlying C++ object.
delete()Releases this JavaScript handle.
deleteLater()Schedules this handle for deferred deletion and returns this handle.
isDeleted()Returns true if this handle has already been deleted.
[dispose]()Releases this handle when the enclosing scope exits, so a handle can be declared with using instead of calling delete() later manually.
clone()Returns a new JavaScript handle aliasing the same underlying C++ object.

kind()

ts
kind(): DataKind;

Returns the kind of this data.

Returns

DataKind


modality()

ts
modality(): DataModality;

Returns the modality of this data.

Returns

DataModality


bounds()

ts
bounds(): AlignedBox;

Returns the axis-aligned bounding box of this data in world space.

Returns

AlignedBox

Once the handle to the returned object is no longer needed on the JS side, it must be released by calling delete(). Prefer declaring the variable with using so this happens automatically:

ts
using bounds = data.bounds();

Depending on the underlying data type this calling function may be computationally expensive! Do not call this method more often than needed, unless it is known that the caching behavior is implemented.

On this page