Do not modify danymically generated textures.

[simgear.git] / simgear / scene / model / modellib.hxx

diff --git a/simgear/scene/model/modellib.hxx b/simgear/scene/model/modellib.hxx
index 18e304ea6dc6850b0c24895d61105181a3c7d2f3..7c38b10abedd6adcfcf659d601a7b5b1452145db 100644 (file)
--- a/simgear/scene/model/modellib.hxx
+++ b/simgear/scene/model/modellib.hxx
@@ -1,4 +1,19 @@
-// modellib.cxx - implement an SSG model library.
+// Copyright (C) 2008 Till Busch buti@bux.at
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as
+// published by the Free Software Foundation; either version 2 of the
+// License, or (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful, but
+// WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+//
 
 #ifndef _SG_MODEL_LIB_HXX
 #define _SG_MODEL_LIB_HXX 1
@@ -9,38 +24,69 @@
 
 #include <simgear/compiler.h>  // for SG_USING_STD
 
-#include <map>
-#include STL_STRING
+#include <string>
 
-#include <plib/ssg.h>
+#include <osg/Node>
 
-#include <simgear/structure/ssgSharedPtr.hxx>
 #include <simgear/props/props.hxx>
 
-SG_USING_STD(map);
-SG_USING_STD(string);
+using std::map;
+using std::string;
 
+namespace simgear {
+
+class SGModelData; // defined below
 
 /**
  * Class for loading and managing models with XML wrappers.
  */
 class SGModelLib
 {
-
 public:
+    typedef osg::Node *(*panel_func)(SGPropertyNode *);
+
+    static void init(const string &root_dir);
+
+    // Load a 3D model (any format)
+    // data->modelLoaded() will be called after the model is loaded
+    static osg::Node* loadModel(const string &path,
+                                SGPropertyNode *prop_root,
+                                SGModelData *data=0);
+
+    // Load a 3D model (any format)
+    // with a panel_func to load a panel
+    static osg::Node* loadModel(const string &path,
+                                SGPropertyNode *prop_root,
+                                panel_func pf);
 
-    SGModelLib ();
-    virtual ~SGModelLib ();
-    virtual void flush1();
+    // Load a 3D model (any format) through the DatabasePager.
+    // Most models should be loaded using this function!
+    // This function will initially return an SGPagedLOD node.
+    // data->modelLoaded() will be called after the model is loaded and
+    // connected to the scene graph. See AIModelData on how to use this.
+    // NOTE: AIModelData uses observer_ptr to avoid circular references.
+    static osg::Node* loadPagedModel(const string &path,
+                                     SGPropertyNode *prop_root,
+                                     SGModelData *data=0);
 
-    virtual ssgEntity *load_model( const string &fg_root,
-                                   const string &path,
-                                   SGPropertyNode *prop_root,
-                                   double sim_time_sec );
 protected:
+    SGModelLib();
+    ~SGModelLib ();
+};
+
 
-    map<string,ssgSharedPtr<ssgEntity> > _table;
+/**
+ * Abstract class for adding data to the scene graph.  modelLoaded() is
+ * called after the model was loaded, and the destructor when the branch
+ * is removed from the scene graph.
+ */
+class SGModelData : public osg::Referenced {
+public:
+    virtual ~SGModelData() {}
+    virtual void modelLoaded(const string& path, SGPropertyNode *prop,
+                             osg::Node* branch) = 0;
 };
 
+}
 
 #endif // _SG_MODEL_LIB_HXX