Class BatchGroup

Holds mesh batching settings and a unique id. Created via BatchManager#addGroup.

Constructors

constructor

Properties

_obj _sprite _ui dynamic id layers maxAabbSize name

Constructors

constructor

  • new BatchGroup(id, name, dynamic, maxAabbSize, layers?): BatchGroup

  • Create a new BatchGroup instance.

    Parameters

    • id: number

      Unique id. Can be assigned to model, render and element components.

    • name: string

      The name of the group.

    • dynamic: boolean

      Whether objects within this batch group should support transforming at runtime.

    • maxAabbSize: number

      Maximum size of any dimension of a bounding box around batched objects. BatchManager#prepare will split objects into local groups based on this size.

    • Optional layers: number[] = ...

      Layer ID array. Default is [LAYERID_WORLD]. The whole batch group will belong to these layers. Layers of source models will be ignored.

    Returns BatchGroup

Properties

Private _obj

_obj: {
    element: any[];
    model: any[];
    render: any[];
    sprite: any[];
} = ...

Type declaration

  • element: any[]
  • model: any[]
  • render: any[]
  • sprite: any[]

Private _sprite

_sprite: boolean = false

Private _ui

_ui: boolean = false

dynamic

dynamic: boolean

Whether objects within this batch group should support transforming at runtime.

id

id: number

Unique id. Can be assigned to model, render and element components.

layers

layers: number[]

Layer ID array. Default is [LAYERID_WORLD]. The whole batch group will belong to these layers. Layers of source models will be ignored.

maxAabbSize

maxAabbSize: number

Maximum size of any dimension of a bounding box around batched objects. BatchManager#prepare will split objects into local groups based on this size.

name

name: string

Name of the group.

Settings

Member Visibility

Theme

On This Page

constructor_obj_sprite_uidynamicidlayersmaxAabbSizename