Class SpriteManager

constructor

• new SpriteManager(
      name: string,
      imgUrl: string,
      capacity: number,
      cellSize: any,
      scene: Scene,
      epsilon?: number,
      samplingMode?: number,
      fromPacked?: boolean,
      spriteJSON?: string | null,
      options?: SpriteManagerOptions,
  ): SpriteManager

  Creates a new sprite manager

  Parameters

  • name: string

    defines the manager's name

  • imgUrl: string

    defines the sprite sheet url

  • capacity: number

    defines the maximum allowed number of sprites

  • cellSize: any

    defines the size of a sprite cell

  • scene: Scene

    defines the hosting scene

  • epsilon: number = 0.01

    defines the epsilon value to align texture (0.01 by default)

  • samplingMode: number = Texture.TRILINEAR_SAMPLINGMODE

    defines the sampling mode to use with spritesheet

  • fromPacked: boolean = false

    set to false; do not alter

  • spriteJSON: string | null = null

    null otherwise a JSON object defining sprite sheet data; do not alter

  • Optionaloptions: SpriteManagerOptions

    options used to create the SpriteManager instance

  Returns SpriteManager

doNotSerialize

isPickable

layerMask

metadata

name

onDisposeObservable

renderingGroupId

snippetId

sprites

uniqueId

StaticCreateFromSnippetAsync

StaticSnippetUrl

blendMode

• get blendMode(): number

  Blend mode use to render the particle, it can be any of the static Constants.ALPHA_x properties provided in this class. Default value is Constants.ALPHA_COMBINE

  Returns number

• set blendMode(blendMode: number): void

  Parameters

  • blendMode: number

  Returns void

capacity

• get capacity(): number

  Gets the capacity of the manager

  Returns number

cellHeight

• get cellHeight(): number

  Defines the default height of a cell in the spritesheet

  Returns number

• set cellHeight(value: number): void

  Defines the default height of a cell in the spritesheet

  Parameters

  • value: number

  Returns void

cellWidth

• get cellWidth(): number

  Defines the default width of a cell in the spritesheet

  Returns number

• set cellWidth(value: number): void

  Defines the default width of a cell in the spritesheet

  Parameters

  • value: number

  Returns void

children

• get children(): Sprite[]

  Gets the array of sprites

  Returns Sprite[]

disableDepthWrite

• get disableDepthWrite(): boolean

  Disables writing to the depth buffer when rendering the sprites. It can be handy to disable depth writing when using textures without alpha channel and setting some specific blend modes.

  Returns boolean

• set disableDepthWrite(value: boolean): void

  Parameters

  • value: boolean

  Returns void

fogEnabled

• get fogEnabled(): boolean

  Gets or sets a boolean indicating if the manager must consider scene fog when rendering

  Returns boolean

• set fogEnabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

onDispose

• set onDispose(callback: () => void): void

  Callback called when the manager is disposed

  Parameters

  • callback: () => void

  Returns void

pixelPerfect

• get pixelPerfect(): boolean

  Gets or sets a boolean indicating if the renderer must render sprites with pixel perfect rendering In this mode, sprites are rendered as "pixel art", which means that they appear as pixelated but remain stable when moving or when rotated or scaled. Note that for this mode to work as expected, the sprite texture must use the BILINEAR sampling mode, not NEAREST!

  Returns boolean

• set pixelPerfect(value: boolean): void

  Parameters

  • value: boolean

  Returns void

scene

• get scene(): InternalSpriteAugmentedScene

  Gets the hosting scene

  Returns InternalSpriteAugmentedScene

spriteRenderer

• get spriteRenderer(): SpriteRenderer

  Gets the sprite renderer associated with this manager

  Returns SpriteRenderer

texture

• get texture(): Texture

  Gets or sets the spritesheet texture

  Returns Texture

• set texture(value: Texture): void

  Gets or sets the spritesheet texture

  Parameters

  • value: Texture

  Returns void

useLogarithmicDepth

• get useLogarithmicDepth(): boolean

  Gets or sets a boolean indicating if the manager must use logarithmic depth when rendering

  Returns boolean

• set useLogarithmicDepth(value: boolean): void

  Parameters

  • value: boolean

  Returns void

dispose

• dispose(): void

  Release associated resources

  Returns void

getClassName

• getClassName(): string

  Returns the string "SpriteManager"

  Returns string

  "SpriteManager"

intersects

• intersects(
      ray: Ray,
      camera: Camera,
      predicate?: (sprite: Sprite) => boolean,
      fastCheck?: boolean,
  ): Nullable<PickingInfo>

  Intersects the sprites with a ray

  Parameters

  • ray: Ray

    defines the ray to intersect with

  • camera: Camera

    defines the current active camera

  • Optionalpredicate: (sprite: Sprite) => boolean

    defines a predicate used to select candidate sprites

  • OptionalfastCheck: boolean

    defines if a fast check only must be done (the first potential sprite is will be used and not the closer)

  Returns Nullable<PickingInfo>

  null if no hit or a PickingInfo

isReady

• isReady(): boolean

  Checks whether the sprite data, texture and current render-pass shader are ready. An empty sprite manager is ready without preparing rendering resources.

  Returns boolean

  true when all required resources are ready

  See

  https://playground.babylonjs.com/#PVK3RV#2

multiIntersects

• multiIntersects(
      ray: Ray,
      camera: Camera,
      predicate?: (sprite: Sprite) => boolean,
  ): Nullable<PickingInfo[]>

  Intersects the sprites with a ray

  Parameters

  • ray: Ray

    defines the ray to intersect with

  • camera: Camera

    defines the current active camera

  • Optionalpredicate: (sprite: Sprite) => boolean

    defines a predicate used to select candidate sprites

  Returns Nullable<PickingInfo[]>

  null if no hit or a PickingInfo array

rebuild

• rebuild(): void

  Rebuilds the manager (after a context lost, for eg)

  Returns void

render

• render(): void

  Render all child sprites

  Returns void

serialize

• serialize(serializeTexture?: boolean): any

  Serializes the sprite manager to a JSON object

  Parameters

  • serializeTexture: boolean = false

    defines if the texture must be serialized as well

  Returns any

  the JSON object

StaticParse

• Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager

  Parses a JSON object to create a new sprite manager.

  Parameters

  • parsedManager: any

    The JSON object to parse

  • scene: Scene

    The scene to create the sprite manager

  • rootUrl: string

    The root url to use to load external dependencies like texture

  Returns SpriteManager

  the new sprite manager

StaticParseFromFileAsync

• ParseFromFileAsync(
      name: Nullable<string>,
      url: string,
      scene: Scene,
      rootUrl?: string,
  ): Promise<SpriteManager>

  Creates a sprite manager from a snippet saved in a remote file

  Parameters

  • name: Nullable<string>

    defines the name of the sprite manager to create (can be null or empty to use the one from the json data)

  • url: string

    defines the url to load from

  • scene: Scene

    defines the hosting scene

  • rootUrl: string = ""

    defines the root URL to use to load textures and relative dependencies

  Returns Promise<SpriteManager>

  a promise that will resolve to the new sprite manager

StaticParseFromSnippetAsync

• ParseFromSnippetAsync(
      snippetId: string,
      scene: Scene,
      rootUrl?: string,
  ): Promise<SpriteManager>

  Creates a sprite manager from a snippet saved by the sprite editor

  Parameters

  • snippetId: string

    defines the snippet to load (can be set to _BLANK to create a default one)

  • scene: Scene

    defines the hosting scene

  • rootUrl: string = ""

    defines the root URL to use to load textures and relative dependencies

  Returns Promise<SpriteManager>

  a promise that will resolve to the new sprite manager