InstanceActivity gets allocated in case there is some runtime activity related to the instance. More...

Collaboration diagram for FIFE::Instance::InstanceActivity:

Public Member Functions
	InstanceActivity (Instance &source)

	~InstanceActivity ()

void	update (Instance &source)
	updates cached variables, marks changes More...

Public Attributes
Location	m_location
	location on previous round More...

Location	m_oldLocation
	location on previous cell More...

int32_t	m_rotation
	rotation on previous round More...

int32_t	m_oldRotation
	rotation on previous round More...

Action *	m_action
	action on previous round. : might become invalid, only used for address comparison More...

double	m_speed
	speed on previous round More...

float	m_timeMultiplier
	time multiplier on previous round More...

std::string	m_sayText
	say text on previous round More...

std::vector < InstanceChangeListener * >	m_changeListeners
	listeners for changes More...

std::vector < InstanceActionListener * >	m_actionListeners
	listeners for action related events More...

ActionInfo *	m_actionInfo
	action information, allocated when actions are bind More...

SayInfo *	m_sayInfo
	text to say + duration, allocated when something is said More...

TimeProvider *	m_timeProvider
	time scaler for this instance More...

bool	m_blocking
	blocking status on previous round More...

InstanceChangeInfo	m_additional
	additional change info, used for visual class (transparency, visible, stackpos) More...

Detailed Description

InstanceActivity gets allocated in case there is some runtime activity related to the instance.

Keeping activity related variables in separate class keeps memory consumption lower e.g. for large tile areas. Class also keeps track of changes since the previous update call. With this bookkeeping, it is possible to optimize several spots in the engine, basically only reacting to changes instead of polling.

Definition at line 557 of file instance.h.

Constructor & Destructor Documentation

FIFE::Instance::InstanceActivity::InstanceActivity ( Instance & source )

Definition at line 112 of file instance.cpp.

FIFE::Instance::InstanceActivity::~InstanceActivity ( )

Definition at line 130 of file instance.cpp.

Member Function Documentation

void FIFE::Instance::InstanceActivity::update ( Instance & source )

updates cached variables, marks changes

Definition at line 136 of file instance.cpp.

References FIFE::Location::getLayer(), FIFE::Location::getLayerCoordinates(), FIFE::ICHANGE_ACTION, FIFE::ICHANGE_BLOCK, FIFE::ICHANGE_CELL, FIFE::ICHANGE_LOC, FIFE::ICHANGE_NO_CHANGES, FIFE::ICHANGE_ROTATION, FIFE::ICHANGE_SAYTEXT, FIFE::ICHANGE_SPEED, FIFE::ICHANGE_TIME_MULTIPLIER, FIFE::Instance::m_blocking, FIFE::Instance::m_changeInfo, FIFE::Instance::m_location, and FIFE::Instance::m_rotation.

Referenced by FIFE::Instance::update().

Here is the caller graph for this function:

Member Data Documentation

Action* FIFE::Instance::InstanceActivity::m_action

action on previous round. : might become invalid, only used for address comparison

Definition at line 574 of file instance.h.

Referenced by FIFE::Instance::cancelAction(), and FIFE::Instance::finalizeAction().

ActionInfo* FIFE::Instance::InstanceActivity::m_actionInfo

std::vector<InstanceActionListener*> FIFE::Instance::InstanceActivity::m_actionListeners

listeners for action related events

Definition at line 586 of file instance.h.

Referenced by FIFE::Instance::addActionListener(), FIFE::Instance::callOnActionFrame(), FIFE::Instance::cancelAction(), FIFE::Instance::finalizeAction(), FIFE::Instance::removeActionListener(), FIFE::Instance::update(), and FIFE::Instance::~Instance().

InstanceChangeInfo FIFE::Instance::InstanceActivity::m_additional

additional change info, used for visual class (transparency, visible, stackpos)

Definition at line 596 of file instance.h.

Referenced by FIFE::Instance::addAnimationOverlay(), FIFE::Instance::addColorOverlay(), FIFE::Instance::addStaticColorOverlay(), FIFE::Instance::callOnStackPositionChange(), FIFE::Instance::callOnTransparencyChange(), FIFE::Instance::callOnVisibleChange(), FIFE::Instance::removeAnimationOverlay(), FIFE::Instance::removeColorOverlay(), and FIFE::Instance::removeStaticColorOverlay().

bool FIFE::Instance::InstanceActivity::m_blocking

blocking status on previous round

Definition at line 594 of file instance.h.

std::vector<InstanceChangeListener*> FIFE::Instance::InstanceActivity::m_changeListeners

listeners for changes

Definition at line 582 of file instance.h.

Referenced by FIFE::Instance::addChangeListener(), FIFE::Instance::removeChangeListener(), and FIFE::Instance::update().

Location FIFE::Instance::InstanceActivity::m_location

location on previous round

Definition at line 566 of file instance.h.

Location FIFE::Instance::InstanceActivity::m_oldLocation

location on previous cell

Definition at line 568 of file instance.h.

Referenced by FIFE::Instance::getOldLocationRef().

int32_t FIFE::Instance::InstanceActivity::m_oldRotation

rotation on previous round

Definition at line 572 of file instance.h.

Referenced by FIFE::Instance::getOldRotation().

int32_t FIFE::Instance::InstanceActivity::m_rotation

rotation on previous round

Definition at line 570 of file instance.h.

SayInfo* FIFE::Instance::InstanceActivity::m_sayInfo

text to say + duration, allocated when something is said

Definition at line 590 of file instance.h.

Referenced by FIFE::Instance::getSayText(), FIFE::Instance::say(), and FIFE::Instance::update().

std::string FIFE::Instance::InstanceActivity::m_sayText

say text on previous round

Definition at line 580 of file instance.h.

double FIFE::Instance::InstanceActivity::m_speed

speed on previous round

Definition at line 576 of file instance.h.

float FIFE::Instance::InstanceActivity::m_timeMultiplier

time multiplier on previous round

Definition at line 578 of file instance.h.

TimeProvider* FIFE::Instance::InstanceActivity::m_timeProvider

time scaler for this instance

Definition at line 592 of file instance.h.

Referenced by FIFE::Instance::bindTimeProvider(), FIFE::Instance::getActionRuntime(), FIFE::Instance::getRuntime(), FIFE::Instance::getTimeMultiplier(), FIFE::Instance::getTotalTimeMultiplier(), FIFE::Instance::processMovement(), FIFE::Instance::setTimeMultiplier(), and FIFE::Instance::update().

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

engine/core/model/structures/instance.h
engine/core/model/structures/instance.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation