SWindow Class Reference

#include <SO3Window.h>

Inheritance diagram for SWindow:

List of all members.

Public Types
enum	StereoMode {   SO3_NONE_STEREO = 0, SO3_ANAGLYPH_RC_STEREO = 1, SO3_ANAGLYPH_YB_STEREO = 2, SO3_DUALOUTPUT_STEREO = 3,   SO3_INTERLACED_V_STEREO = 4, SO3_INTERLACED_H_STEREO = 5, SO3_INTERLACED_CB_STEREO = 6 }
Public Member Functions
	SWindow (SRoot *parent, WindowHandle windowHandle, std::string windowName, int width, int height, std::string fsaa)
const Ogre::RenderWindow *	GetOgreRenderWindowPointer ()
	~SWindow ()
SRoot *	GetParentRoot ()
WindowHandle	GetWindowHandle ()
SViewPort *	CreateViewport (SCamera *camera, int priority, float x, float y, float w, float h)
void	DeleteViewport (SViewPort *existingViewport)
const SViewPortList &	GetViewportList () const
SViewPort *	GetViewport (int priority) const
SViewPort *	GetViewport (int x, int y)
void	windowMoved (Ogre::RenderWindow *rw)
void	windowResized (Ogre::RenderWindow *rw)
void	windowClosed (Ogre::RenderWindow *rw)
void	windowFocusChange (Ogre::RenderWindow *rw)
int	Size (int x, int y, int w, int h, int ext)
unsigned int	GetWidth () const
unsigned int	GetHeight () const
int	GetLeft ()
int	GetTop ()
bool	GetFullScreen ()
bool	SetFullScreen (bool fullscreen, int width, int height)
bool	CheckVideoMode (int width, int height)
unsigned int	GetColorDepth ()
void	Update ()
unsigned int	GetBatchCount () const
unsigned int	GetTriangleCount () const
float	GetBestFrameTime () const
float	GetWorstFrameTime () const
float	GetBestFPS () const
float	GetWorstFPS () const
float	GetAverageFPS () const
unsigned int	GetFSAA () const
void	SetStereoMode (StereoMode stereoMode, float eyesSpacing, float focalLength=-1.0f)
StereoMode	GetStereoMode ()
float	GetStereoEyesSpacing ()
void	SetStereoEyesSpacing (float eyesSpacing)
float	GetStereoFocalLength ()
void	SetStereoFocalLength (float focalLength)
SRayCastResults	RayCast (int pixelsX, int pixelsY)
Public Attributes
FlashControl *	lastOne
Protected Member Functions
void	AddViewport (SViewPort *existingViewport)
void	RemoveViewport (SViewPort *existingViewport)

---

Detailed Description

Definition at line 69 of file SO3Window.h.

---

Member Enumeration Documentation

enum SWindow::StereoMode

Enumerator:

SO3_NONE_STEREO
SO3_ANAGLYPH_RC_STEREO
SO3_ANAGLYPH_YB_STEREO
SO3_DUALOUTPUT_STEREO
SO3_INTERLACED_V_STEREO
SO3_INTERLACED_H_STEREO
SO3_INTERLACED_CB_STEREO

Definition at line 73 of file SO3Window.h.

---

Constructor & Destructor Documentation

SWindow::SWindow	(	SRoot *	parent,
		WindowHandle	windowHandle,
		std::string	windowName,
		int	width,
		int	height,
		std::string	fsaa
	)

Constructor.

Definition at line 49 of file SO3Window.cpp.

SWindow::~SWindow

(

)

Destructor.

Definition at line 123 of file SO3Window.cpp.

---

Member Function Documentation

void SWindow::AddViewport

(

SViewPort *

existingViewport )

[protected]

Add a SViewPort object to the list of handled viewports.

Definition at line 162 of file SO3Window.cpp.

bool SWindow::CheckVideoMode	(	int	width,
		int	height
	)

Definition at line 335 of file SO3Window.cpp.

SViewPort * SWindow::CreateViewport	(	SCamera *	camera,
		int	priority,
		float	x,
		float	y,
		float	w,
		float	h
	)

Create a new SViewPort Object

Definition at line 149 of file SO3Window.cpp.

void SWindow::DeleteViewport

(

SViewPort *

existingViewport )

Delete an existing SViewPort Object

Definition at line 156 of file SO3Window.cpp.

float SWindow::GetAverageFPS

(

)

const

Gets the average frames per second (FPS) since the start of the rendering.

Definition at line 402 of file SO3Window.cpp.

unsigned int SWindow::GetBatchCount

(

)

const

Gets the number of batches rendered in the last Update() call.

Definition at line 372 of file SO3Window.cpp.

float SWindow::GetBestFPS

(

)

const

Gets the best frames per second (FPS) since the start of the rendering.

Definition at line 392 of file SO3Window.cpp.

float SWindow::GetBestFrameTime

(

)

const

Gets the best frame time

Definition at line 382 of file SO3Window.cpp.

unsigned int SWindow::GetColorDepth

(

)

Definition at line 362 of file SO3Window.cpp.

unsigned int SWindow::GetFSAA

(

)

const

Indicates whether multisampling is performed on rendering and at what level.

Definition at line 407 of file SO3Window.cpp.

bool SWindow::GetFullScreen

(

)

Definition at line 330 of file SO3Window.cpp.

unsigned int SWindow::GetHeight

(

)

const

Definition at line 274 of file SO3Window.cpp.

int SWindow::GetLeft

(

)

Definition at line 279 of file SO3Window.cpp.

const Ogre::RenderWindow * SWindow::GetOgreRenderWindowPointer

(

)

Definition at line 144 of file SO3Window.cpp.

SRoot * SWindow::GetParentRoot

(

)

Definition at line 139 of file SO3Window.cpp.

float SWindow::GetStereoEyesSpacing

(

)

Definition at line 456 of file SO3Window.cpp.

float SWindow::GetStereoFocalLength

(

)

Return -1 if it's setted to "infinite focal length".

Definition at line 466 of file SO3Window.cpp.

SWindow::StereoMode SWindow::GetStereoMode

(

)

Definition at line 451 of file SO3Window.cpp.

int SWindow::GetTop

(

)

Definition at line 287 of file SO3Window.cpp.

unsigned int SWindow::GetTriangleCount

(

)

const

Gets the number of triangles rendered in the last Update() call.

Definition at line 377 of file SO3Window.cpp.

SViewPort * SWindow::GetViewport	(	int	x,
		int	y
	)

Get the viewport under the given window internal position;

Definition at line 211 of file SO3Window.cpp.

SViewPort * SWindow::GetViewport

(

int

priority )

const

Get the viewport at zorder.

Definition at line 195 of file SO3Window.cpp.

const SViewPortList & SWindow::GetViewportList

(

)

const

Get a list of the handled viewport.

Definition at line 190 of file SO3Window.cpp.

unsigned int SWindow::GetWidth

(

)

const

Definition at line 269 of file SO3Window.cpp.

WindowHandle SWindow::GetWindowHandle

(

)

Definition at line 134 of file SO3Window.cpp.

float SWindow::GetWorstFPS

(

)

const

Definition at line 397 of file SO3Window.cpp.

float SWindow::GetWorstFrameTime

(

)

const

Gets the worst frame time

Definition at line 387 of file SO3Window.cpp.

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

Definition at line 490 of file SO3Window.cpp.

void SWindow::RemoveViewport

(

SViewPort *

existingViewport )

[protected]

Remove a SViewPort object from the list of handled viewports.

Definition at line 176 of file SO3Window.cpp.

bool SWindow::SetFullScreen	(	bool	fullscreen,
		int	width,
		int	height
	)

True if success, false if an error occurs or aborting (ask fullScreen whenever it's always in fullscreen).

Definition at line 295 of file SO3Window.cpp.

void SWindow::SetStereoEyesSpacing

(

float

eyesSpacing )

Definition at line 461 of file SO3Window.cpp.

void SWindow::SetStereoFocalLength

(

float

focalLength )

Set to -1 to set "infinite focal length".

Definition at line 477 of file SO3Window.cpp.

void SWindow::SetStereoMode	(	StereoMode	stereoMode,
		float	eyesSpacing,
		float	focalLength = -1.0f
	)

To set infinite focalLength, set the parameter to -1;

Definition at line 412 of file SO3Window.cpp.

int SWindow::Size	(	int	x,
		int	y,
		int	w,
		int	h,
		int	ext
	)

Definition at line 253 of file SO3Window.cpp.

void SWindow::Update

(

)

Remarks:

, Warning, this implementation swap buffers!

Definition at line 367 of file SO3Window.cpp.

void SWindow::windowClosed

(

Ogre::RenderWindow *

rw )

void SWindow::windowFocusChange

(

Ogre::RenderWindow *

rw )

void SWindow::windowMoved

(

Ogre::RenderWindow *

rw )

void SWindow::windowResized

(

Ogre::RenderWindow *

rw )

---

Member Data Documentation

FlashControl* SWindow::lastOne

Definition at line 84 of file SO3Window.h.

---

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

• SO3Engine/SO3Renderer/SO3Window.h
• SO3Engine/SO3Renderer/SO3Window.cpp