script.H

Go to the documentation of this file.

/*
 * This file is part of the "Archon" framework.
 * (http://files3d.sourceforge.net)
 *
 * Copyright © 2002 by Kristian Spangsege and Brian Kristiansen.
 *
 * Permission to use, copy, modify, and distribute this software and
 * its documentation under the terms of the GNU General Public License is
 * hereby granted. No representations are made about the suitability of
 * this software for any purpose. It is provided "as is" without express
 * or implied warranty. See the GNU General Public License
 * (http://www.gnu.org/copyleft/gpl.html) for more details.
 *
 * The characters in this file are ISO8859-1 encoded.
 *
 * The documentation in this file is in "Doxygen" style
 * (http://www.doxygen.org).
 */

#ifndef ARCHON_X3D_SCRIPT_H
#define ARCHON_X3D_SCRIPT_H

#include <archon/x3d/server/custom_field.H>
#include <archon/x3d/server/network.H>
#include <archon/x3d/server/parse_xml.H>

namespace Archon
{
  namespace X3D
  {
    struct Parser;

    struct ScriptNode: virtual ChildNode
    {
      static const NodeType *type;

    protected:
      ScriptNode() {}
    };

    struct Script: ScriptNode, UrlObject, CustomFieldNode, XML::CDATANode
    {
      static Ref<NodeBase> instantiate(BackRef<ExecutionContext> c)
      {
        return new Script(c);
      }

      static const NodeType *type;
      const NodeType *getType() const { return type; }

      Script(BackRef<ExecutionContext> c);

      bool getDirectOutput() const { return directOutput; }
      bool getMustEvaluate() const { return mustEvaluate; }


      struct Engine: virtual RefObjectBase
      {
        virtual void handleEvent(int fieldIndex, Time timestamp) = 0;
      };

    private:
      friend void initializeScriptComponent();

      bool directOutput; // [] FALSE
      bool mustEvaluate; // [] FALSE

      Loader::UriType getUriType() const
      {
        return Loader::uriType_Script;
      }

      void update();
      void onRealized(); // Overriding from NodeBase
      void onLoaded(); // Overriding from UrlObject
      void clear(); // Overriding from UrlObject

      // Overriding from CustomFieldNode
      void handleEvent(int fieldIndex, Time timestamp);

      void handleCDATA(string, Time stamp); // Overriding from CDATANode

      Ref<Engine> engine;
    };
  }
}

#endif // ARCHON_X3D_SCRIPT_H

---