Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Rectangle
    • Sheet

Implements

  • IRectangle

Index

Constructors

constructor

  • new Sheet(width?: number, height?: number, x?: number, y?: number, rot?: boolean): Sheet
  • Creates an instance of Sheet extends Rectangle from MaxrectsPacker

    memberof

    Sheet

    Parameters

    • Default value width: number = 0
    • Default value height: number = 0
    • Default value x: number = 0
    • Default value y: number = 0
    • Default value rot: boolean = false

    Returns Sheet

Properties

Protected _allowRotation

_allowRotation: boolean | undefined

Private _border

_border: number = 0

Protected _data

_data: any

Protected _dirty

_dirty: number

Private _hash

_hash: string = ""

Protected _height

_height: number

Private _imageDirty

_imageDirty: number = 0

Protected _rot

_rot: boolean

Private _rotated

_rotated: boolean = false

Protected _width

_width: number

Protected _x

_x: number

Protected _y

_y: number

anchor

anchor: Vec2

anchor/pivot point

type

{Vec2}

memberof

Sheet

dummy

dummy: string[] = []

Dummy tag which represent a clone of other sheet

type

{boolean}

memberof

Sheet

frame

frame: Rectangle

frame rectangle to be rendered to final atlas

type

{Rectangle}

memberof

Sheet

last

last: boolean = false

for controlling mustache template trailing comma, don't touch

type

{boolean}

memberof

Sheet

name

name: string = ""

sprite name, normally filename before packing

if Atlasify.Options.basenameOnly = true there will be no extension.

if Atlasify.Options.appendPath = true name will include relative path.

type

{string}

memberof

Sheet

nineSliceFrame

nineSliceFrame: Rectangle

9-sliced center rectangle

type

{Rectangle}

memberof

Sheet

oversized

oversized: boolean

Oversized tag on rectangle which is bigger than packer itself.

type

{boolean}

memberof

Rectangle

sourceFrame

sourceFrame: Rectangle

orignal source rectangle

x and y refer to the negative offset from the frame rectangle

type

{Rectangle}

memberof

Sheet

Optional tag

tag: undefined | string

tag of group packing

type

{string}

memberof

Sheet

trimmed

trimmed: boolean = false

alpha trimmed

type

{boolean}

memberof

Sheet

url

url: string = ""

path/url to the source image

type

{string}

memberof

Sheet

Accessors

allowRotation

  • get allowRotation(): boolean | undefined
  • set allowRotation(value: boolean | undefined): any
  • If the rectangle allow rotation

    type

    {boolean}

    memberof

    Rectangle

    Returns boolean | undefined

  • Set the allowRotation tag of the rectangle.

    memberof

    Rectangle

    Parameters

    • value: boolean | undefined

    Returns any

data

  • get data(): Jimp
  • set data(value: Jimp): void
  • image data object

    type

    {Jimp}

    memberof

    Sheet

    Returns Jimp

  • image data object

    Parameters

    • value: Jimp

    Returns void

dirty

  • get dirty(): boolean
  • Returns boolean

hash

  • get hash(): string
  • hash string generated from image, for identifing

    type

    {string}

    memberof

    Sheet

    Returns string

height

  • get height(): number
  • set height(value: number): any
  • Returns number

  • Parameters

    • value: number

    Returns any

rot

  • get rot(): boolean
  • set rot(value: boolean): void
  • Status from packer whether Sheet should be rotated.

    note: if rot set to true, image data will be rotated automaticlly, and width/height is swaped.

    type

    {boolean}

    memberof

    Sheet

    Returns boolean

  • Status from packer whether Sheet should be rotated.

    note: if rot set to true, image data will be rotated automaticlly, and width/height is swaped.

    Parameters

    • value: boolean

    Returns void

width

  • get width(): number
  • set width(value: number): any
  • Returns number

  • Parameters

    • value: number

    Returns any

x

  • get x(): number
  • set x(value: number): void

y

  • get y(): number
  • set y(value: number): void

Methods

Private alphaScanner

  • alphaScanner(forward?: boolean, horizontal?: boolean, tolerance?: number): number
  • Parameters

    • Default value forward: boolean = true
    • Default value horizontal: boolean = true
    • Default value tolerance: number = 0

    Returns number

area

  • area(): number
  • Get the area (w * h) of the rectangle

    memberof

    Rectangle

    Returns number

collide

  • collide(rect: IRectangle): boolean
  • Test if the given rectangle collide with this rectangle.

    memberof

    Rectangle

    Parameters

    • rect: IRectangle

    Returns boolean

contain

  • contain(rect: IRectangle): boolean
  • Test if this rectangle contains the given rectangle.

    memberof

    Rectangle

    Parameters

    • rect: IRectangle

    Returns boolean

extrude

  • extrude(border: number): void
  • Extrude edge pixels. Should trimAlpha first

    memberof

    Sheet

    Parameters

    • border: number

      extrude pixels

    Returns void

Private getChannelIndex

  • getChannelIndex(x: number, y: number, offset?: number): number
  • Parameters

    • x: number
    • y: number
    • Default value offset: number = 3

    Returns number

parse

  • parse(data: object, target?: object): this
  • Load sheet settings from json object

    memberof

    Sheet

    Parameters

    • data: object
    • Default value target: object = this

    Returns this

rotate

  • rotate(clockwise?: boolean): void
  • Rotate image data 90-degree CW, and swap width/height

    note: rotate is done automaticly when Sheet.rot set to true, normally you don't need to do this manually unless you know what you are doing.

    memberof

    Sheet

    Parameters

    • Default value clockwise: boolean = true

    Returns void

serialize

  • serialize(): object

setDirty

  • setDirty(value?: undefined | false | true): void
  • Parameters

    • Optional value: undefined | false | true

    Returns void

trimAlpha

  • trimAlpha(tolerance?: number): void
  • Crop surrounding transparent pixels

    memberof

    Sheet

    Parameters

    • Default value tolerance: number = 0

    Returns void

Static Collide

  • Collide(first: IRectangle, second: IRectangle): any
  • Test if two given rectangle collide each other

    static
    memberof

    Rectangle

    Parameters

    • first: IRectangle
    • second: IRectangle

    Returns any

Static Contain

  • Contain(first: IRectangle, second: IRectangle): any
  • Test if the first rectangle contains the second one

    static
    memberof

    Rectangle

    Parameters

    • first: IRectangle
    • second: IRectangle

    Returns any

Static Factory

  • Factory(data: any): Sheet

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