@tawaship/pixim-animate-runtime - v0.1.0
    Preparing search index...

    Class Shape

    createjs-compatible Shape on a Pixi Graphics.

    Hierarchy (View Summary)

    Index
    _bounds: Rectangle | null
    _captureListeners: IListenerMap | null
    _listeners: IListenerMap | null
    _maskHost: Container | null

    The parent whose Pixi node holds this object's mask node

    _maskTargets: DisplayObject[]

    The objects this object masks (while they are on a display list)

    bitmapCache: ICacheState | null

    The cache createjs would draw through (filters show in Pixi without one)

    cursor: string | null
    frameBounds?: Rectangle[] | null
    hitArea: DisplayObject | null
    id: number
    mouseEnabled: boolean
    nominalBounds?: Rectangle | null

    Set only when the symbol has them (createjs leaves them undefined otherwise)

    parent: Container | null

    The Pixi node this object shows

    pixiGraphics: PixiGraphics
    shadow: null
    snapToPixel: boolean
    tickEnabled: boolean
    • get _eventParent(): EventDispatcher | null

      The parent the bubble and capture phases walk through (a display object's parent)

      Returns EventDispatcher | null

    • get _off(): boolean | undefined

      Returns boolean | undefined

    • set _off(value: boolean | undefined): void

      Parameters

      • value: boolean | undefined

      Returns void

    • get alpha(): number

      Returns number

    • set alpha(value: number): void

      Parameters

      • value: number

      Returns void

    • get compositeOperation(): string | null

      Returns string | null

    • set compositeOperation(value: string | null): void

      Parameters

      • value: string | null

      Returns void

    • get filters(): IFilterLike[] | null

      Returns IFilterLike[] | null

    • set filters(value: IFilterLike[] | null): void

      Parameters

      Returns void

    • get graphics(): Graphics | null

      Returns Graphics | null

    • set graphics(value: Graphics | null): void

      Parameters

      Returns void

    • get mask(): DisplayObject | null

      Returns DisplayObject | null

    • set mask(value: DisplayObject | null): void

      Parameters

      Returns void

    • get name(): string | null

      Returns string | null

    • set name(value: string | null): void

      Parameters

      • value: string | null

      Returns void

    • get regX(): number

      Returns number

    • set regX(value: number): void

      Parameters

      • value: number

      Returns void

    • get regY(): number

      Returns number

    • set regY(value: number): void

      Parameters

      • value: number

      Returns void

    • get rotation(): number

      Returns number

    • set rotation(value: number): void

      Parameters

      • value: number

      Returns void

    • get scaleX(): number

      Returns number

    • set scaleX(value: number): void

      Parameters

      • value: number

      Returns void

    • get scaleY(): number

      Returns number

    • set scaleY(value: number): void

      Parameters

      • value: number

      Returns void

    • get skewX(): number

      Returns number

    • set skewX(value: number): void

      Parameters

      • value: number

      Returns void

    • get skewY(): number

      Returns number

    • set skewY(value: number): void

      Parameters

      • value: number

      Returns void

    • get visible(): boolean

      Returns boolean

    • set visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get x(): number

      Returns number

    • set x(value: number): void

      Parameters

      • value: number

      Returns void

    • get y(): number

      Returns number

    • set y(value: number): void

      Parameters

      • value: number

      Returns void

    • Pixi blends per drawing node (a container has no blend mode of its own), so the composite operation in effect is set on this object's drawing node and handed down to the children

      Returns void

    • Whether this object clips when used as a mask (createjs clips only with a non-empty Graphics)

      Returns boolean

    • Phase 1 is capture, 2 the target, 3 bubbling. At the target, the capture listeners run first and then the others (createjs runs the target phase twice, the second time as phase 2.1, which reads the non-capture listeners).

      Parameters

      • event: Event
      • phase: number

      Returns void

    • The composite operation createjs draws this object with: its own, or else the nearest ancestor's (createjs sets it on the context and draws the children under it, each child saving and restoring the context)

      Returns string | null

    • createjs clips with the shape's path alone (Graphics.drawAsPath, then clip), whatever its fill and stroke; published masks are paths with no fill. The mask node is that path, filled. It is a child of the shape's node, so it moves with the shape (the shape's own node is not drawn while it serves as a mask).

      Returns Container

    • Called when this object stops being some object's Pixi mask

      Returns void

    • Blend mode for the Pixi node(s) that draw this object

      Parameters

      Returns void

    • Told by the parent when the composite operation in effect on it changes

      Parameters

      • value: string | null

      Returns void

    • createjs tick phase: dispatches the tick event to listeners

      Parameters

      Returns void

    • Sets the Pixi mask from the createjs one: Pixi masks only while the createjs mask would clip

      Returns void

    • The node is drawn unless Pixi uses it as a mask, or it is in a parent's node only to carry the mask shape of a sibling (a createjs mask is not on any display list and is not drawn itself)

      Returns void

    • Parameters

      • x: number
      • y: number
      • width: number
      • height: number
      • Optionalscale: number

      Returns void

    • Parameters

      • eventOrType: string | Event
      • Optionalbubbles: boolean
      • Optionalcancelable: boolean

      Returns boolean

    • Returns number

    • Parameters

      • type: string

      Returns boolean

    • Returns boolean

    • Parameters

      Returns void

    • Parameters

      • type: string
      • listener: TEventListener
      • Optionalscope: object
      • Optionalonce: boolean
      • Optionaldata: TEventData
      • OptionaluseCapture: boolean

      Returns TEventListener

    • Parameters

      • Optionaltype: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      • props: { [key: string]: string | number | boolean | null }

      Returns this

    • Parameters

      • x: number | null
      • Optionaly: number
      • Optionalwidth: number
      • Optionalheight: number

      Returns void

    • Parameters

      • Optionalx: number
      • Optionaly: number
      • OptionalscaleX: number
      • OptionalscaleY: number
      • Optionalrotation: number
      • OptionalskewX: number
      • OptionalskewY: number
      • OptionalregX: number
      • OptionalregY: number

      Returns this

    • Returns a string representation of an object.

      Returns string

    • Returns void

    • Returns void

    • Parameters

      • type: string

      Returns boolean