initial commit

docs/rendering/gui/views/ImageView.js

@@ -0,0 +1,70 @@
+/**
+ * @description Interface - Configuration values for creating a ImageView.
+ * @interface jibo.face.views.ImageView~ImageViewOptions
+ * @extends jibo.face.views.View~ViewOptions
+ * @prop {AssetDescriptor} [image] - Relative source path to the resource.
+ */
+
+/**
+ * View designed to display standard Clips.
+ *
+ * Takes a simplified JSON configuration. Example:
+ * ```json
+ *  {
+ *      "viewConfig": {
+ *          "type": "ImageView",
+ *          "id": "my_image_view",
+ *          "image": {
+ *              "id": "clipTest",
+ *              "src": "resources/images/my-image.png",
+ *              "type": "texture"
+ *          },
+ *          "scaleToFit": true
+ *      }
+ *  }
+ * ```
+ * @class ImageView
+ * @extends jibo.face.views.View
+ * @memberof jibo.face.views
+ */
+
+    /**
+     * The default class identifier.
+     * Generally used to register the class.
+     * @name jibo.face.views.ImageView.DEFAULT_TYPE
+     * @type {String}
+     * @readOnly
+     */
+
+    /**
+     * If clip is smaller than screen determine if it should be stretched to fit
+     * @name jibo.face.views.ImageView#scaleToFit
+     * @type {boolean}
+     * @public
+     */
+
+    /**
+     * AssetDescriptor for the ImageView's Clip
+     * @name jibo.face.views.ImageView.imageDescriptor
+     * @type {jibo.face.views~AssetDescriptor}
+     * @public
+     */
+
+     /**
+      * Clip for the ImageView.
+      * @name jibo.face.views.MenuView#clip
+      * @public
+      * @readOnly
+      * @type {jibo.face.views.Clip}
+      */
+
+    /**
+     * Construct ImageView
+     */
+
+    /**
+     * FOR OVERRIDE ONLY. DO NOT CALL EXTERNALLY.
+     *
+     * Determine x and y positions for the clip element, and its scaling relative to the screen.
+     * @method jibo.face.views.ImageView#positionComponents
+     */