Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/orxonox/branches/updater/src/world_entity.cc @ 3328

Last change on this file since 3328 was 3229, checked in by patrick, 20 years ago

orxonox/trunk: unstable - WorldEntity cleaned

File size: 5.6 KB
Line 
1
2
3/*
4   orxonox - the future of 3D-vertical-scrollers
5
6   Copyright (C) 2004 orx
7
8   This program is free software; you can redistribute it and/or modify
9   it under the terms of the GNU General Public License as published by
10   the Free Software Foundation; either version 2, or (at your option)
11   any later version.
12
13   ### File Specific:
14   main-programmer: Patrick Boenzli
15   co-programmer: Christian Meyer
16*/
17
18#include <iostream>
19
20#include "world_entity.h"
21#include "stdincl.h"
22#include "collision.h"
23
24using namespace std;
25
26/**
27   \brief standard constructor
28   
29   Every derived contructor HAS to call the previous one supplying the isFree parameter. This is necessary to distunguish
30   between free and bound entities. The difference between them is simply the fact that the movement of a free entity is
31   not bound to the track of a world. Use this to implement projectile or effect classes that do not have to travel along the track.
32   To specify an entity to be free or bound set the default parameter in the declaration of the constructor.
33   Theoretically you should never have to call the constructor of an Entity directly, for it is called by the spawn() function of the World
34   class. So if you want to create a new entity at any time, call World::spawn(). It will handle everything that is necessary.
35*/
36WorldEntity::WorldEntity (bool isFree) : bFree(isFree)
37{
38  this->bDraw = true;
39  collisioncluster = NULL;
40  owner = NULL;
41}
42
43/**
44        \brief standard destructor
45*/
46WorldEntity::~WorldEntity ()
47{
48  if( collisioncluster != NULL) delete collisioncluster;
49}
50
51/**
52   \brief get the Location of the WorldEntity
53   \return a pointer to location
54*/
55Location* WorldEntity::getLocation ()
56{
57  return &loc;
58}
59
60/**
61   \brief get the Placement of the WorldEntity
62   \return a pointer to placement
63*/
64Placement* WorldEntity::getPlacement ()
65{
66  return &place;
67}
68
69/**
70   \brief query whether the WorldEntity in question is free
71   \return true if the WorldEntity is free or false if it isn't
72*/
73bool WorldEntity::isFree ()
74{
75  return bFree;
76}
77
78/**
79   \brief set the WorldEntity's collision hull
80   \param newhull: a pointer to a completely assembled CollisionCluster
81   
82   Any previously assigned collision hull will be deleted on reassignment
83*/
84void WorldEntity::setCollision (CollisionCluster* newhull)
85{
86  if( newhull == NULL) return;
87  if( collisioncluster != NULL) delete collisioncluster;
88  collisioncluster = newhull;
89}
90
91/**
92   \brief this method is called every frame
93   \param time: the time in seconds that has passed since the last tick
94   
95   Handle all stuff that should update with time inside this method (movement, animation, etc.)
96*/
97void WorldEntity::tick(float time) 
98{
99}
100
101/**
102   \brief the entity is drawn onto the screen with this function
103   
104   This is a central function of an entity: call it to let the entity painted to the screen. Just override this function with whatever you want to be drawn.
105*/
106void WorldEntity::draw() 
107{
108}
109
110/**
111   \brief this function is called, when two entities collide
112   \param other: the world entity with whom it collides
113   \param ownhitflags: flags to the CollisionCluster subsections that registered an impact
114   \param otherhitflags: flags to the CollisionCluster subsections of the other entity that registered an impact
115
116   Implement behaviour like damage application or other miscellaneous collision stuff in this function
117*/
118void WorldEntity::collide(WorldEntity* other, Uint32 ownhitflags, Uint32 otherhitflags) {}
119
120/**
121   \brief this function is called, when the ship is hit by a waepon
122   \param weapon: the laser/rocket/shoot that hits.
123   \param loc: place where it is hit
124
125   calculate the damage depending
126*/
127void WorldEntity::hit(WorldEntity* weapon, Vector loc) {}
128
129/**
130   \brief this function is called when the entity is to be destroied
131   
132   This can be called, if eg. something realy bad happens :)
133*/
134void WorldEntity::destroy() {}
135
136
137/**
138   \brief basic initialisation for bound Entities
139*/
140void WorldEntity::init( Location* spawnloc, WorldEntity* spawnowner)
141{
142  loc = *spawnloc;
143  owner = spawnowner;
144}
145
146/**
147   \brief basic initialisation for free Entities
148*/
149void WorldEntity::init( Placement* spawnplc, WorldEntity* spawnowner)
150{
151  place = *spawnplc;
152  owner = spawnowner;
153}
154
155/**
156   \brief this is called immediately after the Entity has been constructed and initialized
157   
158   Put any initialisation code that requires knowledge of location (placement if the Entity is free) and owner of the entity here.
159   DO NOT place such code in the constructor, those variables are set AFTER the entity is constucted.
160*/
161void WorldEntity::postSpawn ()
162{
163}
164
165/**
166   \brief this handles incoming command messages
167   \param cmd: a pointer to the incoming Command structure
168   
169   Put all code that handles Command messages here, this will mainly be called by the assigned CommandNode but can also be used
170   to send commands from one WorldEntity to another.
171*/
172void WorldEntity::command (Command* cmd)
173{
174}
175
176/**
177   \brief this is called by the local Camera to determine the point it should look at on the WorldEntity
178   \param locbuf: a pointer to the buffer to fill with a location to look at
179       
180   You may put any Location you want into locbuf, the Camera will determine via the corresponding Track how
181   to look at the location you return with this.
182*/
183void WorldEntity::getLookat (Location* locbuf)
184{
185}
186
187/**
188   \brief this method is called by the world if the WorldEntity leaves valid gamespace
189   
190   For free entities this means it left the Track boundaries. With bound entities it means its Location adresses a
191   place that is not in the world anymore. In both cases you might have to take extreme measures (a.k.a. call destroy).
192*/
193void WorldEntity::leftWorld ()
194{
195}
Note: See TracBrowser for help on using the repository browser.