SO3::SEnvironmentComponent Class Reference

#include <SO3EnvironmentComponent.h>

Inheritance diagram for SO3::SEnvironmentComponent:

Public Member Functions
	SEnvironmentComponent (SEnvironment *parent, const std::string &environmentComponentName)
virtual	~SEnvironmentComponent ()
virtual void	Update (const Ogre::Real &updateTime)=0
virtual void	UpdateCamera (SViewPort *viewport)
SEnvironment *	GetEnvironment ()
bool	GetEnable ()
void	SetEnable (const bool &enableComponent)
void	RegisterViewport (SViewPort *viewport)
void	UnregisterViewport (SViewPort *viewport)
void	UnregisterCamera (Ogre::Camera *cam)
Public Member Functions inherited from SO3::SData
	SData (const std::string &dataName)
virtual	~SData ()
std::string	GetName () const
SUserObjectBindings &	GetUserObjectBindings ()
const SUserObjectBindings &	GetUserObjectBindings () const

Protected Types
typedef std::set< SViewPort * >	ViewportList

Protected Member Functions
void	Cleanup ()
ViewportList	GetRegisteredViewports ()
virtual void	SetEnableImpl (const bool &enableComponent)=0
virtual void	RegisterViewportImpl (SViewPort *viewport)=0
virtual void	UnregisterViewportImpl (SViewPort *viewport)=0
virtual void	UnregisterCameraImpl (Ogre::Camera *cam)

Protected Attributes
SEnvironment *	parentEnvironment
Protected Attributes inherited from SO3::SData
std::string	name

Detailed Description

Abstract class.

Definition at line 43 of file SO3EnvironmentComponent.h.

Member Typedef Documentation

ViewportList

typedef std::set<SViewPort*> SO3::SEnvironmentComponent::ViewportList

protected

Definition at line 48 of file SO3EnvironmentComponent.h.

Constructor & Destructor Documentation

SEnvironmentComponent()

SO3::SEnvironmentComponent::SEnvironmentComponent	(	SEnvironment *	parent,
		const std::string &	environmentComponentName
	)

Definition at line 37 of file SO3EnvironmentComponent.cpp.

~SEnvironmentComponent()

SO3::SEnvironmentComponent::~SEnvironmentComponent ( )

virtual

Definition at line 49 of file SO3EnvironmentComponent.cpp.

Member Function Documentation

Cleanup()

void SO3::SEnvironmentComponent::Cleanup ( )

protected

To be called in component inherited class dtor.

Definition at line 115 of file SO3EnvironmentComponent.cpp.

GetEnable()

bool SO3::SEnvironmentComponent::GetEnable

(

)

Definition at line 63 of file SO3EnvironmentComponent.cpp.

GetEnvironment()

SEnvironment * SO3::SEnvironmentComponent::GetEnvironment

(

)

Definition at line 58 of file SO3EnvironmentComponent.cpp.

GetRegisteredViewports()

SEnvironmentComponent::ViewportList SO3::SEnvironmentComponent::GetRegisteredViewports ( )

protected

Needed by inherited classes only, on SetEnableImpl for instance call.

Definition at line 110 of file SO3EnvironmentComponent.cpp.

RegisterViewport()

void SO3::SEnvironmentComponent::RegisterViewport

(

SViewPort *

viewport

)

Definition at line 86 of file SO3EnvironmentComponent.cpp.

RegisterViewportImpl()

virtual void SO3::SEnvironmentComponent::RegisterViewportImpl ( SViewPort *  viewport )

protectedpure virtual

Implemented in SO3::SSky, and SO3::SWater.

SetEnable()

void SO3::SEnvironmentComponent::SetEnable

(

const bool &

enableComponent

)

Definition at line 68 of file SO3EnvironmentComponent.cpp.

SetEnableImpl()

virtual void SO3::SEnvironmentComponent::SetEnableImpl ( const bool &  enableComponent )

protectedpure virtual

Implemented in SO3::SSky, and SO3::SWater.

UnregisterCamera()

void SO3::SEnvironmentComponent::UnregisterCamera

(

Ogre::Camera *

cam

)

Definition at line 77 of file SO3EnvironmentComponent.cpp.

UnregisterCameraImpl()

void SO3::SEnvironmentComponent::UnregisterCameraImpl ( Ogre::Camera *  cam )

protectedvirtual

Reimplemented in SO3::SSky.

Definition at line 82 of file SO3EnvironmentComponent.cpp.

UnregisterViewport()

void SO3::SEnvironmentComponent::UnregisterViewport

(

SViewPort *

viewport

)

Definition at line 98 of file SO3EnvironmentComponent.cpp.

UnregisterViewportImpl()

virtual void SO3::SEnvironmentComponent::UnregisterViewportImpl ( SViewPort *  viewport )

protectedpure virtual

Implemented in SO3::SSky, and SO3::SWater.

Update()

virtual void SO3::SEnvironmentComponent::Update ( const Ogre::Real &  updateTime )

pure virtual

Implemented in SO3::SSky, and SO3::SWater.

UpdateCamera()

void SO3::SEnvironmentComponent::UpdateCamera ( SViewPort *  viewport )

virtual

Reimplemented in SO3::SSky, and SO3::SWater.

Definition at line 127 of file SO3EnvironmentComponent.cpp.

Member Data Documentation

parentEnvironment

SEnvironment* SO3::SEnvironmentComponent::parentEnvironment

protected

Definition at line 47 of file SO3EnvironmentComponent.h.

---

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

• include/SO3SceneGraph/SO3EnvironmentComponent.h
• src/SO3SceneGraph/SO3EnvironmentComponent.cpp