API / PixiArmatureDisplay

Class: PixiArmatureDisplay

Defined in: pixi/PixiArmatureDisplay.ts:34

The armature proxy interface, the docking engine needs to implement it concretely.

Extends

• Container<ContainerChild>

Implements

• IArmatureProxy

Constructors

Constructor

new PixiArmatureDisplay(): PixiArmatureDisplay;

Defined in: pixi/PixiArmatureDisplay.ts:45

Returns

PixiArmatureDisplay

Overrides

Container<ContainerChild>.constructor

Accessors

animation

Get Signature

get animation(): Animation;

Defined in: pixi/PixiArmatureDisplay.ts:240

The animation player.

Returns

Animation

The animation player.

Implementation of

IArmatureProxy.animation

---

armature

Get Signature

get armature(): Armature;

Defined in: pixi/PixiArmatureDisplay.ts:233

The armature.

Returns

Armature

The armature.

Implementation of

IArmatureProxy.armature

Methods

addDBEventListener()

addDBEventListener(
   type: EventStringType, 
   listener: (event: EventObject) => void, 
   target: any): void;

Defined in: pixi/PixiArmatureDisplay.ts:219

Add an event listener object so that the listener receives notification of an event.

Parameters

Parameter	Type	Description
type	EventStringType	Event type.
listener	(event: EventObject) => void	Event listener.
target	any	The listener function's "this".

Returns

void

Implementation of

IArmatureProxy.addDBEventListener

---

dbClear()

dbClear(): void;

Defined in: pixi/PixiArmatureDisplay.ts:58

Internal

Returns

void

Implementation of

IArmatureProxy.dbClear

---

dbInit()

dbInit(armature: Armature): void;

Defined in: pixi/PixiArmatureDisplay.ts:51

Internal

Parameters

Parameter	Type
armature	Armature

Returns

void

Implementation of

IArmatureProxy.dbInit

---

dbUpdate()

dbUpdate(): void;

Defined in: pixi/PixiArmatureDisplay.ts:73

Internal

Returns

void

Implementation of

IArmatureProxy.dbUpdate

---

destroy()

destroy(): void;

Defined in: pixi/PixiArmatureDisplay.ts:196

Returns

void

Inherit Doc

Overrides

Container.destroy

---

dispose()

dispose(disposeProxy: boolean): void;

Defined in: pixi/PixiArmatureDisplay.ts:184

Dispose the instance and the Armature instance. (The Armature instance will return to the object pool)

Parameters

Parameter	Type	Default value
disposeProxy	boolean	true

Returns

void

Example

    removeChild(armatureDisplay);
    armatureDisplay.dispose();

Implementation of

IArmatureProxy.dispose

---

hasDBEventListener()

hasDBEventListener(type: EventStringType): boolean;

Defined in: pixi/PixiArmatureDisplay.ts:210

Checks whether the object has any listeners registered for a specific type of event。

Parameters

Parameter	Type	Description
type	EventStringType	Event type.

Returns

boolean

Implementation of

IArmatureProxy.hasDBEventListener

---

removeDBEventListener()

removeDBEventListener(
   type: EventStringType, 
   listener: (event: EventObject) => void, 
   target: any): void;

Defined in: pixi/PixiArmatureDisplay.ts:226

Removes a listener from the object.

Parameters

Parameter	Type	Description
type	EventStringType	Event type.
listener	(event: EventObject) => void	Event listener.
target	any	The listener function's "this".

Returns

void

Implementation of

IArmatureProxy.removeDBEventListener