SViewPort Class Reference

#include <SO3ViewPort.h>

List of all members.

Public Member Functions
	SViewPort (SWindow *parent, SCamera *targetCamera, int priority, float x, float y, float w, float h)
	~SViewPort ()
const Ogre::Viewport *	GetOgreViewPortPointer ()
const SWindow *	GetParentWindow () const
std::string	GetMaterialScheme ()
void	SetMaterialScheme (std::string existingScheme)
void	SetPositionAndSize (float x, float y, float w, float h)
void	ResizeToWindow (float w, float h)
float	GetLeft ()
float	GetTop ()
float	GetWidth ()
float	GetHeight ()
int	GetLeftPixels ()
int	GetTopPixels ()
int	GetWidthPixels ()
int	GetHeightPixels ()
int	GetPriority ()
bool	GetShadowsEnabled ()
void	SetShadowsEnabled (bool enableShadows)
void	SetBackgroundColour (int backgroundColor)
int	GetBackgroundColor ()
SCamera *	GetCamera ()
void	SetCamera (SCamera *camera)
bool	GetClearDepth ()
void	SetClearDepth (bool state)
bool	GetClearColor ()
void	SetClearColor (bool value)
void	Update ()
SCompositor *	CreateCompositor (std::string newCompositorName, std::string newSchemeName)
void	DeleteCompositor (SCompositor *existingCompositor)
SCompositor *	GetCompositor (std::string compositorName)
const SCompositorMap &	GetCompositorList () const
void	ClearCompositors ()
std::vector< std::string >	DeactivateCompositors ()
void	ActivateCompositors (std::vector< std::string > compositorsNamesList)
SRayCastResults	RayCast (int pixelsX, int pixelsY)
SRayCastResults	RayCast (float relX, float relY)
Public Attributes
Hikari::HikariManager *	O3HikariManager
SWindow *	currentWindow
int	channel
Protected Member Functions
void	AddCompositor (SCompositor *existingCompositor)
void	RemoveCompositor (SCompositor *existingCompositor)
void	RemoveCompositor (std::string compositorName)

---

Detailed Description

Definition at line 44 of file SO3ViewPort.h.

---

Constructor & Destructor Documentation

SViewPort::SViewPort	(	SWindow *	parent,
		SCamera *	targetCamera,
		int	priority,
		float	x,
		float	y,
		float	w,
		float	h
	)

Constructor.

Definition at line 23 of file SO3ViewPort.cpp.

SViewPort::~SViewPort

(

)

Destructor.

Definition at line 40 of file SO3ViewPort.cpp.

---

Member Function Documentation

void SViewPort::ActivateCompositors

(

std::vector< std::string >

compositorsNamesList )

Definition at line 222 of file SO3ViewPort.cpp.

void SViewPort::AddCompositor

(

SCompositor *

existingCompositor )

[protected]

Add a SCompositor object to the list of available compositors.

Definition at line 327 of file SO3ViewPort.cpp.

void SViewPort::ClearCompositors

(

)

Erase all the handled compositors.

Definition at line 313 of file SO3ViewPort.cpp.

SCompositor * SViewPort::CreateCompositor	(	std::string	newCompositorName,
		std::string	newSchemeName
	)

Create a new SCompositor Object

Definition at line 300 of file SO3ViewPort.cpp.

std::vector< std::string > SViewPort::DeactivateCompositors

(

)

Definition at line 202 of file SO3ViewPort.cpp.

void SViewPort::DeleteCompositor

(

SCompositor *

existingCompositor )

Delete an existing SCompositor Object

Definition at line 307 of file SO3ViewPort.cpp.

int SViewPort::GetBackgroundColor

(

)

Definition at line 153 of file SO3ViewPort.cpp.

SCamera * SViewPort::GetCamera

(

)

Definition at line 158 of file SO3ViewPort.cpp.

bool SViewPort::GetClearColor

(

)

Definition at line 257 of file SO3ViewPort.cpp.

bool SViewPort::GetClearDepth

(

)

Definition at line 233 of file SO3ViewPort.cpp.

SCompositor * SViewPort::GetCompositor

(

std::string

compositorName )

Return the SCompositor pointer corresponding to the name of an existing compositor handled by this class.

Definition at line 286 of file SO3ViewPort.cpp.

const SCompositorMap & SViewPort::GetCompositorList

(

)

const

Get a list of the available compositors.

Definition at line 295 of file SO3ViewPort.cpp.

float SViewPort::GetHeight

(

)

Definition at line 108 of file SO3ViewPort.cpp.

int SViewPort::GetHeightPixels

(

)

Definition at line 128 of file SO3ViewPort.cpp.

float SViewPort::GetLeft

(

)

Definition at line 93 of file SO3ViewPort.cpp.

int SViewPort::GetLeftPixels

(

)

Definition at line 113 of file SO3ViewPort.cpp.

std::string SViewPort::GetMaterialScheme

(

)

Definition at line 63 of file SO3ViewPort.cpp.

const Ogre::Viewport * SViewPort::GetOgreViewPortPointer

(

)

Definition at line 53 of file SO3ViewPort.cpp.

const SWindow * SViewPort::GetParentWindow

(

)

const

Definition at line 58 of file SO3ViewPort.cpp.

int SViewPort::GetPriority

(

)

Definition at line 133 of file SO3ViewPort.cpp.

bool SViewPort::GetShadowsEnabled

(

)

Definition at line 138 of file SO3ViewPort.cpp.

float SViewPort::GetTop

(

)

Definition at line 98 of file SO3ViewPort.cpp.

int SViewPort::GetTopPixels

(

)

Definition at line 118 of file SO3ViewPort.cpp.

float SViewPort::GetWidth

(

)

Definition at line 103 of file SO3ViewPort.cpp.

int SViewPort::GetWidthPixels

(

)

Definition at line 123 of file SO3ViewPort.cpp.

SRayCastResults SViewPort::RayCast	(	float	relX,
		float	relY
	)

Parameters:

relX	x viewport coordonate in relative terms [0 to 1].
relY	y viewport coordonate in relative terms [0 to 1].

Definition at line 375 of file SO3ViewPort.cpp.

SRayCastResults SViewPort::RayCast	(	int	pixelsX,
		int	pixelsY
	)

Parameters:

pixelX	x viewport coordonate in screen pixels
pixelY	y viewport coordonate in screen pixels

Definition at line 361 of file SO3ViewPort.cpp.

void SViewPort::RemoveCompositor

(

SCompositor *

existingCompositor )

[protected]

Remove a SCompositor object from the list of available compositors.

Definition at line 342 of file SO3ViewPort.cpp.

void SViewPort::RemoveCompositor

(

std::string

compositorName )

[protected]

Remove a SCompositor object from the list of available compositors.

Definition at line 347 of file SO3ViewPort.cpp.

void SViewPort::ResizeToWindow	(	float	w,
		float	h
	)

Definition at line 78 of file SO3ViewPort.cpp.

void SViewPort::SetBackgroundColour

(

int

backgroundColor )

Definition at line 148 of file SO3ViewPort.cpp.

void SViewPort::SetCamera

(

SCamera *

camera )

Definition at line 163 of file SO3ViewPort.cpp.

void SViewPort::SetClearColor

(

bool

value )

Definition at line 262 of file SO3ViewPort.cpp.

void SViewPort::SetClearDepth

(

bool

state )

Definition at line 238 of file SO3ViewPort.cpp.

void SViewPort::SetMaterialScheme

(

std::string

existingScheme )

Definition at line 68 of file SO3ViewPort.cpp.

void SViewPort::SetPositionAndSize	(	float	x,
		float	y,
		float	w,
		float	h
	)

Definition at line 73 of file SO3ViewPort.cpp.

void SViewPort::SetShadowsEnabled

(

bool

enableShadows )

Definition at line 143 of file SO3ViewPort.cpp.

void SViewPort::Update

(

)

Definition at line 281 of file SO3ViewPort.cpp.

---

Member Data Documentation

int SViewPort::channel

Definition at line 49 of file SO3ViewPort.h.

SWindow* SViewPort::currentWindow

Definition at line 48 of file SO3ViewPort.h.

Hikari::HikariManager* SViewPort::O3HikariManager

Definition at line 47 of file SO3ViewPort.h.

---

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

• SO3Engine/SO3Renderer/SO3ViewPort.h
• SO3Engine/SO3Renderer/SO3ViewPort.cpp