#include <instancerenderer.h>

Inheritance diagram for FIFE::InstanceRenderer:

Collaboration diagram for FIFE::InstanceRenderer:

Classes
class	AreaInfo

class	ColoringInfo

class	OutlineInfo

struct	s_image_entry

Public Member Functions
	InstanceRenderer (RenderBackend *renderbackend, int32_t position)
	constructor. More...

	InstanceRenderer (const InstanceRenderer &old)

RendererBase *	clone ()
	Makes copy of this renderer. More...

virtual	~InstanceRenderer ()
	Destructor. More...

void	render (Camera cam, Layer layer, RenderList &instances)
	This method is called by the view to ask renderer to draw its rendering aspect based on given parameters. More...

std::string	getName ()
	Name of the renderer. More...

void	addOutlined (Instance *instance, int32_t r, int32_t g, int32_t b, int32_t width, int32_t threshold=1)
	Marks given instance to be outlined with given parameters. More...

void	addColored (Instance *instance, int32_t r, int32_t g, int32_t b, int32_t a=128)
	Marks given instance to be colored with given parameters. More...

void	addTransparentArea (Instance *instance, const std::list< std::string > &groups, uint32_t w, uint32_t h, uint8_t trans, bool front=true)
	Marks given instance to have a transparent area with given parameters. More...

void	removeOutlined (Instance *instance)
	Removes instance from outlining list. More...

void	removeColored (Instance *instance)
	Removes instance from coloring list. More...

void	removeTransparentArea (Instance *instance)
	Removes instance form area list. More...

void	removeAllOutlines ()
	Removes all outlines. More...

void	removeAllColored ()
	Removes all coloring. More...

void	removeAllTransparentAreas ()
	Removes all transparent areas. More...

void	addIgnoreLight (const std::list< std::string > &groups)
	Add groups(Namespaces) into a list. More...

void	removeIgnoreLight (const std::list< std::string > &groups)
	Removes groups(Namespaces) from the list. More...

void	removeAllIgnoreLight ()
	Removes all groups(Namespaces) More...

RenderBackend *	getRenderBackend () const
	Provides access point to the RenderBackend. More...

void	reset ()
	Removes all stuff. More...

void	setRemoveInterval (uint32_t interval)
	Sets the interval in seconds (default is 60). More...

uint32_t	getRemoveInterval () const
	Gets the interval in seconds (default is 60). More...

void	addToCheck (const ImagePtr &image)
	Add properly old ImagePtr into a check list. More...

void	check ()
	Timer callback, tried to remove old effect images. More...

void	removeInstance (Instance *instance)
	Removes instance from all effects. More...

bool	needColorBinding ()
	Returns true if coloring need binding, otherwise false. More...

Public Member Functions inherited from FIFE::RendererBase
	RendererBase (RenderBackend *renderbackend, int32_t position)
	Constructor. More...

	RendererBase (const RendererBase &old)
	Copy Constructor. More...

virtual	~RendererBase ()
	Destructor. More...

int32_t	getPipelinePosition () const
	Gets renderer position in the rendering pipeline. More...

void	setPipelinePosition (int32_t position)
	Sets renderer position in the rendering pipeline Pipeline position defines in which order view calls the renderers when update occurs Note that renderers are called once per rendered layer, thus to update the whole screen, renderer might receive multiple calls. More...

virtual void	setEnabled (bool enabled)
	Enables renderer. More...

bool	isEnabled () const
	Is renderer enabled. More...

void	setRendererListener (IRendererListener *listener)
	Sets listener for renderer. More...

void	addActiveLayer (Layer *layer)
	Adds active layer to renderer. More...

void	removeActiveLayer (Layer *layer)
	Removes active layer from renderer. More...

void	clearActiveLayers ()
	Clears all active layers from renderer. More...

void	activateAllLayers (Map *elevation)
	Activates all layers from given elevation. More...

bool	isActivedLayer (Layer *layer)
	Returns if given layer is currently activated. More...

std::list< Layer * >	getActiveLayers () const
	Returns list of activated layer. More...

Static Public Member Functions
static InstanceRenderer *	getInstance (IRendererContainer *cnt)
	Gets instance for interface access. More...

Private Types
enum	InstanceRendererEffect { NOTHING = 0x00, OUTLINE = 0x01, COLOR = 0x02, AREA = 0x04 }

typedef uint8_t	Effect

typedef std::map< Instance *, OutlineInfo >	InstanceToOutlines_t

typedef std::map< Instance *, ColoringInfo >	InstanceToColoring_t

typedef std::map< Instance *, AreaInfo >	InstanceToAreas_t

typedef std::list< s_image_entry >	ImagesToCheck_t

typedef std::map< Instance *, Effect >	InstanceToEffects_t

Private Member Functions
void	renderOverlay (RenderDataType type, RenderItem item, uint8_t const coloringColor, bool recoloring)

Image *	bindOutline (OutlineInfo &info, RenderItem &vc, Camera *cam)
	Binds new outline (if needed) to the instance's OutlineInfo. More...

Image *	bindMultiOutline (OutlineInfo &info, RenderItem &vc, Camera *cam)

Image *	bindColoring (ColoringInfo &info, RenderItem &vc, Camera *cam)

ImagePtr	getMultiColorOverlay (const RenderItem &vc, OverlayColors *colors=0)

void	renderUnsorted (Camera cam, Layer layer, RenderList &instances)

void	renderAlreadySorted (Camera cam, Layer layer, RenderList &instances)

void	removeFromCheck (const ImagePtr &image)

bool	isValidImage (const ImagePtr &image)

Private Attributes
bool	m_area_layer

uint32_t	m_interval

bool	m_timer_enabled

std::list< std::string >	m_unlit_groups

bool	m_need_sorting

bool	m_need_bind_coloring

InstanceToOutlines_t	m_instance_outlines

InstanceToColoring_t	m_instance_colorings

InstanceToAreas_t	m_instance_areas

ImagesToCheck_t	m_check_images

Timer	m_timer

InstanceDeleteListener *	m_delete_listener

InstanceToEffects_t	m_assigned_instances

Additional Inherited Members
Protected Member Functions inherited from FIFE::RendererBase
	RendererBase ()

Protected Attributes inherited from FIFE::RendererBase
std::list< Layer * >	m_active_layers

RenderBackend *	m_renderbackend

Detailed Description

Definition at line 43 of file instancerenderer.h.

Member Typedef Documentation

typedef uint8_t FIFE::InstanceRenderer::Effect

private

Definition at line 162 of file instancerenderer.h.

typedef std::list<s_image_entry> FIFE::InstanceRenderer::ImagesToCheck_t

private

Definition at line 218 of file instancerenderer.h.

typedef std::map<Instance*, AreaInfo> FIFE::InstanceRenderer::InstanceToAreas_t

private

Definition at line 207 of file instancerenderer.h.

typedef std::map<Instance*, ColoringInfo> FIFE::InstanceRenderer::InstanceToColoring_t

private

Definition at line 206 of file instancerenderer.h.

typedef std::map<Instance*, Effect> FIFE::InstanceRenderer::InstanceToEffects_t

private

Definition at line 226 of file instancerenderer.h.

typedef std::map<Instance*, OutlineInfo> FIFE::InstanceRenderer::InstanceToOutlines_t

private

Definition at line 205 of file instancerenderer.h.

Member Enumeration Documentation

enum FIFE::InstanceRenderer::InstanceRendererEffect

private

Enumerator
NOTHING
OUTLINE
COLOR
AREA

Definition at line 156 of file instancerenderer.h.

Constructor & Destructor Documentation

FIFE::InstanceRenderer::InstanceRenderer	(	RenderBackend *	renderbackend,
		int32_t	position
	)

constructor.

Parameters

renderbackend	to use
position	position for this renderer in rendering pipeline

Definition at line 123 of file instancerenderer.cpp.

References check(), FIFE::RenderBackend::getName(), FIFE::RenderBackend::isDepthBufferEnabled(), m_delete_listener, m_interval, m_need_bind_coloring, m_need_sorting, FIFE::RendererBase::m_renderbackend, m_timer, FIFE::Timer::setCallback(), FIFE::RendererBase::setEnabled(), and FIFE::Timer::setInterval().

Referenced by clone().

Here is the caller graph for this function:

FIFE::InstanceRenderer::InstanceRenderer ( const InstanceRenderer & old )

Definition at line 147 of file instancerenderer.cpp.

References check(), FIFE::RenderBackend::getName(), FIFE::RenderBackend::isDepthBufferEnabled(), m_delete_listener, m_interval, m_need_bind_coloring, m_need_sorting, FIFE::RendererBase::m_renderbackend, m_timer, FIFE::Timer::setCallback(), FIFE::RendererBase::setEnabled(), and FIFE::Timer::setInterval().

FIFE::InstanceRenderer::~InstanceRenderer ( )

virtual

Destructor.

Definition at line 175 of file instancerenderer.cpp.

References m_assigned_instances, m_delete_listener, and reset().

Member Function Documentation

void FIFE::InstanceRenderer::addColored	(	Instance *	instance,
		int32_t	r,
		int32_t	g,
		int32_t	b,
		int32_t	a = `128`
	)

Marks given instance to be colored with given parameters.

Definition at line 1146 of file instancerenderer.cpp.

References FIFE::InstanceRenderer::ColoringInfo::a, FIFE::Instance::addDeleteListener(), FIFE::InstanceRenderer::ColoringInfo::b, COLOR, FIFE::InstanceRenderer::ColoringInfo::dirty, FIFE::InstanceRenderer::ColoringInfo::g, m_assigned_instances, m_delete_listener, m_instance_colorings, and FIFE::InstanceRenderer::ColoringInfo::r.

void FIFE::InstanceRenderer::addIgnoreLight ( const std::list< std::string > & groups )

Add groups(Namespaces) into a list.

All instances, whose namespace is in the list will not lighted from the LightRenderer.

Definition at line 1321 of file instancerenderer.cpp.

References m_unlit_groups.

void FIFE::InstanceRenderer::addOutlined	(	Instance *	instance,
		int32_t	r,
		int32_t	g,
		int32_t	b,
		int32_t	width,
		int32_t	threshold = `1`
	)

Marks given instance to be outlined with given parameters.

Definition at line 1103 of file instancerenderer.cpp.

References FIFE::Instance::addDeleteListener(), FIFE::InstanceRenderer::OutlineInfo::b, FIFE::InstanceRenderer::OutlineInfo::dirty, FIFE::InstanceRenderer::OutlineInfo::g, m_assigned_instances, m_delete_listener, m_instance_outlines, OUTLINE, FIFE::InstanceRenderer::OutlineInfo::r, FIFE::InstanceRenderer::OutlineInfo::threshold, and FIFE::InstanceRenderer::OutlineInfo::width.

void FIFE::InstanceRenderer::addToCheck ( const ImagePtr & image )

Add properly old ImagePtr into a check list.

If it is still not used after a time(interval) then it is freed.

Definition at line 1372 of file instancerenderer.cpp.

References FIFE::SharedPtr< T >::get(), FIFE::IResource::getName(), FIFE::TimeManager::getTime(), FIFE::InstanceRenderer::s_image_entry::image, FIFE::DynamicSingleton< TimeManager >::instance(), isValidImage(), m_check_images, m_timer, m_timer_enabled, FIFE::Timer::start(), and FIFE::InstanceRenderer::s_image_entry::timestamp.

Referenced by bindColoring(), bindOutline(), and getMultiColorOverlay().

Here is the caller graph for this function:

void FIFE::InstanceRenderer::addTransparentArea	(	Instance *	instance,
		const std::list< std::string > &	groups,
		uint32_t	w,
		uint32_t	h,
		uint8_t	trans,
		bool	front = `true`
	)

Marks given instance to have a transparent area with given parameters.

Definition at line 1186 of file instancerenderer.cpp.

References FIFE::Instance::addDeleteListener(), AREA, FIFE::InstanceRenderer::AreaInfo::front, FIFE::InstanceRenderer::AreaInfo::groups, FIFE::InstanceRenderer::AreaInfo::h, FIFE::InstanceRenderer::AreaInfo::instance, m_assigned_instances, m_delete_listener, m_instance_areas, FIFE::InstanceRenderer::AreaInfo::trans, and FIFE::InstanceRenderer::AreaInfo::w.

Image * FIFE::InstanceRenderer::bindColoring	(	ColoringInfo &	info,
		RenderItem &	vc,
		Camera *	cam
	)

private

Definition at line 960 of file instancerenderer.cpp.

References FIFE::InstanceRenderer::ColoringInfo::a, FIFE::ImageManager::add(), addToCheck(), FIFE::AMASK, FIFE::InstanceRenderer::ColoringInfo::b, FIFE::BMASK, FIFE::Image::copySubimage(), FIFE::RenderBackend::createImage(), FIFE::InstanceRenderer::ColoringInfo::curimg, FIFE::InstanceRenderer::ColoringInfo::dirty, FIFE::ImageManager::exists(), FIFE::Image::forceLoadInternal(), FIFE::InstanceRenderer::ColoringInfo::g, FIFE::SharedPtr< T >::get(), FIFE::Image::getHeight(), FIFE::IResource::getName(), FIFE::Image::getPixelRGBA(), FIFE::ImageManager::getPtr(), FIFE::Image::getWidth(), FIFE::GMASK, FIFE::RenderItem::image, FIFE::DynamicSingleton< ImageManager >::instance(), FIFE::Image::isSharedImage(), isValidImage(), FIFE::RendererBase::m_renderbackend, FIFE::InstanceRenderer::ColoringInfo::overlay, FIFE::Image::putPixel(), FIFE::InstanceRenderer::ColoringInfo::r, removeFromCheck(), FIFE::IResource::RES_LOADED, FIFE::RMASK, and FIFE::IResource::setState().

Referenced by renderAlreadySorted().

Here is the caller graph for this function:

Image * FIFE::InstanceRenderer::bindMultiOutline	(	OutlineInfo &	info,
		RenderItem &	vc,
		Camera *	cam
	)

private

Definition at line 847 of file instancerenderer.cpp.

References FIFE::aboveThreshold(), FIFE::ImageManager::add(), FIFE::AMASK, FIFE::InstanceRenderer::OutlineInfo::b, FIFE::BMASK, FIFE::Image::copySubimage(), FIFE::RenderBackend::createImage(), FIFE::InstanceRenderer::OutlineInfo::dirty, FIFE::ImageManager::exists(), FIFE::InstanceRenderer::OutlineInfo::g, FIFE::SharedPtr< T >::get(), FIFE::RenderItem::getAnimationOverlay(), FIFE::ImageManager::getPtr(), FIFE::GMASK, FIFE::DynamicSingleton< ImageManager >::instance(), isValidImage(), FIFE::RendererBase::m_renderbackend, FIFE::InstanceRenderer::OutlineInfo::outline, FIFE::Image::putPixel(), FIFE::InstanceRenderer::OutlineInfo::r, removeFromCheck(), FIFE::IResource::RES_LOADED, FIFE::RMASK, FIFE::IResource::setState(), FIFE::InstanceRenderer::OutlineInfo::threshold, and FIFE::InstanceRenderer::OutlineInfo::width.

Referenced by bindOutline().

Here is the caller graph for this function:

Image * FIFE::InstanceRenderer::bindOutline	(	OutlineInfo &	info,
		RenderItem &	vc,
		Camera *	cam
	)

private

Binds new outline (if needed) to the instance's OutlineInfo.

Definition at line 735 of file instancerenderer.cpp.

References FIFE::aboveThreshold(), FIFE::ImageManager::add(), addToCheck(), FIFE::AMASK, FIFE::InstanceRenderer::OutlineInfo::b, bindMultiOutline(), FIFE::BMASK, FIFE::Image::copySubimage(), FIFE::RenderBackend::createImage(), FIFE::InstanceRenderer::OutlineInfo::curimg, FIFE::InstanceRenderer::OutlineInfo::dirty, FIFE::ImageManager::exists(), FIFE::Image::forceLoadInternal(), FIFE::InstanceRenderer::OutlineInfo::g, FIFE::SharedPtr< T >::get(), FIFE::RenderItem::getAnimationOverlay(), FIFE::Image::getHeight(), FIFE::IResource::getName(), FIFE::Image::getPixelRGBA(), FIFE::ImageManager::getPtr(), FIFE::Image::getWidth(), FIFE::GMASK, FIFE::RenderItem::image, FIFE::DynamicSingleton< ImageManager >::instance(), FIFE::Image::isSharedImage(), isValidImage(), FIFE::RendererBase::m_renderbackend, FIFE::InstanceRenderer::OutlineInfo::outline, FIFE::Image::putPixel(), FIFE::InstanceRenderer::OutlineInfo::r, removeFromCheck(), FIFE::IResource::RES_LOADED, FIFE::RMASK, FIFE::IResource::setState(), FIFE::InstanceRenderer::OutlineInfo::threshold, and FIFE::InstanceRenderer::OutlineInfo::width.

Referenced by renderAlreadySorted(), and renderUnsorted().

Here is the caller graph for this function:

void FIFE::InstanceRenderer::check ( )

Timer callback, tried to remove old effect images.

Definition at line 1393 of file instancerenderer.cpp.

References FIFE::ImageManager::free(), FIFE::TimeManager::getTime(), FIFE::DynamicSingleton< TimeManager >::instance(), FIFE::DynamicSingleton< ImageManager >::instance(), isValidImage(), m_check_images, m_interval, m_timer, m_timer_enabled, and FIFE::Timer::stop().

Referenced by InstanceRenderer().

Here is the caller graph for this function:

RendererBase * FIFE::InstanceRenderer::clone ( )

virtual

Makes copy of this renderer.

Implements FIFE::RendererBase.

Definition at line 171 of file instancerenderer.cpp.

References InstanceRenderer().

InstanceRenderer * FIFE::InstanceRenderer::getInstance ( IRendererContainer * cnt )

static

Gets instance for interface access.

Definition at line 119 of file instancerenderer.cpp.

References FIFE::IRendererContainer::getRenderer().

Referenced by FIFE::MapLoader::load().

Here is the caller graph for this function:

ImagePtr FIFE::InstanceRenderer::getMultiColorOverlay	(	const RenderItem &	vc,
		OverlayColors *	colors = `0`
	)

private

Definition at line 1035 of file instancerenderer.cpp.

References FIFE::ImageManager::add(), addToCheck(), FIFE::AMASK, FIFE::BMASK, FIFE::RenderBackend::createImage(), FIFE::Image::detachSurface(), FIFE::Image::forceLoadInternal(), FIFE::SharedPtr< T >::get(), FIFE::RenderItem::getColorOverlay(), FIFE::OverlayColors::getColorOverlayImage(), FIFE::OverlayColors::getColors(), FIFE::Image::getHeight(), FIFE::IResource::getName(), FIFE::Image::getPixelRGBA(), FIFE::ImageManager::getPtr(), FIFE::Image::getWidth(), FIFE::GMASK, FIFE::DynamicSingleton< ImageManager >::instance(), FIFE::Image::isSharedImage(), isValidImage(), FIFE::RendererBase::m_renderbackend, FIFE::Image::putPixel(), removeFromCheck(), FIFE::IResource::RES_LOADED, FIFE::RMASK, FIFE::IResource::setState(), and FIFE::Image::setSurface().

Referenced by renderOverlay().

Here is the caller graph for this function:

std::string FIFE::InstanceRenderer::getName ( )

inlinevirtual

Name of the renderer.

Implements FIFE::RendererBase.

Definition at line 59 of file instancerenderer.h.

uint32_t FIFE::InstanceRenderer::getRemoveInterval ( ) const

Gets the interval in seconds (default is 60).

Definition at line 1368 of file instancerenderer.cpp.

References m_interval.

RenderBackend* FIFE::InstanceRenderer::getRenderBackend ( ) const

inline

Provides access point to the RenderBackend.

Definition at line 116 of file instancerenderer.h.

References FIFE::RendererBase::m_renderbackend.

bool FIFE::InstanceRenderer::isValidImage ( const ImagePtr & image )

private

Definition at line 1443 of file instancerenderer.cpp.

References FIFE::SharedPtr< T >::get(), FIFE::IResource::getState(), and FIFE::IResource::RES_LOADED.

Referenced by addToCheck(), bindColoring(), bindMultiOutline(), bindOutline(), check(), getMultiColorOverlay(), and removeFromCheck().

Here is the caller graph for this function:

bool FIFE::InstanceRenderer::needColorBinding ( )

inline

Returns true if coloring need binding, otherwise false.

Definition at line 146 of file instancerenderer.h.

References m_need_bind_coloring.

void FIFE::InstanceRenderer::removeAllColored ( )

Removes all coloring.

Definition at line 1285 of file instancerenderer.cpp.

References COLOR, m_assigned_instances, m_delete_listener, and m_instance_colorings.

Referenced by reset().

Here is the caller graph for this function:

void FIFE::InstanceRenderer::removeAllIgnoreLight ( )

Removes all groups(Namespaces)

Definition at line 1343 of file instancerenderer.cpp.

References m_unlit_groups.

Referenced by reset().

Here is the caller graph for this function:

void FIFE::InstanceRenderer::removeAllOutlines ( )

Removes all outlines.

Definition at line 1267 of file instancerenderer.cpp.

References m_assigned_instances, m_delete_listener, m_instance_outlines, and OUTLINE.

Referenced by reset().

Here is the caller graph for this function:

void FIFE::InstanceRenderer::removeAllTransparentAreas ( )

Removes all transparent areas.

Definition at line 1303 of file instancerenderer.cpp.

References AREA, m_assigned_instances, m_delete_listener, and m_instance_areas.

Referenced by reset().

Here is the caller graph for this function:

void FIFE::InstanceRenderer::removeColored ( Instance * instance )

Removes instance from coloring list.

Definition at line 1239 of file instancerenderer.cpp.

References COLOR, m_assigned_instances, m_delete_listener, m_instance_colorings, and FIFE::Instance::removeDeleteListener().

void FIFE::InstanceRenderer::removeFromCheck ( const ImagePtr & image )

private

Definition at line 1414 of file instancerenderer.cpp.

References FIFE::SharedPtr< T >::get(), FIFE::IResource::getName(), isValidImage(), m_check_images, m_timer, m_timer_enabled, and FIFE::Timer::stop().

Referenced by bindColoring(), bindMultiOutline(), bindOutline(), and getMultiColorOverlay().

Here is the caller graph for this function:

void FIFE::InstanceRenderer::removeIgnoreLight ( const std::list< std::string > & groups )

Removes groups(Namespaces) from the list.

Definition at line 1330 of file instancerenderer.cpp.

References m_unlit_groups.

void FIFE::InstanceRenderer::removeInstance ( Instance * instance )

Removes instance from all effects.

Should only be called by delete listener!

Definition at line 1432 of file instancerenderer.cpp.

References m_assigned_instances, m_delete_listener, m_instance_areas, m_instance_colorings, m_instance_outlines, and FIFE::Instance::removeDeleteListener().

Referenced by FIFE::InstanceRendererDeleteListener::onInstanceDeleted().

Here is the caller graph for this function:

void FIFE::InstanceRenderer::removeOutlined ( Instance * instance )

Removes instance from outlining list.

Definition at line 1225 of file instancerenderer.cpp.

References m_assigned_instances, m_delete_listener, m_instance_outlines, OUTLINE, and FIFE::Instance::removeDeleteListener().

void FIFE::InstanceRenderer::removeTransparentArea ( Instance * instance )

Removes instance form area list.

Definition at line 1253 of file instancerenderer.cpp.

References AREA, m_assigned_instances, m_delete_listener, m_instance_areas, and FIFE::Instance::removeDeleteListener().

void FIFE::InstanceRenderer::render	(	Camera *	cam,
		Layer *	layer,
		RenderList &	instances
	)

virtual

This method is called by the view to ask renderer to draw its rendering aspect based on given parameters.

Renderers receive non-clipped instance stack since there is no way to know which information is relevant for the renderer. E.g. effect renderer might need to know offscreen instance locations to be able to draw radiation coming from some instance not visible on the screen.

Parameters