se_core::SpawnAreaComponent Class Reference

#include <SpawnAreaComponent.hpp>

Inheritance diagram for se_core::SpawnAreaComponent:

se_core::RootChildComponent se_core::NodeComponent se_core::Component List of all members.

Public Types

typedef ComponentPtr< SpawnAreaComponent,
sct_SPAWN > 
Ptr

Public Member Functions

 SpawnAreaComponent (Composite *owner, const ComponentFactory *factory=0)
 Constructor.
 ~SpawnAreaComponent ()
void setActive (bool state)
 Called by Composite.
void flipSpawns (void)
Composite * spawn (const char *thingName, const ViewPoint &vp, PosComponent *parent=0)
void setSpawnPoints (int count, const ViewPoint *const *spawnPoints)
 Set the list of spawn points associated with this PosNode.
const ViewPoint * spawnPoint (short id) const
 Get the reference to a spawn point.
int spawnPointCount () const
const char * name () const
 By default returns name of composite, which returns name of composite factory.
bool hasParent () const
 Does the Pos have a parent?
NodeComponent * parent ()
 Get parent.
const NodeComponent * parent () const
 Get parent.
void resetParent ()
 Set parent to none.
void setParent (NodeComponent &p)
NodeComponentList & children ()
Composite * owner ()
const Composite * owner () const
 Component type.
Component * component (int type)
const Component * component (int type) const
int type () const
const ComponentFactory * factory ()
bool isActive ()
bool isDead () const

Protected Member Functions

void parentChanged (Composite *newParent, Composite *oldParent)
 Called by Composite.
void cleanup ()
 Called by Composite.
void addChild (NodeComponent &node)
 Add a NodeComponent as a child.
void removeChild (NodeComponent &node)
 Add a NodeComponent from the child list.
virtual void setDead ()
 Called by Composite.
virtual void zoneChanged (int type, Composite *newArea, Composite *oldArea)
 Called by Composite.
virtual void init ()
 Called by Composite.

Protected Attributes

CompositeList newSpawns_
 List of waiting to be spawned.
int spawnPointCount_
 The number of spawn points.
const ViewPoint *const * spawnPoints_
 List of spawn points associated with this SpawnComponent.
NodeComponent * parent_
 The parent of this position.
NodeComponentList children_
 List of child NodeComponents.
int type_
 The type of Component.
Composite * owner_
const ComponentFactory * factory_

Friends

class SpawnAreaComponentFactory
class Composite

Member Typedef Documentation

typedef ComponentPtr<SpawnAreaComponent, sct_SPAWN> se_core::SpawnAreaComponent::Ptr
 

Definition at line 37 of file SpawnAreaComponent.hpp.


Constructor & Destructor Documentation

se_core::SpawnAreaComponent::SpawnAreaComponent (  Composite *  owner,
const ComponentFactory *  factory = 0
) 
 

Constructor.

Definition at line 37 of file SpawnAreaComponent.cpp.

References se_core::sct_SPAWN.

se_core::SpawnAreaComponent::~SpawnAreaComponent (   ) 
 

Definition at line 43 of file SpawnAreaComponent.cpp.


Member Function Documentation

void se_core::NodeComponent::addChild (  NodeComponent &  node  )  [protected, inherited]
 

Add a NodeComponent as a child.

Called by setParent of child.

Definition at line 60 of file NodeComponent.cpp.

Referenced by se_core::NodeComponent::setParent().

NodeComponentList& se_core::NodeComponent::children (   )  [inline, inherited]
 

Definition at line 63 of file NodeComponent.hpp.

Referenced by se_core::NodeComponentList::TreeIterator::next().

void se_core::NodeComponent::cleanup (   )  [inline, protected, virtual, inherited]
 

Called by Composite.

Reimplemented from se_core::Component.

Reimplemented in se_core::RootComponent, se_core::CutsceneComponent, se_core::SignalAreaComponent, se_core::SignalComponent, se_ogre::O3dAreaComponent, se_ogre::O3dThingComponent, and se_basic::NavMeshComponent.

Definition at line 70 of file NodeComponent.hpp.

const Component* se_core::Component::component (  int  type  )  const [inline, inherited]
 

Definition at line 71 of file Component.hpp.

References se_core::Component::component().

Component* se_core::Component::component (  int  type  )  [inline, inherited]
 

Definition at line 67 of file Component.hpp.

References se_core::Composite::component().

Referenced by se_core::Component::component(), se_core::Component::ComponentPtr< T, type >::ComponentPtr(), se_ogre::O3dThingComponent::get(), se_ogre::O3dNodeComponent::get(), and se_ogre::O3dAreaComponent::get().

const ComponentFactory* se_core::Component::factory (   )  [inline, inherited]
 

Definition at line 81 of file Component.hpp.

Referenced by se_core::Composite::releaseComponents().

void se_core::SpawnAreaComponent::flipSpawns (  void   ) 
 

Definition at line 62 of file SpawnAreaComponent.cpp.

References se_core::CompositeList::Iterator::hasNext(), and se_core::CompositeList::Iterator::next().

bool se_core::NodeComponent::hasParent (   )  const [inline, inherited]
 

Does the Pos have a parent?

Definition at line 41 of file NodeComponent.hpp.

void se_core::Component::init (   )  [protected, virtual, inherited]
 

Called by Composite.

Reimplemented in se_core::RootComponent, se_core::SignalAreaComponent, se_ogre::O3dAreaComponent, and se_ogre::O3dThingComponent.

Definition at line 42 of file Component.cpp.

Referenced by se_core::Composite::init().

bool se_core::Component::isActive (   )  [inherited]
 

Definition at line 26 of file Component.cpp.

bool se_core::Component::isDead (   )  const [inherited]
 

Definition at line 31 of file Component.cpp.

Referenced by se_core::Actor::affect().

const char* se_core::SpawnAreaComponent::name (   )  const [inline, virtual]
 

By default returns name of composite, which returns name of composite factory.

Reimplemented from se_core::Component.

Definition at line 64 of file SpawnAreaComponent.hpp.

const Composite* se_core::Component::owner (   )  const [inline, inherited]
 

Component type.

Definition at line 62 of file Component.hpp.

Composite* se_core::Component::owner (   )  [inline, inherited]
 

Definition at line 54 of file Component.hpp.

Referenced by se_core::CollisionAreaComponent::_testCollisionCandidates(), se_core::CollisionAreaComponent::_testCollisionCandidates2(), se_core::HealthListeners::add(), se_core::ZoneAreaComponent::addNeighbour(), se_basic::PhTrackingCamera::affect(), se_core::HealthListeners::castHealthChangedEvent(), se_core::Component::ComponentPtr< T, type >::ComponentPtr(), se_ogre::ThingMOManager::create(), se_basic::SimpleAreaThingEncoder::encode(), se_core::SpawnComponent::get(), se_core::SignalComponent::get(), se_core::SignalAreaComponent::get(), se_core::ScriptComponent::get(), se_core::PosComponent::get(), se_core::PhysicsComponent::get(), se_core::StatComponent::get(), se_ogre::O3dThingComponent::get(), se_ogre::O3dNodeComponent::get(), se_ogre::O3dAreaComponent::get(), se_core::Pos::hasArea(), se_core::CollisionGrid::insert(), se_core::CollisionComponent::isCollideable(), se_core::ZoneComponent::name(), se_core::Component::ComponentPtr< T, type >::operator=(), se_core::DefaultTC::pop(), se_core::CoDefault::pop(), se_core::DefaultTC::popAndDie(), se_core::CoDefault::popAndDie(), se_core::CollisionAreaComponent::removeCollideable(), se_core::AreaManager::resetThings(), se_core::Actor::scheduleForDestruction(), se_core::AreaManager::setActive(), se_core::AreaManager::setInactive(), and se_ogre::O3dManager::updateStats().

const NodeComponent* se_core::NodeComponent::parent (   )  const [inline, inherited]
 

Get parent.

const version.

Definition at line 52 of file NodeComponent.hpp.

NodeComponent* se_core::NodeComponent::parent (   )  [inline, inherited]
 

Get parent.

Definition at line 46 of file NodeComponent.hpp.

void se_core::NodeComponent::parentChanged (  Composite *  newParent,
Composite *  oldParent
)  [protected, virtual, inherited]
 

Called by Composite.

Reimplemented from se_core::Component.

Reimplemented in se_core::AreaChildComponent.

Definition at line 74 of file NodeComponent.cpp.

References se_core::Composite::component().

void se_core::NodeComponent::removeChild (  NodeComponent &  node  )  [protected, inherited]
 

Add a NodeComponent from the child list.

Called by setParent of child.

Definition at line 68 of file NodeComponent.cpp.

void se_core::NodeComponent::resetParent (   )  [inherited]
 

Set parent to none.

Parameters:
doKeepWorldCoor wether the local viewpoint should be updated to maintain the world viewpoint

Definition at line 41 of file NodeComponent.cpp.

void se_core::SpawnAreaComponent::setActive (  bool  state  )  [virtual]
 

Called by Composite.

Reimplemented from se_core::RootChildComponent.

Definition at line 48 of file SpawnAreaComponent.cpp.

References se_core::CompSchema::activeRoot(), and se_core::Composite::component().

virtual void se_core::Component::setDead (   )  [inline, protected, virtual, inherited]
 

Called by Composite.

Reimplemented in se_core::SignalComponent, and se_core::SpawnComponent.

Definition at line 97 of file Component.hpp.

Referenced by se_core::Composite::scheduleForDestruction().

void se_core::NodeComponent::setParent (  NodeComponent &  p  )  [inherited]
 

Definition at line 50 of file NodeComponent.cpp.

References se_core::NodeComponent::addChild().

void se_core::SpawnAreaComponent::setSpawnPoints (  int  count,
const ViewPoint *const *  spawnPoints
) 
 

Set the list of spawn points associated with this PosNode.

Parameters:
count the number of spawn points
spawnPoints the list of spawn points

Definition at line 119 of file SpawnAreaComponent.cpp.

Composite * se_core::SpawnAreaComponent::spawn (  const char *  thingName,
const ViewPoint &  vp,
PosComponent *  parent = 0
) 
 

Definition at line 82 of file SpawnAreaComponent.cpp.

References Assert, se_core::SpawnManager::create(), se_core::Composite::setParent(), and se_core::SimSchema::spawnManager().

const ViewPoint * se_core::SpawnAreaComponent::spawnPoint (  short  id  )  const
 

Get the reference to a spawn point.

Parameters:
id the id of the sapwn points

Definition at line 128 of file SpawnAreaComponent.cpp.

References AssertFatal, and AssertWarning.

int se_core::SpawnAreaComponent::spawnPointCount (   )  const [inline]
 

Definition at line 59 of file SpawnAreaComponent.hpp.

int se_core::Component::type (   )  const [inline, inherited]
 

Definition at line 76 of file Component.hpp.

Referenced by se_core::Composite::component().

void se_core::Component::zoneChanged (  int  type,
Composite *  newArea,
Composite *  oldArea
)  [protected, virtual, inherited]
 

Called by Composite.

Reimplemented in se_core::AreaChildComponent, se_core::CollisionComponent, and se_core::SignalComponent.

Definition at line 37 of file Component.cpp.

Referenced by se_core::Composite::zoneChanged().


Friends And Related Function Documentation

friend class Composite [friend, inherited]
 

Definition at line 89 of file Component.hpp.

friend class SpawnAreaComponentFactory [friend]
 

Definition at line 67 of file SpawnAreaComponent.hpp.


Member Data Documentation

NodeComponentList se_core::NodeComponent::children_ [protected, inherited]
 

List of child NodeComponents.

Definition at line 92 of file NodeComponent.hpp.

const ComponentFactory* se_core::Component::factory_ [protected, inherited]
 

Definition at line 120 of file Component.hpp.

CompositeList se_core::SpawnAreaComponent::newSpawns_ [protected]
 

List of waiting to be spawned.

Definition at line 70 of file SpawnAreaComponent.hpp.

Composite* se_core::Component::owner_ [protected, inherited]
 

Definition at line 118 of file Component.hpp.

NodeComponent* se_core::NodeComponent::parent_ [protected, inherited]
 

The parent of this position.

Definition at line 89 of file NodeComponent.hpp.

int se_core::SpawnAreaComponent::spawnPointCount_ [protected]
 

The number of spawn points.

Definition at line 73 of file SpawnAreaComponent.hpp.

const ViewPoint* const* se_core::SpawnAreaComponent::spawnPoints_ [protected]
 

List of spawn points associated with this SpawnComponent.

Definition at line 76 of file SpawnAreaComponent.hpp.

int se_core::Component::type_ [protected, inherited]
 

The type of Component.

Definition at line 117 of file Component.hpp.


The documentation for this class was generated from the following files:

Home Page | SagaEngine trunk (updated nightly) reference generated Sun Dec 2 20:06:28 2007 by Doxygen version 1.3.9.1.

SourceForge.net Logo