Changeset 5498 in orxonox.OLD for trunk/src/world_entities/world_entity.cc

Timestamp:

Nov 7, 2005, 10:43:22 PM (18 years ago)

Author:

bensch

Message:

orxonox/trunk: redocumented the WorldEntity and Weapon classes

File:

• trunk/src/world_entities/world_entity.cc (modified) (8 diffs)

trunk/src/world_entities/world_entity.cc

@@ -35 +35 @@
 /**
  *  Loads the WordEntity-specific Part of any derived Class
-*/
+ *
+ * @param root: Normally NULL, as the Derived Entities define a loadParams Function themeselves,
+ *              that can calls WorldEntities loadParams for itself.
+ */
 WorldEntity::WorldEntity(const TiXmlElement* root)
 {
@@ -54 +57 @@
 WorldEntity::~WorldEntity ()
 {
-  // if( collisioncluster != NULL) delete collisioncluster;
+  // Delete the model (unregister it with the ResourceManager)
   if (likely(this->model != NULL))
     ResourceManager::getInstance()->unload(this->model);
+  // Delete the obbTree
   if( this->obbTree != NULL)
     delete this->obbTree;
 }
 
+/**
+ * loads the WorldEntity Specific Parameters.
+ * @param root: the XML-Element to load the Data From
+ */
 void WorldEntity::loadParams(const TiXmlElement* root)
 {
+  // Do the PNode loading stuff
   static_cast<PNode*>(this)->loadParams(root);
+
   // Model Loading
   LoadParam<WorldEntity>(root, "model", this, &WorldEntity::loadModel)
@@ -77 +87 @@
  * @param fileName the name of the model to load
  * @param scaling the Scaling of the model
+ *
+ * @todo fix this, so it only has one loadModel-Function.
 */
 void WorldEntity::loadModelWithScale(const char* fileName, float scaling)
@@ -126 +138 @@
  * these attributes don't have to be set, only use them, if you need them
 */
-void WorldEntity::setCharacterAttributes(CharacterAttributes* charAttr)
-{}
-
-
-/**
- * gets the Character attributes of this worldentity
- * @returns character attributes
-*/
-CharacterAttributes* WorldEntity::getCharacterAttributes()
-{}
+//void WorldEntity::setCharacterAttributes(CharacterAttributes* charAttr)
+//{}
 
 
@@ -146 +150 @@
 void WorldEntity::collidesWith(WorldEntity* entity, const Vector& location)
 {
+  /**
+   * THIS IS A DEFAULT COLLISION-Effect.
+   * IF YOU WANT TO CREATE A SPECIFIC COLLISION ON EACH OBJECT
+   * USE::
+   * if (entity->isA(CL_WHAT_YOU_ARE_LOOKING_FOR)) { printf "dothings"; };
+   *
+   * You can always define a default Action.... don't be affraid just test it :)
+   */
 //  PRINTF(3)("collision %s vs %s @ (%f,%f,%f)\n", this->getClassName(), entity->getClassName(), location.x, location.y, location.z);
 }
 
-/**
- *  this function is called, when the ship is hit by a waepon
- * @param weapon: the laser/rocket/shoot that hits.
- * @param loc: place where it is hit
- *
- * calculate the damage depending
-*/
-void WorldEntity::hit(WorldEntity* weapon, Vector* loc) {}
-
-
-/**
- *  this is called immediately after the Entity has been constructed and initialized
- *
- * Put any initialisation code that requires knowledge of location (placement if the Entity is free) and owner of the entity here.
- * DO NOT place such code in the constructor, those variables are set AFTER the entity is constucted.
-*/
+
+/**
+ *  this is called immediately after the Entity has been constructed, initialized and then Spawned into the World
+ *
+ */
 void WorldEntity::postSpawn ()
 {
@@ -175 +176 @@
  * For free entities this means it left the Track boundaries. With bound entities it means its Location adresses a
  * place that is not in the world anymore. In both cases you might have to take extreme measures (a.k.a. call destroy).
-*/
+ *
+ * NOT YET IMPLEMENTED
+ */
 void WorldEntity::leftWorld ()
 {
@@ -190 +193 @@
 {
 }
+
 
 /**
@@ -216 +220 @@
 }
 
-
+/**
+ * DEBUG-DRAW OF THE BV-Tree.
+ * @param depth What depth to draw
+ * @param drawMode the mode to draw this entity under
+ */
 void WorldEntity::drawBVTree(unsigned int depth, int drawMode)
 {