phaser/resources/docgen/output/PIXI.InteractionManager.json

{"class":{"name":"PIXI.InteractionManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"The stage to handle interactions","optional":false,"default":null}],"help":"The interaction manager deals with mouse and touch events. Any DisplayObject can be interactive\\nif its interactive parameter is set to true\\nThis manager also supports multitouch."},"consts":[],"methods":{"public":[],"protected":[],"private":[{"name":"collectInteractiveSprite","static":false,"returns":null,"help":"Collects an interactive sprite recursively to have their interactions managed","line":160,"public":false,"protected":false,"private":true,"parameters":[{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"the displayObject to collect","optional":false,"default":null},{"name":"iParent","type":["PIXI.DisplayObject"],"help":"the display object's parent","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"hitTest","static":false,"returns":null,"help":"Tests if the current mouse coordinates hit a sprite","line":594,"public":false,"protected":false,"private":true,"parameters":[{"name":"item","type":["PIXI.DisplayObject"],"help":"The displayObject to test for a hit","optional":false,"default":null},{"name":"interactionData","type":["PIXI.InteractionData"],"help":"The interactionData object to update in the case there is a hit","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseDown","static":false,"returns":null,"help":"Is called when the mouse button is pressed down on the renderer element","line":423,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a mouse button being pressed down","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseMove","static":false,"returns":null,"help":"Is called when the mouse moves across the renderer element","line":387,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of the mouse moving","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseOut","static":false,"returns":null,"help":"Is called when the mouse is moved out of the renderer element","line":484,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a mouse being moved out","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseUp","static":false,"returns":null,"help":"Is called when the mouse button is released on the renderer element","line":525,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a mouse button being released","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchEnd","static":false,"returns":null,"help":"Is called when a touch is ended on the renderer element","line":805,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a touch ending on the renderer view","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchMove","static":false,"returns":null,"help":"Is called when a touch is moved across the renderer element","line":690,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a touch moving across the renderer view","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchStart","static":false,"returns":null,"help":"Is called when a touch is started on the renderer element","line":736,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a touch starting on the renderer view","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rebuildInteractiveGraph","static":false,"returns":null,"help":"","line":359,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeEvents","static":false,"returns":null,"help":"","line":249,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setTarget","static":false,"returns":null,"help":"Sets the target for event delegation","line":200,"public":false,"protected":false,"private":true,"parameters":[{"name":"target","type":["PIXI.WebGLRenderer","PIXI.CanvasRenderer"],"help":"the renderer to bind events to","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTargetDomElement","static":false,"returns":null,"help":"Sets the DOM element which will receive mouse\/touch events. This is useful for when you have other DOM\\nelements on top of the renderers Canvas element. With this you'll be able to delegate another DOM element\\nto receive those events","line":220,"public":false,"protected":false,"private":true,"parameters":[{"name":"domElement","type":["DOMElement"],"help":"the DOM element which will receive mouse and touch events","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"updates the state of interactive objects","line":276,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"currentCursorStyle","type":["string"],"help":"The css style of the cursor that is being used","inlineHelp":"","line":133,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"last","type":["number"],"help":"","inlineHelp":"","line":126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouse","type":["PIXI.InteractionData"],"help":"The mouse data","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseOut","type":["boolean"],"help":"Is set to true when the mouse is moved out of the canvas","inlineHelp":"","line":140,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseoverEnabled","type":["boolean"],"help":"","inlineHelp":"","line":52,"default":false,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onMouseDown","type":["function"],"help":"","inlineHelp":"","line":90,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onMouseMove","type":["function"],"help":"","inlineHelp":"","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onMouseOut","type":["function"],"help":"","inlineHelp":"","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onMouseUp","type":["function"],"help":"","inlineHelp":"","line":102,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onTouchEnd","type":["function"],"help":"","inlineHelp":"","line":114,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onTouchMove","type":["function"],"help":"","inlineHelp":"","line":120,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onTouchStart","type":["function"],"help":"","inlineHelp":"","line":108,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pool","type":["array"],"help":"Tiny little interactiveData pool !","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"","inlineHelp":"","line":146,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"A reference to the stage","inlineHelp":"","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touches","type":["object"],"help":"An object that stores current touches (InteractionData) by id reference","inlineHelp":"","line":38,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"interactionDOMElement","type":["HTMLCanvasElement"],"help":"Our canvas","inlineHelp":"","line":76,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"interactiveItems","type":["array"],"help":"An array containing all the iterative items from the our interactive tree","inlineHelp":"","line":68,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"tempPoint","type":["Phaser.Point"],"help":"","inlineHelp":"","line":45,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}