Eegeo::Pins::PinsModule Class Reference

Object graph for a default implementation of Pin control and rendering. More...

#include <PinsModule.h>

Inheritance diagram for Eegeo::Pins::PinsModule:

Public Member Functions
	PinsModule (const Eegeo::Rendering::TTextureId iconsTexturePageId, const Eegeo::Rendering::ITexturePageLayout &texturePageLayout, Eegeo::Pins::IPinViewFactory *pPinViewFactory, Rendering::GlBufferPool &glBufferPool, Rendering::Shaders::ShaderIdGenerator &shaderIdGenerator, Rendering::Materials::MaterialIdGenerator &materialIdGenerator, Rendering::VertexLayouts::VertexBindingPool &vertexBindingPool, Rendering::VertexLayouts::VertexLayoutPool &vertexLayoutPool, Rendering::RenderableFilters &renderableFilters, Resources::Terrain::Heights::TerrainHeightProvider &terrainHeightProvider, const Rendering::LayerIds::Values layerId, const Rendering::EnvironmentFlatteningService &environmentFlatteningService, const Rendering::ScreenProperties &screenProperties, const bool useLegacyScaling)
	Create an object graph for rendering a set of Pins as sprites (for a simpler creation path, see the Create(..) method)
	~PinsModule ()
void	Update (float dt, const Camera::RenderCamera &renderCamera)
void	UpdateScreenProperties (const Rendering::ScreenProperties &screenProperties)
PinRepository &	GetRepository () const
PinController &	GetController () const

Static Public Member Functions
static PinsModule *	Create (Eegeo::Modules::Core::RenderingModule &renderingModule, Eegeo::Modules::IPlatformAbstractionModule &platformAbstractonModule, Eegeo::Modules::Map::MapModule &mapModule, const Eegeo::Rendering::TTextureId pinIconsTextureId, const Eegeo::Rendering::ITexturePageLayout &texturePageLayout, const Eegeo::Rendering::LayerIds::Values layerId, const float spriteWidth, const float spriteHeight, const Rendering::ScreenProperties &screenProperties, const bool useLegacyScaling)
	Factory method that creates an object graph for rendering a set of Pins as sprites.
static PinsModule *	CreateWithAtlas (Eegeo::Modules::Core::RenderingModule &renderingModule, Eegeo::Modules::IPlatformAbstractionModule &platformAbstractonModule, Eegeo::Modules::Map::MapModule &mapModule, const Eegeo::Rendering::TTextureId pinIconsTextureId, const Eegeo::Rendering::AtlasTexturePageLayout &texturePageLayout, const Eegeo::Rendering::LayerIds::Values layerId, const Rendering::ScreenProperties &screenProperties)
	Factory method that creates an object graph for rendering a set of Pins as sprites using a texture atlas layout.

Additional Inherited Members
Protected Member Functions inherited from Eegeo::NonCopyable
	NonCopyable (const NonCopyable &)=delete
NonCopyable &	operator= (const NonCopyable &)=delete

Detailed Description

Object graph for a default implementation of Pin control and rendering.

This module creates an object graph to display Pins as sprites using icons from a given texture page. It is provided in source code form as a guide for applications with a requirement to display Pins in an alternate way.

Constructor & Destructor Documentation

Eegeo::Pins::PinsModule::~PinsModule ( )

inline

Destroy the PinsModule.

Member Function Documentation

PinController& Eegeo::Pins::PinsModule::GetController ( ) const

inline

Retrieve the PinController from the module.

Returns

The PinController.

PinRepository& Eegeo::Pins::PinsModule::GetRepository ( ) const

inline

Retrieve the PinRepository from the module.

Returns

The PinRepository.

void Eegeo::Pins::PinsModule::Update ( float  dt, const Camera::RenderCamera &  renderCamera  )

inline

Update the state of the PinsModule with respect to elapsed time.

Parameters

dt	The time elapsed, in seconds, since this method was last called.
renderCamera	The currentActiveRenderCamera

void Eegeo::Pins::PinsModule::UpdateScreenProperties ( const Rendering::ScreenProperties &  screenProperties )

inline

Update the screen properties so pins can be rendered correctly. Should be called when screen properties change (i.e. changing orientation)

Parameters

screenProperties

the updated ScreenProperties object

---

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

• platform/Pins/PinsModule.h
• platform/Pins/PinsModule.cpp