Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Atlasify

Index

Constructors

constructor

Properties

Private _atlas

_atlas: Atlas[] = []

Private _debugColor

_debugColor: number = 4278190216

Private _dirty

_dirty: number = 0

Private _exporter

_exporter: Exporter

Private _inputPaths

_inputPaths: string[]

Private _packer

_packer: MaxRectsPacker<Sheet>

Private _sheets

_sheets: Sheet[]

Private _spritesheets

_spritesheets: Spritesheet[] = []

options

options: Options

Atlasify Options class

Accessors

atlas

  • Get all atlas/image array

    note: this will only available with all async image load & packing done.

    readonly
    type

    {Atlas[]}

    memberof

    Atlasify

    Returns Atlas[]

exporter

spritesheets

  • Get all serialized spritesheets array.

    note: this will only available with all async image load & packing done.

    readonly
    type

    {Spritesheet[]}

    memberof

    Atlasify

    Returns Spritesheet[]

Methods

addBuffers

  • addBuffers(buffers: Buffer[], callback: function): void

addURLs

  • addURLs(paths: string[], callback?: undefined | function): Promise<Atlasify>
  • Add arrays of pathalike images url and do packing

    memberof

    Atlasify

    Parameters

    • paths: string[]
    • Optional callback: undefined | function

    Returns Promise<Atlasify>

Private getLeafFolder

  • getLeafFolder(pathalike: string): string | undefined

load

  • load(pathalike: string, overrides?: any): Promise<Atlasify>

Private metricFromImage

  • metricFromImage(image: Jimp, imgPath: string): void

next

  • next(): number
  • Enclose previous packing bin and start a new one.

    memberof

    Atlasify

    Returns number

pack

  • pack(callback?: undefined | function): Promise<this>
  • Parameters

    • Optional callback: undefined | function

    Returns Promise<this>

Private pruneTagIndex

  • pruneTagIndex(tagCount: object): void
  • Parameters

    • tagCount: object
      • [index: string]: number

    Returns void

save

  • save(humanReadable?: undefined | false | true): Promise<string>
  • save(humanReadable?: undefined | false | true, pathalike?: undefined | string): Promise<boolean>
  • Async serialize current project & settings to string

    memberof

    Atlasify

    Parameters

    • Optional humanReadable: undefined | false | true

    Returns Promise<string>

    }

  • Asycn save current project & settings to file

    memberof

    Atlasify

    Parameters

    • Optional humanReadable: undefined | false | true
    • Optional pathalike: undefined | string

    Returns Promise<boolean>

    }

Static Load

  • Load(pathalike: string, overrides?: any): Promise<Atlasify>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc