Files
JiboOs/docs/rendering/FaceRenderer.js
2026-03-16 13:53:01 +02:00

119 lines
2.5 KiB
JavaScript

/**
* @description
* Controls the rendering of the eye, overlay, and background.
* ```
* let jibo = require('jibo');
* jibo.init('face', () => {
* // Setup complete!
* });
* ```
* @namespace jibo.face
*/
/**
* Entire width of Jibo's face.
* @name jibo.face.WIDTH
* @type {int}
* @default 1280
* @readOnly
*/
/**
* Entire height of Jibo's face.
* @name jibo.face.HEIGHT
* @type {int}
* @default 720
* @readOnly
*/
/**
* Stage container for all PIXI display objects.
* @name jibo.face#stage
* @type {PIXI.Container}
*/
/**
* If the display is updating.
* @name jibo.face#_paused
* @type {Boolean}
* @private
*/
/**
* Instance of the update timer for handling events.
* @name jibo.face#_timer
* @type {jibo.timer}
* @private
*/
/**
* Instance to the GUI/View Manager.
* @private
* @name jibo.face#_views
* @type {jibo.face.views}
*/
/**
* Instance to the GestureManager for input gestures.
* @private
* @name jibo.face#_gestures
* @type {jibo.face.GestureManager}
*/
/**
* Instance to the Eye display.
* @private
* @name jibo.face#_eye
* @type {jibo.face.EyeContainer}
*/
/**
* Creates the canvas for the renderer.
* @private
* @method jibo.face.createView
*/
/**
* Adds a face animation to play.
* @private
* @method jibo.face#init
* @param {HTMLElement} element HTML element which will contain the view
* @param {boolean} [prepWorkers=true] If Crunch texture loading workers should be prepared. Should be left as the default of true, unless in the SDK.
*/
/**
* Manage the views on Jibo's face.
* @name jibo.face#views
* @type {jibo.face.views}
*/
/**
* Create and manage the input gestures.
* @name jibo.face#gestures
* @type {jibo.face.GestureManager}
*/
/**
* Tweens manager.
* @name jibo.face#tween
* @type {jibo.face.TweenManager}
*/
/**
* Representation of the eye itself.
* @name jibo.face#eye
* @type {jibo.face.EyeContainer}
*/
/**
* Update/render the stage.
* @method jibo.face#update
* @private
* @param {int} elapsed Time in milliseconds since the last update
*/
/**
* If `true`, pauses the face renderer completely.
* @name jibo.face#paused
* @type {boolean}
*/