use guarded pointers

[flightgear.git] / src / Model / modelmgr.hxx

diff --git a/src/Model/modelmgr.hxx b/src/Model/modelmgr.hxx
index d0b7841cd7410007b5a4bb3b34bc74ff7a61bd19..073598fb147bd2a7c8e10922cbda9d5f0016cfb3 100644 (file)
--- a/src/Model/modelmgr.hxx
+++ b/src/Model/modelmgr.hxx
@@ -13,23 +13,49 @@
 #include <vector>
 
 #include <simgear/compiler.h>  // for SG_USING_STD
-
-#include <Main/fgfs.hxx>       // for FGSubsystem
+#include <simgear/structure/subsystem_mgr.hxx>
 
 SG_USING_STD(vector);
 
 // Don't pull in headers, since we don't need them here.
 class ssgSelector;
 class SGPropertyNode;
-class FGModelPlacement;
+class SGModelPlacement;
 
 
 /**
  * Manage a list of user-specified models.
  */
-class FGModelMgr : public FGSubsystem
+class FGModelMgr : public SGSubsystem
 {
 public:
+
+  /**
+   * A dynamically-placed model using properties.
+   *
+   * The model manager uses the property nodes to update the model's
+   * position and orientation; any of the property node pointers may
+   * be set to zero to avoid update.  Normally, a caller should
+   * load the model by instantiating SGModelPlacement with the path
+   * to the model or its XML wrapper, then assign any relevant
+   * property node pointers.
+   *
+   * @see SGModelPlacement
+   * @see FGModelMgr#add_instance
+   */
+  struct Instance
+  {
+    Instance ();
+    virtual ~Instance ();
+    SGModelPlacement * model;
+    SGPropertyNode_ptr lon_deg_node;
+    SGPropertyNode_ptr lat_deg_node;
+    SGPropertyNode_ptr elev_ft_node;
+    SGPropertyNode_ptr roll_deg_node;
+    SGPropertyNode_ptr pitch_deg_node;
+    SGPropertyNode_ptr heading_deg_node;
+  };
+
   FGModelMgr ();
   virtual ~FGModelMgr ();
 
@@ -38,26 +64,35 @@ public:
   virtual void unbind ();
   virtual void update (double dt);
 
+  virtual void add_model (SGPropertyNode * node);
+
+  /**
+   * Add an instance of a dynamic model to the manager.
+   *
+   * NOTE: pointer ownership is transferred to the model manager!
+   *
+   * The caller is responsible for setting up the Instance structure
+   * as required.  The model manager will continuously update the
+   * location and orientation of the model based on the current
+   * values of the properties.
+   */
+  virtual void add_instance (Instance * instance);
+
+
+  /**
+   * Remove an instance of a dynamic model from the manager.
+   *
+   * NOTE: the manager will delete the instance as well.
+   */
+  virtual void remove_instance (Instance * instance);
+
   virtual void draw ();
 
 private:
 
-  struct Instance
-  {
-    Instance ();
-    virtual ~Instance ();
-    FGModelPlacement * model;
-    SGPropertyNode * lon_deg_node;
-    SGPropertyNode * lat_deg_node;
-    SGPropertyNode * elev_ft_node;
-    SGPropertyNode * roll_deg_node;
-    SGPropertyNode * pitch_deg_node;
-    SGPropertyNode * heading_deg_node;
-  };
-
   vector<Instance *> _instances;
 
-  ssgSelector * _selector;
+  ssgSharedPtr<ssgSelector> _selector;
 
 };