Home

class: AccessibilityManager

The Accessibility manager reacreates the ability to tab and and have content read by screen
readers. This is very important as it can possibly help people with disabilities access pixi
content.

Much like interaction any DisplayObject can be made accessible. This manager will map the
events as if the mouse was being used, minimizing the efferot required to implement.

An instance of this class is automatically created by default, and can be found at renderer.plugins.accessibility

Methods summary

Public methods
public	createTouchHook(): void
private	activate(): void
private	deactivate(): void
private	updateAccessibleObjects(displayObject: PIXI.Container): void
private	update(): void
public	capHitArea(hitArea: Rectangle): void
private	addChild(displayObject: DisplayObject): void
private	_onClick(e: MouseEvent): void
private	_onFocus(e: FocusEvent): void
private	_onFocusOut(e: FocusEvent): void
private	_onKeyDown(e: KeyboardEvent): void
private	_onMouseMove(): void
public	destroy(): void
public	createTouchHook(): void
private	activate(): void
private	deactivate(): void
private	updateAccessibleObjects(displayObject: PIXI.Container): void
private	update(): void
public	capHitArea(hitArea: Rectangle): void
private	addChild(displayObject: DisplayObject): void
private	_onClick(e: MouseEvent): void
private	_onFocus(e: FocusEvent): void
private	_onFocusOut(e: FocusEvent): void
private	_onKeyDown(e: KeyboardEvent): void
private	_onMouseMove(): void
public	destroy(): void

Properties

Name	Type	Attribute	Description
renderer	PIXI.SystemRenderer	public	The renderer this accessibility manager works for.
children	Array.<*>	private	The array of currently active accessible items.
isActive	Array.<*>	private	stores the state of the manager. If there are no accessible objects or the mouse is moving the will be false.
renderer	PIXI.SystemRenderer	public	The renderer this accessibility manager works for.
children	Array.<*>	private	The array of currently active accessible items.
isActive	Array.<*>	private	stores the state of the manager. If there are no accessible objects or the mouse is moving the will be false.

Methods

createTouchHook(): void

accessibility\AccessibilityManager.js, line 131

Creates the touch hooks.

Returns:

void

activate(): void

accessibility\AccessibilityManager.js, line 160

Activating will cause the Accessibility layer to be shown. This is called when a user
preses the tab key

Returns:

void

deactivate(): void

accessibility\AccessibilityManager.js, line 186

Deactivating will cause the Accessibility layer to be hidden. This is called when a user moves
the mouse

Returns:

void

updateAccessibleObjects(displayObject: PIXI.Container): void

accessibility\AccessibilityManager.js, line 212

This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer.

Params:

Name	Type	Attribute	Description
displayObject			The DisplayObject to check.

Returns:

void

update(): void

accessibility\AccessibilityManager.js, line 242

Before each render this function will ensure that all divs are mapped correctly to their DisplayObjects.

Returns:

void

capHitArea(hitArea: Rectangle): void

accessibility\AccessibilityManager.js, line 322

TODO: docs.

Params:

Name	Type	Attribute	Description
hitArea			TODO docs

Returns:

void

addChild(displayObject: DisplayObject): void

accessibility\AccessibilityManager.js, line 353

Adds a DisplayObject to the accessibility manager

Params:

Name	Type	Attribute	Description
displayObject			The child to make accessible.

Returns:

void

_onClick(e: MouseEvent): void

accessibility\AccessibilityManager.js, line 406

Maps the div button press to pixi's InteractionManager (click)

Params:

Name	Type	Attribute	Description
e			The click event.

Returns:

void

_onFocus(e: FocusEvent): void

accessibility\AccessibilityManager.js, line 419

Maps the div focus events to pixis InteractionManager (mouseover)

Params:

Name	Type	Attribute	Description
e			The focus event.

Returns:

void

_onFocusOut(e: FocusEvent): void

accessibility\AccessibilityManager.js, line 432

Maps the div focus events to pixis InteractionManager (mouseout)

Params:

Name	Type	Attribute	Description
e			The focusout event.

Returns:

void

_onKeyDown(e: KeyboardEvent): void

accessibility\AccessibilityManager.js, line 445

Is called when a key is pressed

Params:

Name	Type	Attribute	Description
e			The keydown event.

Returns:

void

_onMouseMove(): void

accessibility\AccessibilityManager.js, line 460

Is called when the mouse moves across the renderer element

Returns:

void

destroy(): void

accessibility\AccessibilityManager.js, line 469

Destroys the accessibility manager

Returns:

void

createTouchHook(): void

accessibility\AccessibilityManager.js, line 131

Creates the touch hooks.

Returns:

void

activate(): void

accessibility\AccessibilityManager.js, line 160

Activating will cause the Accessibility layer to be shown. This is called when a user
preses the tab key

Returns:

void

deactivate(): void

accessibility\AccessibilityManager.js, line 186

Deactivating will cause the Accessibility layer to be hidden. This is called when a user moves
the mouse

Returns:

void

updateAccessibleObjects(displayObject: PIXI.Container): void

accessibility\AccessibilityManager.js, line 212

This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer.

Params:

Name	Type	Attribute	Description
displayObject			The DisplayObject to check.

Returns:

void

update(): void

accessibility\AccessibilityManager.js, line 242

Before each render this function will ensure that all divs are mapped correctly to their DisplayObjects.

Returns:

void

capHitArea(hitArea: Rectangle): void

accessibility\AccessibilityManager.js, line 322

TODO: docs.

Params:

Name	Type	Attribute	Description
hitArea			TODO docs

Returns:

void

addChild(displayObject: DisplayObject): void

accessibility\AccessibilityManager.js, line 353

Adds a DisplayObject to the accessibility manager

Params:

Name	Type	Attribute	Description
displayObject			The child to make accessible.

Returns:

void

_onClick(e: MouseEvent): void

accessibility\AccessibilityManager.js, line 406

Maps the div button press to pixi's InteractionManager (click)

Params:

Name	Type	Attribute	Description
e			The click event.

Returns:

void

_onFocus(e: FocusEvent): void

accessibility\AccessibilityManager.js, line 419

Maps the div focus events to pixis InteractionManager (mouseover)

Params:

Name	Type	Attribute	Description
e			The focus event.

Returns:

void

_onFocusOut(e: FocusEvent): void

accessibility\AccessibilityManager.js, line 432

Maps the div focus events to pixis InteractionManager (mouseout)

Params:

Name	Type	Attribute	Description
e			The focusout event.

Returns:

void

_onKeyDown(e: KeyboardEvent): void

accessibility\AccessibilityManager.js, line 445

Is called when a key is pressed

Params:

Name	Type	Attribute	Description
e			The keydown event.

Returns:

void

_onMouseMove(): void

accessibility\AccessibilityManager.js, line 460

Is called when the mouse moves across the renderer element

Returns:

void

destroy(): void

accessibility\AccessibilityManager.js, line 469

Destroys the accessibility manager

Returns:

void

{ "comment": "/**\n * The Accessibility manager reacreates the ability to tab and and have content read by screen\n * readers. This is very important as it can possibly help people with disabilities access pixi\n * content.\n *\n * Much like interaction any DisplayObject can be made accessible. This manager will map the\n * events as if the mouse was being used, minimizing the efferot required to implement.\n *\n * An instance of this class is automatically created by default, and can be found at renderer.plugins.accessibility\n *\n * @class\n * @memberof PIXI.accessibility\n */", "meta": { "range": [ 1101, 13301 ], "filename": "AccessibilityManager.js", "lineno": 38, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100000068", "name": "AccessibilityManager", "type": "ClassDeclaration", "paramnames": [ "renderer" ] } }, "classdesc": "

The Accessibility manager reacreates the ability to tab and and have content read by screen
readers. This is very important as it can possibly help people with disabilities access pixi
content.

Much like interaction any DisplayObject can be made accessible. This manager will map the
events as if the mouse was being used, minimizing the efferot required to implement.

An instance of this class is automatically created by default, and can be found at renderer.plugins.accessibility

", "kind": "class", "memberof": "PIXI.accessibility", "name": "AccessibilityManager", "longname": "PIXI.accessibility.AccessibilityManager", "scope": "static", "params": [ { "type": { "names": [ "PIXI.CanvasRenderer", "PIXI.WebGLRenderer" ] }, "description": "

A reference to the current renderer

", "name": "renderer" } ], "___id": "T000002R000012", "___s": true, "$methods": [ { "comment": "/**\n * Creates the touch hooks.\n *\n */", "meta": { "range": [ 3766, 4483 ], "filename": "AccessibilityManager.js", "lineno": 131, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100000245", "name": "AccessibilityManager#createTouchHook", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Creates the touch hooks.

", "name": "createTouchHook", "longname": "PIXI.accessibility.AccessibilityManager#createTouchHook", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R000034", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagercreateTouchHook", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Activating will cause the Accessibility layer to be shown. This is called when a user\n * preses the tab key\n *\n * @private\n */", "meta": { "range": [ 4647, 5108 ], "filename": "AccessibilityManager.js", "lineno": 160, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100000366", "name": "AccessibilityManager#activate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Activating will cause the Accessibility layer to be shown. This is called when a user
preses the tab key

", "access": "private", "name": "activate", "longname": "PIXI.accessibility.AccessibilityManager#activate", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R000045", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManageractivate", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Deactivating will cause the Accessibility layer to be hidden. This is called when a user moves\n * the mouse\n *\n * @private\n */", "meta": { "range": [ 5272, 5737 ], "filename": "AccessibilityManager.js", "lineno": 186, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100000439", "name": "AccessibilityManager#deactivate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Deactivating will cause the Accessibility layer to be hidden. This is called when a user moves
the mouse

", "access": "private", "name": "deactivate", "longname": "PIXI.accessibility.AccessibilityManager#deactivate", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R000047", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerdeactivate", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer.\n *\n * @private\n * @param {PIXI.Container} displayObject - The DisplayObject to check.\n */", "meta": { "range": [ 5974, 6546 ], "filename": "AccessibilityManager.js", "lineno": 212, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100000511", "name": "AccessibilityManager#updateAccessibleObjects", "type": "MethodDefinition", "paramnames": [ "displayObject" ] }, "vars": { "": null } }, "description": "

This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer.

", "access": "private", "params": [ { "type": { "names": [ "PIXI.Container" ] }, "description": "

The DisplayObject to check.

", "name": "displayObject" } ], "name": "updateAccessibleObjects", "longname": "PIXI.accessibility.AccessibilityManager#updateAccessibleObjects", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R000049", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerupdateAccessibleObjects", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Before each render this function will ensure that all divs are mapped correctly to their DisplayObjects.\n *\n * @private\n */", "meta": { "range": [ 6703, 8994 ], "filename": "AccessibilityManager.js", "lineno": 242, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100000581", "name": "AccessibilityManager#update", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Before each render this function will ensure that all divs are mapped correctly to their DisplayObjects.

", "access": "private", "name": "update", "longname": "PIXI.accessibility.AccessibilityManager#update", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R000053", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerupdate", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * TODO: docs.\n *\n * @param {Rectangle} hitArea - TODO docs\n */", "meta": { "range": [ 9088, 9639 ], "filename": "AccessibilityManager.js", "lineno": 322, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100000981", "name": "AccessibilityManager#capHitArea", "type": "MethodDefinition", "paramnames": [ "hitArea" ] }, "vars": { "": null } }, "description": "

TODO: docs.

", "params": [ { "type": { "names": [ "Rectangle" ] }, "description": "

TODO docs

", "name": "hitArea" } ], "name": "capHitArea", "longname": "PIXI.accessibility.AccessibilityManager#capHitArea", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R000078", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagercapHitArea", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Adds a DisplayObject to the accessibility manager\n *\n * @private\n * @param {DisplayObject} displayObject - The child to make accessible.\n */", "meta": { "range": [ 9817, 11300 ], "filename": "AccessibilityManager.js", "lineno": 353, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100001086", "name": "AccessibilityManager#addChild", "type": "MethodDefinition", "paramnames": [ "displayObject" ] }, "vars": { "": null } }, "description": "

Adds a DisplayObject to the accessibility manager

", "access": "private", "params": [ { "type": { "names": [ "DisplayObject" ] }, "description": "

The child to make accessible.

", "name": "displayObject" } ], "name": "addChild", "longname": "PIXI.accessibility.AccessibilityManager#addChild", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R000085", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManageraddChild", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Maps the div button press to pixi's InteractionManager (click)\n *\n * @private\n * @param {MouseEvent} e - The click event.\n */", "meta": { "range": [ 11463, 11662 ], "filename": "AccessibilityManager.js", "lineno": 406, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100001305", "name": "AccessibilityManager#_onClick", "type": "MethodDefinition", "paramnames": [ "e" ] }, "vars": { "": null } }, "description": "

Maps the div button press to pixi's InteractionManager (click)

", "access": "private", "params": [ { "type": { "names": [ "MouseEvent" ] }, "description": "

The click event.

", "name": "e" } ], "name": "_onClick", "longname": "PIXI.accessibility.AccessibilityManager#_onClick", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R000100", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManager_onClick", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Maps the div focus events to pixis InteractionManager (mouseover)\n *\n * @private\n * @param {FocusEvent} e - The focus event.\n */", "meta": { "range": [ 11828, 12031 ], "filename": "AccessibilityManager.js", "lineno": 419, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100001334", "name": "AccessibilityManager#_onFocus", "type": "MethodDefinition", "paramnames": [ "e" ] }, "vars": { "": null } }, "description": "

Maps the div focus events to pixis InteractionManager (mouseover)

", "access": "private", "params": [ { "type": { "names": [ "FocusEvent" ] }, "description": "

The focus event.

", "name": "e" } ], "name": "_onFocus", "longname": "PIXI.accessibility.AccessibilityManager#_onFocus", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R000102", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManager_onFocus", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Maps the div focus events to pixis InteractionManager (mouseout)\n *\n * @private\n * @param {FocusEvent} e - The focusout event.\n */", "meta": { "range": [ 12199, 12404 ], "filename": "AccessibilityManager.js", "lineno": 432, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100001363", "name": "AccessibilityManager#_onFocusOut", "type": "MethodDefinition", "paramnames": [ "e" ] }, "vars": { "": null } }, "description": "

Maps the div focus events to pixis InteractionManager (mouseout)

", "access": "private", "params": [ { "type": { "names": [ "FocusEvent" ] }, "description": "

The focusout event.

", "name": "e" } ], "name": "_onFocusOut", "longname": "PIXI.accessibility.AccessibilityManager#_onFocusOut", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R000104", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManager_onFocusOut", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Is called when a key is pressed\n *\n * @private\n * @param {KeyboardEvent} e - The keydown event.\n */", "meta": { "range": [ 12541, 12672 ], "filename": "AccessibilityManager.js", "lineno": 445, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100001392", "name": "AccessibilityManager#_onKeyDown", "type": "MethodDefinition", "paramnames": [ "e" ] }, "vars": { "": null } }, "description": "

Is called when a key is pressed

", "access": "private", "params": [ { "type": { "names": [ "KeyboardEvent" ] }, "description": "

The keydown event.

", "name": "e" } ], "name": "_onKeyDown", "longname": "PIXI.accessibility.AccessibilityManager#_onKeyDown", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R000106", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManager_onKeyDown", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Is called when the mouse moves across the renderer element\n *\n * @private\n */", "meta": { "range": [ 12783, 12836 ], "filename": "AccessibilityManager.js", "lineno": 460, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100001410", "name": "AccessibilityManager#_onMouseMove", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Is called when the mouse moves across the renderer element

", "access": "private", "name": "_onMouseMove", "longname": "PIXI.accessibility.AccessibilityManager#_onMouseMove", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R000107", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManager_onMouseMove", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Destroys the accessibility manager\n *\n */", "meta": { "range": [ 12907, 13299 ], "filename": "AccessibilityManager.js", "lineno": 469, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100001419", "name": "AccessibilityManager#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroys the accessibility manager

", "name": "destroy", "longname": "PIXI.accessibility.AccessibilityManager#destroy", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R000108", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerdestroy", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Creates the touch hooks.\n *\n */", "meta": { "range": [ 3766, 4483 ], "filename": "AccessibilityManager.js", "lineno": 131, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100074924", "name": "AccessibilityManager#createTouchHook", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Creates the touch hooks.

", "name": "createTouchHook", "longname": "PIXI.accessibility.AccessibilityManager#createTouchHook", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R006968", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagercreateTouchHook", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Activating will cause the Accessibility layer to be shown. This is called when a user\n * preses the tab key\n *\n * @private\n */", "meta": { "range": [ 4647, 5108 ], "filename": "AccessibilityManager.js", "lineno": 160, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100075045", "name": "AccessibilityManager#activate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Activating will cause the Accessibility layer to be shown. This is called when a user
preses the tab key

", "access": "private", "name": "activate", "longname": "PIXI.accessibility.AccessibilityManager#activate", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R006979", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManageractivate", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Deactivating will cause the Accessibility layer to be hidden. This is called when a user moves\n * the mouse\n *\n * @private\n */", "meta": { "range": [ 5272, 5737 ], "filename": "AccessibilityManager.js", "lineno": 186, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100075118", "name": "AccessibilityManager#deactivate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Deactivating will cause the Accessibility layer to be hidden. This is called when a user moves
the mouse

", "access": "private", "name": "deactivate", "longname": "PIXI.accessibility.AccessibilityManager#deactivate", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R006981", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerdeactivate", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer.\n *\n * @private\n * @param {PIXI.Container} displayObject - The DisplayObject to check.\n */", "meta": { "range": [ 5974, 6546 ], "filename": "AccessibilityManager.js", "lineno": 212, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100075190", "name": "AccessibilityManager#updateAccessibleObjects", "type": "MethodDefinition", "paramnames": [ "displayObject" ] }, "vars": { "": null } }, "description": "

This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer.

", "access": "private", "params": [ { "type": { "names": [ "PIXI.Container" ] }, "description": "

The DisplayObject to check.

", "name": "displayObject" } ], "name": "updateAccessibleObjects", "longname": "PIXI.accessibility.AccessibilityManager#updateAccessibleObjects", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R006983", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerupdateAccessibleObjects", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Before each render this function will ensure that all divs are mapped correctly to their DisplayObjects.\n *\n * @private\n */", "meta": { "range": [ 6703, 8994 ], "filename": "AccessibilityManager.js", "lineno": 242, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100075260", "name": "AccessibilityManager#update", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Before each render this function will ensure that all divs are mapped correctly to their DisplayObjects.

", "access": "private", "name": "update", "longname": "PIXI.accessibility.AccessibilityManager#update", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R006987", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerupdate", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * TODO: docs.\n *\n * @param {Rectangle} hitArea - TODO docs\n */", "meta": { "range": [ 9088, 9639 ], "filename": "AccessibilityManager.js", "lineno": 322, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100075660", "name": "AccessibilityManager#capHitArea", "type": "MethodDefinition", "paramnames": [ "hitArea" ] }, "vars": { "": null } }, "description": "

TODO: docs.

", "params": [ { "type": { "names": [ "Rectangle" ] }, "description": "

TODO docs

", "name": "hitArea" } ], "name": "capHitArea", "longname": "PIXI.accessibility.AccessibilityManager#capHitArea", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R007012", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagercapHitArea", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Adds a DisplayObject to the accessibility manager\n *\n * @private\n * @param {DisplayObject} displayObject - The child to make accessible.\n */", "meta": { "range": [ 9817, 11300 ], "filename": "AccessibilityManager.js", "lineno": 353, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100075765", "name": "AccessibilityManager#addChild", "type": "MethodDefinition", "paramnames": [ "displayObject" ] }, "vars": { "": null } }, "description": "

Adds a DisplayObject to the accessibility manager

", "access": "private", "params": [ { "type": { "names": [ "DisplayObject" ] }, "description": "

The child to make accessible.

", "name": "displayObject" } ], "name": "addChild", "longname": "PIXI.accessibility.AccessibilityManager#addChild", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R007019", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManageraddChild", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Maps the div button press to pixi's InteractionManager (click)\n *\n * @private\n * @param {MouseEvent} e - The click event.\n */", "meta": { "range": [ 11463, 11662 ], "filename": "AccessibilityManager.js", "lineno": 406, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100075984", "name": "AccessibilityManager#_onClick", "type": "MethodDefinition", "paramnames": [ "e" ] }, "vars": { "": null } }, "description": "

Maps the div button press to pixi's InteractionManager (click)

", "access": "private", "params": [ { "type": { "names": [ "MouseEvent" ] }, "description": "

The click event.

", "name": "e" } ], "name": "_onClick", "longname": "PIXI.accessibility.AccessibilityManager#_onClick", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R007034", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManager_onClick", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Maps the div focus events to pixis InteractionManager (mouseover)\n *\n * @private\n * @param {FocusEvent} e - The focus event.\n */", "meta": { "range": [ 11828, 12031 ], "filename": "AccessibilityManager.js", "lineno": 419, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100076013", "name": "AccessibilityManager#_onFocus", "type": "MethodDefinition", "paramnames": [ "e" ] }, "vars": { "": null } }, "description": "

Maps the div focus events to pixis InteractionManager (mouseover)

", "access": "private", "params": [ { "type": { "names": [ "FocusEvent" ] }, "description": "

The focus event.

", "name": "e" } ], "name": "_onFocus", "longname": "PIXI.accessibility.AccessibilityManager#_onFocus", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R007036", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManager_onFocus", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Maps the div focus events to pixis InteractionManager (mouseout)\n *\n * @private\n * @param {FocusEvent} e - The focusout event.\n */", "meta": { "range": [ 12199, 12404 ], "filename": "AccessibilityManager.js", "lineno": 432, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100076042", "name": "AccessibilityManager#_onFocusOut", "type": "MethodDefinition", "paramnames": [ "e" ] }, "vars": { "": null } }, "description": "

Maps the div focus events to pixis InteractionManager (mouseout)

", "access": "private", "params": [ { "type": { "names": [ "FocusEvent" ] }, "description": "

The focusout event.

", "name": "e" } ], "name": "_onFocusOut", "longname": "PIXI.accessibility.AccessibilityManager#_onFocusOut", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R007038", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManager_onFocusOut", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Is called when a key is pressed\n *\n * @private\n * @param {KeyboardEvent} e - The keydown event.\n */", "meta": { "range": [ 12541, 12672 ], "filename": "AccessibilityManager.js", "lineno": 445, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100076071", "name": "AccessibilityManager#_onKeyDown", "type": "MethodDefinition", "paramnames": [ "e" ] }, "vars": { "": null } }, "description": "

Is called when a key is pressed

", "access": "private", "params": [ { "type": { "names": [ "KeyboardEvent" ] }, "description": "

The keydown event.

", "name": "e" } ], "name": "_onKeyDown", "longname": "PIXI.accessibility.AccessibilityManager#_onKeyDown", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "___id": "T000002R007040", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManager_onKeyDown", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Is called when the mouse moves across the renderer element\n *\n * @private\n */", "meta": { "range": [ 12783, 12836 ], "filename": "AccessibilityManager.js", "lineno": 460, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100076089", "name": "AccessibilityManager#_onMouseMove", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Is called when the mouse moves across the renderer element

", "access": "private", "name": "_onMouseMove", "longname": "PIXI.accessibility.AccessibilityManager#_onMouseMove", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R007041", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManager_onMouseMove", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * Destroys the accessibility manager\n *\n */", "meta": { "range": [ 12907, 13299 ], "filename": "AccessibilityManager.js", "lineno": 469, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": { "id": "astnode100076098", "name": "AccessibilityManager#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroys the accessibility manager

", "name": "destroy", "longname": "PIXI.accessibility.AccessibilityManager#destroy", "kind": "function", "memberof": "PIXI.accessibility.AccessibilityManager", "scope": "instance", "params": [], "___id": "T000002R007042", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerdestroy", "filepath": "accessibility\\AccessibilityManager.js" } ], "$attributes": [ { "comment": "/**\n * The renderer this accessibility manager works for.\n *\n * @member {PIXI.SystemRenderer} PIXI.accessibility.AccessibilityManager#renderer\n */", "meta": { "range": [ 2569, 2747 ], "filename": "AccessibilityManager.js", "lineno": 91, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": {} }, "description": "

The renderer this accessibility manager works for.

", "kind": "member", "name": "renderer", "type": { "names": [ "PIXI.SystemRenderer" ] }, "memberof": "PIXI.accessibility.AccessibilityManager", "longname": "PIXI.accessibility.AccessibilityManager#renderer", "scope": "instance", "___id": "T000002R000025", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerrenderer", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * The array of currently active accessible items.\n *\n * @member {Array<*>} PIXI.accessibility.AccessibilityManager#children\n * @private\n */", "meta": { "range": [ 2791, 2975 ], "filename": "AccessibilityManager.js", "lineno": 98, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": {} }, "description": "

The array of currently active accessible items.

", "kind": "member", "name": "children", "type": { "names": [ "Array.<*>" ] }, "access": "private", "memberof": "PIXI.accessibility.AccessibilityManager", "longname": "PIXI.accessibility.AccessibilityManager#children", "scope": "instance", "___id": "T000002R000027", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerchildren", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * stores the state of the manager. If there are no accessible objects or the mouse is moving the will be false.\n *\n * @member {Array<*>} PIXI.accessibility.AccessibilityManager#isActive\n * @private\n */", "meta": { "range": [ 3215, 3461 ], "filename": "AccessibilityManager.js", "lineno": 114, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": {} }, "description": "

stores the state of the manager. If there are no accessible objects or the mouse is moving the will be false.

", "kind": "member", "name": "isActive", "type": { "names": [ "Array.<*>" ] }, "access": "private", "memberof": "PIXI.accessibility.AccessibilityManager", "longname": "PIXI.accessibility.AccessibilityManager#isActive", "scope": "instance", "___id": "T000002R000031", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerisActive", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * The renderer this accessibility manager works for.\n *\n * @member {PIXI.SystemRenderer} PIXI.accessibility.AccessibilityManager#renderer\n */", "meta": { "range": [ 2569, 2747 ], "filename": "AccessibilityManager.js", "lineno": 91, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": {} }, "description": "

The renderer this accessibility manager works for.

", "kind": "member", "name": "renderer", "type": { "names": [ "PIXI.SystemRenderer" ] }, "memberof": "PIXI.accessibility.AccessibilityManager", "longname": "PIXI.accessibility.AccessibilityManager#renderer", "scope": "instance", "___id": "T000002R006959", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerrenderer", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * The array of currently active accessible items.\n *\n * @member {Array<*>} PIXI.accessibility.AccessibilityManager#children\n * @private\n */", "meta": { "range": [ 2791, 2975 ], "filename": "AccessibilityManager.js", "lineno": 98, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": {} }, "description": "

The array of currently active accessible items.

", "kind": "member", "name": "children", "type": { "names": [ "Array.<*>" ] }, "access": "private", "memberof": "PIXI.accessibility.AccessibilityManager", "longname": "PIXI.accessibility.AccessibilityManager#children", "scope": "instance", "___id": "T000002R006961", "___s": true, "skip": true, "slug": "PIXI.accessibility.AccessibilityManagerchildren", "filepath": "accessibility\\AccessibilityManager.js" }, { "comment": "/**\n * stores the state of the manager. If there are no accessible objects or the mouse is moving the will be false.\n *\n * @member {Array<*>} PIXI.accessibility.AccessibilityManager#isActive\n * @private\n */", "meta": { "range": [ 3215, 3461 ], "filename": "AccessibilityManager.js", "lineno": 114, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\accessibility", "code": {} }, "description": "

stores the state of the manager. If there are no accessible objects or the mouse is moving the will be false.