API / IArmatureProxy

Interface: IArmatureProxy

Defined in: armature/IArmatureProxy.ts:36

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

Extends

• IEventDispatcher

Properties

animation

readonly animation: Animation;

Defined in: armature/IArmatureProxy.ts:77

The animation player.

---

armature

readonly armature: Armature;

Defined in: armature/IArmatureProxy.ts:69

The armature.

Methods

addDBEventListener()

addDBEventListener(
   type: EventStringType, 
   listener: Function, 
   thisObject: any): void;

Defined in: event/IEventDispatcher.ts:84

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

Parameters

Parameter	Type	Description
type	EventStringType	Event type.
listener	Function	Event listener.
thisObject	any	The listener function's "this".

Returns

void

Inherited from

IEventDispatcher.addDBEventListener

---

dbClear()

dbClear(): void;

Defined in: armature/IArmatureProxy.ts:44

Internal

Returns

void

---

dbInit()

dbInit(armature: Armature): void;

Defined in: armature/IArmatureProxy.ts:40

Internal

Parameters

Parameter	Type
armature	Armature

Returns

void

---

dbUpdate()

dbUpdate(): void;

Defined in: armature/IArmatureProxy.ts:48

Internal

Returns

void

---

dispatchDBEvent()

dispatchDBEvent(type: EventStringType, eventObject: EventObject): void;

Defined in: event/IEventDispatcher.ts:67

Dispatches an event into the event flow.

Parameters

Parameter	Type	Description
type	EventStringType	Event type.
eventObject	EventObject	Event object.

Returns

void

Inherited from

IEventDispatcher.dispatchDBEvent

---

dispose()

dispose(disposeProxy: boolean): void;

Defined in: armature/IArmatureProxy.ts:61

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

Parameters

Parameter	Type
disposeProxy	boolean

Returns

void

Example

    removeChild(armatureDisplay);
    armatureDisplay.dispose();

---

hasDBEventListener()

hasDBEventListener(type: EventStringType): boolean;

Defined in: event/IEventDispatcher.ts:52

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

Parameters

Parameter	Type	Description
type	EventStringType	Event type.

Returns

boolean

Inherited from

IEventDispatcher.hasDBEventListener

---

removeDBEventListener()

removeDBEventListener(
   type: EventStringType, 
   listener: Function, 
   thisObject: any): void;

Defined in: event/IEventDispatcher.ts:101

Removes a listener from the object.

Parameters

Parameter	Type	Description
type	EventStringType	Event type.
listener	Function	Event listener.
thisObject	any	The listener function's "this".

Returns

void

Inherited from

IEventDispatcher.removeDBEventListener