Skip to main content

Interface: FilamentInstanceBase

Extended by​

Properties​

entityCount​

readonly entityCount: number

Gets the number of entities returned by entities.

Defined in​

src/types/FilamentInstanceBase.ts:35

getEntities()​

getEntities: () => Entity[]

Gets the list of entities, one for each glTF node. All of these have a Transform component. Some of the returned entities may also have a Renderable component and/or a Light component.

Returns​

Entity[]

Defined in​

src/types/FilamentInstanceBase.ts:22

Methods​

createAnimator()​

createAnimator(nameComponentManager): FilamentAnimator

Parameters​

• nameComponentManager: NameComponentManager

Returns​

FilamentAnimator

Defined in​

src/types/FilamentInstanceBase.ts:16

getBoundingBox()​

getBoundingBox(): AABB

Gets the bounding box computed from the supplied min / max values in glTF accessors.

This does not return a bounding box over all FilamentInstance, it's just a straightforward AAAB that can be determined at load time from the asset data.

Returns​

AABB

Defined in​

src/types/FilamentInstanceBase.ts:30

getRoot()​

getRoot(): Entity

Gets the transform root for the asset, which has no matching glTF node.

This node exists for convenience, allowing users to transform the entire asset. For instanced assets, this is a "super root" where each of its children is a root in a particular instance. This allows users to transform all instances en masse if they wish to do so.

Returns​

Entity

Defined in​

src/types/FilamentInstanceBase.ts:14