yap::IDrawingContext Struct Reference

A context to render graphical objects. Possesses a set of Camera associated to each CameraMode. More...

#include <IDrawingContext.hpp>

Inheritance diagram for yap::IDrawingContext:

Collaboration diagram for yap::IDrawingContext:

List of all members.

Public Member Functions
virtual	~IDrawingContext ()
virtual void	AddCamera (const CameraMode &mode, ICamera *camera)=0
	Adds an ICamera associated to a CameraMode.
virtual void	RemoveCamera (const CameraMode &mode)=0
	Remove an ICamera associated to a CameraMode.
virtual const ICamera &	GetCamera () const =0
	Gets the Camera associated to the CameraMode currently used.
virtual ICamera &	GetCamera ()=0
	Gets the Camera associated to the CameraMode currently used.
virtual const ICamera &	GetCamera (const CameraMode &mode) const =0
	Gets the Camera associated to a CameraMode.
virtual ICamera &	GetCamera (const CameraMode &mode)=0
	Gets the Camera associated to a CameraMode.
virtual void	SetMode (const CameraMode &mode)=0
	Sets the CameraMode currently used by the IDrawingContext.
virtual void	SetDefaultMode (const CameraMode &mode)=0
	Sets the CameraMode used by default i-e the CameraMode when IDrawingContext::SetDefaultCamera () is called.
virtual void	SetDefaultCamera ()=0
	Sets the default CameraMode as the current one used.
virtual const sf::RenderTarget &	GetRenderTarget () const =0
	Gets the RenderTarget of this IDrawingContext.
virtual sf::RenderTarget &	GetRenderTarget ()=0
	Gets the RenderTarget of this IDrawingContext.
virtual void	Draw (const sf::Drawable &drawable)=0
	Renders the Drawable into the RenderTarget of this DrawingContext with the current settings.
virtual const sf::Color &	GetTargetClearColor () const =0
virtual void	SetTargetClearColor (const sf::Color &color)=0
virtual void	ChangeSize (const Vector2 &size)=0

---

Detailed Description

A context to render graphical objects. Possesses a set of Camera associated to each CameraMode.

Definition at line 22 of file IDrawingContext.hpp.

---

Constructor & Destructor Documentation

virtual yap::IDrawingContext::~IDrawingContext ( )

inlinevirtual

Definition at line 24 of file IDrawingContext.hpp.

---

Member Function Documentation

virtual void yap::IDrawingContext::AddCamera ( const CameraMode &  mode, ICamera *  camera  )

pure virtual

Adds an ICamera associated to a CameraMode.

Parameters:

mode	CameraMode associated to the ICamera.
camera	ICamera associated to the CameraMode.

Implemented in yap::DrawingContext.

Here is the caller graph for this function:

virtual void yap::IDrawingContext::ChangeSize ( const Vector2 &  size )

pure virtual

Implemented in yap::DrawingContext.

Here is the caller graph for this function:

virtual void yap::IDrawingContext::Draw ( const sf::Drawable &  drawable )

pure virtual

Renders the Drawable into the RenderTarget of this DrawingContext with the current settings.

Parameters:

drawable

Drawable to render into this IDrawingContext.

Implemented in yap::DrawingContext.

Here is the caller graph for this function:

virtual const ICamera& yap::IDrawingContext::GetCamera ( ) const

pure virtual

Gets the Camera associated to the CameraMode currently used.

Returns:

A constant reference to the current Camera.

Implemented in yap::DrawingContext.

Here is the caller graph for this function:

virtual ICamera& yap::IDrawingContext::GetCamera ( )

pure virtual

Gets the Camera associated to the CameraMode currently used.

Returns:

A non-constant reference to the current Camera.

Implemented in yap::DrawingContext.

virtual const ICamera& yap::IDrawingContext::GetCamera ( const CameraMode &  mode ) const

pure virtual

Gets the Camera associated to a CameraMode.

Parameters:

mode	CameraMode to get the Camera associated with.

Returns:

A constant reference to the Camera.

Implemented in yap::DrawingContext.

virtual ICamera& yap::IDrawingContext::GetCamera ( const CameraMode &  mode )

pure virtual

Gets the Camera associated to a CameraMode.

Parameters:

mode	CameraMode to get the Camera associated with.

Returns:

A non-constant reference to the Camera.

Implemented in yap::DrawingContext.

virtual const sf::RenderTarget& yap::IDrawingContext::GetRenderTarget ( ) const

pure virtual

Gets the RenderTarget of this IDrawingContext.

Returns:

A constant reference to the RenderTarget.

Implemented in yap::DrawingContext.

virtual sf::RenderTarget& yap::IDrawingContext::GetRenderTarget ( )

pure virtual

Gets the RenderTarget of this IDrawingContext.

Returns:

A non-constant reference to the RenderTarget.

Implemented in yap::DrawingContext.

virtual const sf::Color& yap::IDrawingContext::GetTargetClearColor ( ) const

pure virtual

Implemented in yap::DrawingContext.

Here is the caller graph for this function:

virtual void yap::IDrawingContext::RemoveCamera ( const CameraMode &  mode )

pure virtual

Remove an ICamera associated to a CameraMode.

Parameters:

mode	CameraMode associated to the ICamera to remove.

Implemented in yap::DrawingContext.

virtual void yap::IDrawingContext::SetDefaultCamera ( )

pure virtual

Sets the default CameraMode as the current one used.

Implemented in yap::DrawingContext.

Here is the caller graph for this function:

virtual void yap::IDrawingContext::SetDefaultMode ( const CameraMode &  mode )

pure virtual

Sets the CameraMode used by default i-e the CameraMode when IDrawingContext::SetDefaultCamera () is called.

Parameters:

mode	CameraMode to set by default.

Implemented in yap::DrawingContext.

virtual void yap::IDrawingContext::SetMode ( const CameraMode &  mode )

pure virtual

Sets the CameraMode currently used by the IDrawingContext.

Parameters:

mode	CameraMode to use.

Implemented in yap::DrawingContext.

Here is the caller graph for this function:

virtual void yap::IDrawingContext::SetTargetClearColor ( const sf::Color &  color )

pure virtual

Implemented in yap::DrawingContext.

Here is the caller graph for this function:

---

The documentation for this struct was generated from the following file:

• G:/YAPOG/YAPOG/YAPOG/include/YAPOG/Graphics/IDrawingContext.hpp