Babylon.js/src/Actions/babylon.action.ts

module BABYLON {
    /**
     * The action to be carried out following a trigger
     * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
     */
    export class Action {
        /**
         * Trigger for the action
         */
        public trigger: number;

        /**
         * Internal only - manager for action
         * @hidden 
         */
        public _actionManager: ActionManager;

        private _nextActiveAction: Action;
        private _child: Action;
        private _condition?: Condition;
        private _triggerParameter: any;

        /**
        * An event triggered prior to action being executed.
        */
        public onBeforeExecuteObservable = new Observable<Action>();

        /**
         * Creates a new Action
         * @param triggerOptions the trigger, with or without parameters, for the action
         * @param condition an optional determinant of action 
         */
        constructor(public triggerOptions: any, condition?: Condition) {

            if (triggerOptions.parameter) {
                this.trigger = triggerOptions.trigger;
                this._triggerParameter = triggerOptions.parameter;
            } else {
                this.trigger = triggerOptions;
            }

            this._nextActiveAction = this;
            this._condition = condition;
        }

        /**
         * Internal only
         * @hidden 
         */
        public _prepare(): void {
        }

        /**
         * Gets the trigger parameters
         * @returns the trigger parameters
         */
        public getTriggerParameter(): any {
            return this._triggerParameter;
        }

        /**
         * Internal only - executes current action event
         * @hidden 
         */
        public _executeCurrent(evt?: ActionEvent): void {
            if (this._nextActiveAction._condition) {
                var condition = this._nextActiveAction._condition;
                var currentRenderId = this._actionManager.getScene().getRenderId();

                // We cache the current evaluation for the current frame
                if (condition._evaluationId === currentRenderId) {
                    if (!condition._currentResult) {
                        return;
                    }
                } else {
                    condition._evaluationId = currentRenderId;

                    if (!condition.isValid()) {
                        condition._currentResult = false;
                        return;
                    }

                    condition._currentResult = true;
                }
            }
            
            this.onBeforeExecuteObservable.notifyObservers(this);
            this._nextActiveAction.execute(evt);

            this.skipToNextActiveAction();
        }

        /**
         * Execute placeholder for child classes
         * @param evt optional action event
         */
        public execute(evt?: ActionEvent): void {

        }

        /**
         * Skips to next active action
         */
        public skipToNextActiveAction(): void {
            if (this._nextActiveAction._child) {

                if (!this._nextActiveAction._child._actionManager) {
                    this._nextActiveAction._child._actionManager = this._actionManager;
                }

                this._nextActiveAction = this._nextActiveAction._child;
            } else {
                this._nextActiveAction = this;
            }
        }

        /**
         * Adds action to chain of actions, may be a DoNothingAction
         * @param index The index of the attribute.
         * @returns The action passed in
         * @see https://www.babylonjs-playground.com/#1T30HR#0
         */
        public then(action: Action): Action {
            this._child = action;

            action._actionManager = this._actionManager;
            action._prepare();

            return action;
        }

        /**
         * Internal only
         * @hidden 
         */
        public _getProperty(propertyPath: string): string {
            return this._actionManager._getProperty(propertyPath);
        }

        /**
         * Internal only
         * @hidden 
         */
        public _getEffectiveTarget(target: any, propertyPath: string): any {
            return this._actionManager._getEffectiveTarget(target, propertyPath);
        }
        
        /**
         * Serialize placeholder for child classes
         * @param parent of child
         * @returns the serialized object
         */
        public serialize(parent: any): any {
        }
        
        /**
         * Internal only called by serialize
         * @hidden 
         */
        protected _serialize(serializedAction: any, parent?: any): any {
            var serializationObject: any = { 
                type: 1,
                children: [],
                name: serializedAction.name,
                properties: serializedAction.properties || []
            };
            
            // Serialize child
            if (this._child) { 
                this._child.serialize(serializationObject);
            }
            
            // Check if "this" has a condition
            if (this._condition) {
                var serializedCondition = this._condition.serialize();
                serializedCondition.children.push(serializationObject);
                
                if (parent) {
                    parent.children.push(serializedCondition);
                }
                return serializedCondition;
            }
            
            if (parent) {
                parent.children.push(serializationObject);
            }
            return serializationObject;
        }
        
        /**
         * Internal only
         * @hidden 
         */
        public static _SerializeValueAsString = (value: any): string => {
            if (typeof value === "number") {
                return value.toString();
            }
            
            if (typeof value === "boolean") {
                return value ? "true" : "false";
            }
            
            if (value instanceof Vector2) {
                return value.x + ", " + value.y;
            }
            if (value instanceof Vector3) {
                return value.x + ", " + value.y + ", " + value.z;
            }
            
            if (value instanceof Color3) {
                return value.r + ", " + value.g + ", " + value.b;
            }
            if (value instanceof Color4) {
                return value.r + ", " + value.g + ", " + value.b + ", " + value.a;
            }
            
            return value; // string
        };
        
        /**
         * Internal only
         * @hidden 
         */
        public static _GetTargetProperty = (target: Scene | Node) => {
            return {
                name: "target",
                targetType: target instanceof Mesh ? "MeshProperties"
                            : target instanceof Light ? "LightProperties"
                            : target instanceof Camera ? "CameraProperties"
                            : "SceneProperties",
                value: target instanceof Scene ? "Scene" : (<Node>target).name
            }  
        };
    }
}