se_core::SignalComponent Class Reference

#include <SignalComponent.hpp>

Inheritance diagram for se_core::SignalComponent:

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

Public Types

typedef ComponentPtr< SignalComponent,
sct_SIGNAL > 
Ptr

Public Member Functions

 SignalComponent (Composite *owner, const ComponentFactory *factory=0)
virtual ~SignalComponent ()
const char * name () const
 By default returns name of composite, which returns name of composite factory.
void setSendId (int id)
void setRecieveId (int id, const Signal *signal)
void setDead ()
 Called by Composite.
bool send (bool state)
long sentAge () const
void recieve (int id, bool state)
void zoneChanged (int type, Composite *newArea, Composite *oldArea)
 AreaChild should have area as parent.
bool isOn () const
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

Static Public Member Functions

SignalComponent * get (Composite &composite)
SignalComponent * get (Component &component)

Protected Member Functions

void cleanup ()
 Called by Composite.
void parentChanged (Composite *newParent, Composite *oldParent)
 Override NodeComponent with empty handler.
void addChild (NodeComponent &node)
 Add a NodeComponent as a child.
void removeChild (NodeComponent &node)
 Add a NodeComponent from the child list.
virtual void setActive (bool state)
 Called by Composite.
virtual void init ()
 Called by Composite.

Protected Attributes

bool sendState_
int sendId_
long sentWhen_
unsigned long recieveMask_
const Signal * signal_
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 Composite

Member Typedef Documentation

typedef ComponentPtr<SignalComponent, sct_SIGNAL> se_core::SignalComponent::Ptr
 

Definition at line 37 of file SignalComponent.hpp.


Constructor & Destructor Documentation

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

Definition at line 34 of file SignalComponent.cpp.

References se_core::sct_SIGNAL.

se_core::SignalComponent::~SignalComponent (   )  [virtual]
 

Definition at line 41 of file SignalComponent.cpp.

References se_core::IoSchema::cleanup().


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::SignalComponent::cleanup (   )  [protected, virtual]
 

Called by Composite.

Reimplemented from se_core::NodeComponent.

Definition at line 47 of file SignalComponent.cpp.

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().

SignalComponent* se_core::SignalComponent::get (  Component &  component  )  [inline, static]
 

Definition at line 48 of file SignalComponent.hpp.

References se_core::Composite::component(), and se_core::Component::owner().

SignalComponent* se_core::SignalComponent::get (  Composite &  composite  )  [inline, static]
 

Definition at line 43 of file SignalComponent.hpp.

References se_core::Composite::component().

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().

bool se_core::SignalComponent::isOn (   )  const [inline]
 

Definition at line 68 of file SignalComponent.hpp.

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

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

Reimplemented from se_core::Component.

Definition at line 41 of file SignalComponent.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(), 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::AreaChildComponent::parentChanged (  Composite *  newParent,
Composite *  oldParent
)  [inline, protected, virtual, inherited]
 

Override NodeComponent with empty handler.

Reimplemented from se_core::NodeComponent.

Definition at line 38 of file AreaChildComponent.hpp.

void se_core::SignalComponent::recieve (  int  id,
bool  state
) 
 

Definition at line 79 of file SignalComponent.cpp.

Referenced by se_core::SignalAreaComponent::propagate().

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.

bool se_core::SignalComponent::send (  bool  state  ) 
 

Definition at line 60 of file SignalComponent.cpp.

References se_core::SignalAreaComponent::setSignalActive().

long se_core::SignalComponent::sentAge (   )  const
 

Definition at line 74 of file SignalComponent.cpp.

virtual void se_core::Component::setActive (  bool  state  )  [inline, protected, virtual, inherited]
 

Called by Composite.

Reimplemented in se_core::RootChildComponent, se_core::ActionComponent, se_core::CutsceneAreaComponent, se_core::PhysicsAreaComponent, se_core::CollisionAreaComponent, se_core::ScriptComponent, se_core::SignalAreaComponent, se_core::SpawnAreaComponent, se_core::ZoneAreaComponent, se_client::CameraComponent, se_client::PlayerComponent, se_ogre::O3dAreaComponent, se_ogre::O3dThingComponent, and se_basic::NavMeshAreaComponent.

Definition at line 93 of file Component.hpp.

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

void se_core::SignalComponent::setDead (   )  [virtual]
 

Called by Composite.

Reimplemented from se_core::Component.

Definition at line 54 of file SignalComponent.cpp.

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

Definition at line 50 of file NodeComponent.cpp.

References se_core::NodeComponent::addChild().

void se_core::SignalComponent::setRecieveId (  int  id,
const Signal *  signal
)  [inline]
 

Definition at line 57 of file SignalComponent.hpp.

void se_core::SignalComponent::setSendId (  int  id  )  [inline]
 

Definition at line 53 of file SignalComponent.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::SignalComponent::zoneChanged (  int  type,
Composite *  newArea,
Composite *  oldArea
)  [virtual]
 

AreaChild should have area as parent.

Reimplemented from se_core::AreaChildComponent.

Definition at line 87 of file SignalComponent.cpp.

References se_core::Composite::component(), and se_core::SignalAreaComponent::setSignalActive().


Friends And Related Function Documentation

friend class Composite [friend, inherited]
 

Definition at line 89 of file Component.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.

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.

unsigned long se_core::SignalComponent::recieveMask_ [protected]
 

Definition at line 79 of file SignalComponent.hpp.

int se_core::SignalComponent::sendId_ [protected]
 

Definition at line 77 of file SignalComponent.hpp.

bool se_core::SignalComponent::sendState_ [protected]
 

Definition at line 76 of file SignalComponent.hpp.

long se_core::SignalComponent::sentWhen_ [protected]
 

Definition at line 78 of file SignalComponent.hpp.

const Signal* se_core::SignalComponent::signal_ [protected]
 

Definition at line 80 of file SignalComponent.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