Class InstancingHandler

Handles instancing for Needle Engine.

Index

Constructors

Methods

setup getStartInstanceCount

Constructors

constructor

new InstancingHandler(): InstancingHandler
Returns InstancingHandler

Methods

setup

setup(
    renderer: Renderer,
    obj: Object3D,
    context: Context,
    handlesArray: null | InstanceHandle[],
    args: InstancingSetupArgs,
    level?: number,
): null | InstanceHandle[]
Parameters
- renderer: Renderer
- obj: Object3D
- context: Context
- handlesArray: null | InstanceHandle[]
- args: InstancingSetupArgs
- level: number = 0
Returns null | InstanceHandle[]

`Static`getStartInstanceCount

getStartInstanceCount(_obj: Object3D): number
This is the initial instance count when creating a new instancing structure.
Override this and the number of max instances that you expect for a given object. The larger the value the more objects can be added without having to resize but it will also consume more memory.
(The instancing mesh renderer will grow x2 if the max instance count is reached)
Parameters
- _obj: Object3D
Returns number
The initial instance count
Default
```
4
```