/*
 * Copyright (c) 2014 Gwennael Buchet
 *
 * License/Terms of Use
 *
 * Permission is hereby granted, free of charge and for the term of intellectual property rights on the Software, to any
 * person obtaining a copy of this software and associated documentation files (the "Software"), to use, copy, modify
 * and propagate free of charge, anywhere in the world, all or part of the Software subject to the following mandatory conditions:
 *
 *   •    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 *  Any failure to comply with the above shall automatically terminate the license and be construed as a breach of these
 *  Terms of Use causing significant harm to Gwennael Buchet.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 *  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 *  OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 *  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 *  Except as contained in this notice, the name of Gwennael Buchet shall not be used in advertising or otherwise to promote
 *  the use or other dealings in this Software without prior written authorization from Gwennael Buchet.
 *
 *  These Terms of Use are subject to French law.
 */

"use strict";

/**
 * @module Animation
 * @class CGSGKeyFrame
 * @extends {Object}
 * @constructor
 * @param {Number} frame number for this key. Must be an integer value.
 * @param {object} value for this key. For example : {x:10, y:30}; {x:10}
 * @type {CGSGKeyFrame}
 * @author Gwennael Buchet (gwennael.buchet@gmail.com)
 */
var CGSGKeyFrame = CGSGObject.extend(
    {
        initialize : function(frame, value) {
            /**
             * @property frame
             * @type {Number}
             */
            this.frame = frame;
            /**
             * @property value
             * @type {*}
             * @example {x:10, y:30}; {x:10}
             */
            this.value = value;

            /**
             * Incoming tangent for this key
             * @property inTangent
             * @default (0, 0)
             * @type {CGSGVector2D}
             */
            this.inTangent = new CGSGVector2D(0, 0);

            /**
             * Outgoing tangent for this key
             * @property outTangent
             * @default (0, 0)
             * @type {CGSGVector2D}
             */
            this.outTangent = new CGSGVector2D(0, 0);

            /**
             * can be fulfilled by the developer to put in whatever he needs
             * @property userData
             * @default null
             * @type {*}
             */
            this.userData = null;
        }
    }
);