initial commit

docs/rendering/gui/components/Clip.js

@@ -0,0 +1,35 @@
+/**
+ * Clip to manage timelines and images.
+ *
+ * @class Clip
+ * @extends jibo.face.views.Element
+ * @memberof jibo.face.views
+ */
+
+    /**
+     * Timeline for the display content.
+     * @name jibo.face.views.Clip#timeline
+     * @type {Timeline}
+     */
+
+    /**
+     * MovieClip for the display content, the instance of the Timeline.
+     * @name jibo.face.views.Clip#movieClip
+     * @type {PIXI.animate.MovieClip}
+     */
+
+    /**
+     * Create a Clip from a configuration Object derived from JSON.
+     * @method jibo.face.views.Clip#createFromConfig
+     * @param configData Object derived from JSON, must be a specific format refer to examples.
+     * @returns {jibo.face.views.Clip} The created Clip.
+     */
+
+    /**
+     * Create a Clip object by passing the DisplayObject.
+     * This allows for a more direct way to create Clips that is not reliant on the configuration data.
+     * @method jibo.face.views.Clip#createFromDisplayObject
+     * @param {PIXI.DisplayObject} displayObject The DisplayObject with the button assets.
+     * @param {PIXI.Container} [container] Display container for the button.
+     * @returns {jibo.face.views.Clip} The created Clip.
+     */