D:/guillaume/guillara/3D/DXGfx/Backup/DXGfxLib/Script.cs

Go to the documentation of this file.

//BSD License  
//DXGfx® - http://www.eteractions.com
//Copyright (c) 2005
//by Guillaume Randon
//Permission is hereby granted, free of charge, to any person obtaining a copy of this software
//and associated documentation files (the "Software"), to deal in the Software without restriction,
//including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
//and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
//subject to the following conditions:
//The above copyright notice and this permission notice shall be included in all copies or substantial
//portions of the Software.
//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 NONINFRINGEMENT. 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.
using System;
using System.Collections.Generic;
using System.Text;

namespace DXGfxLib
{
    public class ExecutableBlock
    {
        public SceneNode parent = null;

        public Scene scene = null;

        public void Dispose()
        {
        }

        public virtual void Evaluate(Scene scene, SceneNode parent, double appTime, float elapsedTime)
        {
        }

        public virtual void Click(Scene scene, SceneNode parent, double appTime, float elapsedTime)
        {
        }

        public virtual void Collision(Scene scene, SceneNode parent, double appTime, float elapsedTime, SceneObject collidingObject)
        {
        }
    }

    public class Script
    {
        private SceneObject parent = null;

        private Scene scene = null;

        private string skeleton;

        public string fileName = "";

        public string name = "";

        private string varSrc = "// If you want to add variables that will retain their values until the script is reseted please define them below:\n";

        public string VarSrc
        {
            get { return GetVarSrc(); }
            set { UpdateVarSrc(value); }
        }

        private string codeSrc = "// Please write your script code below. You can reference the variables you have defined and also the 'parent' (the SceneNode object to which this script is attached) and the 'scene' (the Scene object to which the parent is attached)";

        public string CodeSrc
        {
            get { return GetCodeSrc(); }
            set { UpdateCodeSrc(value); }
        }

        private string clickCodeSrc = "// Write code to react to click event below!";

        public string ClickCodeSrc
        {
            get { return GetClickCodeSrc(); }
            set { UpdateClickCodeSrc(value); }
        }

        private string collisionCodeSrc = "// Write code to react to collision below!";

        public string CollisionCodeSrc
        {
            get { return GetCollisionCodeSrc(); }
            set { UpdateCollisionCodeSrc(value); }
        }
        private ExecutableBlock currentExecutableBlockInstance = null;

        private double scriptStartTime = 0;
        
        private double scriptLastEvaluation = 0;

        private double scriptLastClick = 0;

        private double scriptLastCollision = 0;

        public Script()
        {
            StringBuilder strBuilder = new StringBuilder("");
            strBuilder.AppendLine("using System;");
            strBuilder.AppendLine("using System.Windows.Forms;");
            strBuilder.AppendLine("using System.Collections.Generic;");
            strBuilder.AppendLine("using System.Text;");
            strBuilder.AppendLine("using System.Diagnostics;");
            strBuilder.AppendLine("using Microsoft.DirectX;");
            strBuilder.AppendLine("using Microsoft.DirectX.Direct3D;");
            strBuilder.AppendLine("using Microsoft.Samples.DirectX.UtilityToolkit;");
            strBuilder.AppendLine("namespace DXGfxLib {");
            strBuilder.AppendLine("public class ReplaceByName : ExecutableBlock {");
            strBuilder.AppendLine("ReplaceByMemberVariableSrc");
            strBuilder.AppendLine("public override void Evaluate(Scene scene, SceneNode parent, double appTime, float elapsedTime) {");
            strBuilder.AppendLine("ReplaceByMethodCodeSrc");
            strBuilder.AppendLine("}");
            strBuilder.AppendLine("public override void Click(Scene scene, SceneNode parent, double appTime, float elapsedTime) {");
            strBuilder.AppendLine("ReplaceByMethodClickCodeSrc");
            strBuilder.AppendLine("}");
            strBuilder.AppendLine("public override void Collision(Scene scene, SceneNode parent, double appTime, float elapsedTime, SceneObject collidingObject) {");
            strBuilder.AppendLine("ReplaceByMethodCollisionCodeSrc");
            strBuilder.AppendLine("}}}");
            skeleton = strBuilder.ToString();
        }

        public void SetParent(SceneObject parent)
        {
            if (parent == null)
            {
                // If we are here is means our parent is in fact the scene (and thus not a scene object!).
                // So get the name from the current scene.
                fileName = DXGfxManager.GetGlobalInstance().currentSceneName;
            }
            else
            {
                this.parent = parent;
                fileName = parent.fileName; 
            }
            fileName += ".script.cs";
            name = StringUtil.GetName(fileName);
            int firstDotIndex = name.IndexOf('.');
            name = name.Substring(0, firstDotIndex);
        }

        public void SetScene(Scene scene)
        {
            this.scene = scene;
        }

        public string GetCodeSrc()
        {
            return codeSrc;
        }

        public string GetClickCodeSrc()
        {
            return clickCodeSrc;
        }

        public string GetCollisionCodeSrc()
        {
            return collisionCodeSrc;
        }

        public string GetVarSrc()
        {
            return varSrc;
        }

        public string GetSrcForCompilation()
        {
            string output = skeleton;

            output = output.Replace("ReplaceByName", name);
            output = output.Replace("ReplaceByMemberVariableSrc", varSrc);
            output = output.Replace("ReplaceByMethodCodeSrc", codeSrc);
            output = output.Replace("ReplaceByMethodClickCodeSrc", clickCodeSrc);
            output = output.Replace("ReplaceByMethodCollisionCodeSrc", collisionCodeSrc);

            return output;
        }

        public void UpdateVarSrc(string src)
        {
            this.varSrc = src;

            ScriptManager.GetGlobalInstance().ScriptUpdated(this);
        }

        public void UpdateCodeSrc(string src)
        {
            this.codeSrc = src;

            ScriptManager.GetGlobalInstance().ScriptUpdated(this);
        }

        public void UpdateClickCodeSrc(string src)
        {
            this.clickCodeSrc = src;

            ScriptManager.GetGlobalInstance().ScriptUpdated(this);
        }

        public void UpdateCollisionCodeSrc(string src)
        {
            this.collisionCodeSrc = src;

            ScriptManager.GetGlobalInstance().ScriptUpdated(this);
        }

        public bool Reset()
        {
            scriptStartTime = 0;
            scriptLastEvaluation = 0;
            scriptLastClick = 0;
            scriptLastCollision = 0;

            // Delete current instance and recreate it!!

            return true;
        }

        public virtual void Evaluate(double appTime, float elapsedTime)
        {
            if (scene == null)
            {
                throw new Exception("No scene associated with script. Script can not be run!");
            }

            // We need to check with the scriptManager is the scripts are ready to run!
            // If not we need to get them ready!!
            if (!ScriptManager.GetGlobalInstance().scriptsAreReady)
            {
                ScriptManager.GetGlobalInstance().GetReady();
            }

            if ((scriptStartTime == 0)||(currentExecutableBlockInstance == null))
            {
                // If we are here, it's the first run for this script either because it has just been
                // created or because it has been reseted because the user has reseted the simulation
                // or because a script has changed and thus all scripts have been invalidated by the scriptmanager.
                scriptStartTime = appTime;
                // Need to create a new instance ! 
                currentExecutableBlockInstance = ScriptManager.GetGlobalInstance().GetNewExecutableBlock(name);

                currentExecutableBlockInstance.parent = parent;
                currentExecutableBlockInstance.scene = scene;
            }

            // Here the scripts are ready!!
            currentExecutableBlockInstance.Evaluate(scene, parent, appTime, elapsedTime);

            scriptLastEvaluation = appTime;
        }

        public virtual void Clicked(double appTime, float elapsedTime)
        {
            if (parent == null)
            {
                throw new Exception("No parent associated with script. Script can not be run!");
            }
            if (scene == null)
            {
                throw new Exception("No scene associated with script. Script can not be run!");
            }

            // We need to check with the scriptManager is the scripts are ready to run!
            // If not we need to get them ready!!
            if (!ScriptManager.GetGlobalInstance().scriptsAreReady)
            {
                ScriptManager.GetGlobalInstance().GetReady();
            }

            if ((scriptStartTime == 0)||(currentExecutableBlockInstance == null))
            {
                // If we are here, it's the first run for this script either because it has just been
                // created or because it has been reseted because the user has reseted the simulation
                // or because a script has changed and thus all scripts have been invalidated by the scriptmanager.
                scriptStartTime = appTime;
                // Need to create a new instance ! 
                currentExecutableBlockInstance = ScriptManager.GetGlobalInstance().GetNewExecutableBlock(name);

                currentExecutableBlockInstance.parent = parent;
                currentExecutableBlockInstance.scene = scene;
            }

            // Here the scripts are ready!!
            currentExecutableBlockInstance.Click(scene, parent, appTime, elapsedTime);

            scriptLastClick = appTime;
            parent.HasBeenClicked = false;
        }

        public virtual void Collision(double appTime, float elapsedTime, SceneObject collidingObject)
        {
                                    if (parent == null)
            {
                throw new Exception("No parent associated with script. Script can not be run!");
            }
            if (scene == null)
            {
                throw new Exception("No scene associated with script. Script can not be run!");
            }

            // We need to check with the scriptManager is the scripts are ready to run!
            // If not we need to get them ready!!
            if (!ScriptManager.GetGlobalInstance().scriptsAreReady)
            {
                ScriptManager.GetGlobalInstance().GetReady();
            }

            if ((scriptStartTime == 0)||(currentExecutableBlockInstance == null))
            {
                // If we are here, it's the first run for this script either because it has just been
                // created or because it has been reseted because the user has reseted the simulation
                // or because a script has changed and thus all scripts have been invalidated by the scriptmanager.
                scriptStartTime = appTime;
                // Need to create a new instance ! 
                currentExecutableBlockInstance = ScriptManager.GetGlobalInstance().GetNewExecutableBlock(name);

                currentExecutableBlockInstance.parent = parent;
                currentExecutableBlockInstance.scene = scene;
            }

            // Here the scripts are ready!!
            currentExecutableBlockInstance.Collision(scene, parent, appTime, elapsedTime, collidingObject);

            scriptLastCollision = appTime;
        }
    }
}

---