SO3::SWindow Class Reference

#include <SO3Window.h>

Inheritance diagram for SO3::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 ()
void	RefreshSelector ()
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)
void	WindowMovedOrResized ()
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)
SRaycastResult	RayCast (int pixelsX, int pixelsY)
SRaycastResult &	GetLastRayCast ()
void	preRenderTargetUpdate (const Ogre::RenderTargetEvent &evt)
void	postRenderTargetUpdate (const Ogre::RenderTargetEvent &evt)
Protected Member Functions
void	AddViewport (SViewPort *existingViewport)
void	RemoveViewport (SViewPort *existingViewport)

---

Detailed Description

Definition at line 45 of file SO3Window.h.

---

Member Enumeration Documentation

enum SO3::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 49 of file SO3Window.h.

---

Constructor & Destructor Documentation

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

Constructor.

Definition at line 29 of file SO3Window.cpp.

SO3::SWindow::~SWindow

(

)

Destructor.

Definition at line 88 of file SO3Window.cpp.

---

Member Function Documentation

void SO3::SWindow::AddViewport

(

SViewPort *

existingViewport

)

[protected]

Add a SViewPort object to the list of handled viewports.

Definition at line 153 of file SO3Window.cpp.

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

Definition at line 360 of file SO3Window.cpp.

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

Create a new SViewPort Object

Definition at line 140 of file SO3Window.cpp.

void SO3::SWindow::DeleteViewport

(

SViewPort *

existingViewport

)

Delete an existing SViewPort Object

Definition at line 147 of file SO3Window.cpp.

float SO3::SWindow::GetAverageFPS

(

)

const

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

Definition at line 427 of file SO3Window.cpp.

unsigned int SO3::SWindow::GetBatchCount

(

)

const

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

Definition at line 397 of file SO3Window.cpp.

float SO3::SWindow::GetBestFPS

(

)

const

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

Definition at line 417 of file SO3Window.cpp.

float SO3::SWindow::GetBestFrameTime

(

)

const

Gets the best frame time

Definition at line 407 of file SO3Window.cpp.

unsigned int SO3::SWindow::GetColorDepth

(

)

Definition at line 387 of file SO3Window.cpp.

unsigned int SO3::SWindow::GetFSAA

(

)

const

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

Definition at line 432 of file SO3Window.cpp.

bool SO3::SWindow::GetFullScreen

(

)

Definition at line 355 of file SO3Window.cpp.

unsigned int SO3::SWindow::GetHeight

(

)

const

Definition at line 277 of file SO3Window.cpp.

SRaycastResult & SO3::SWindow::GetLastRayCast

(

)

Definition at line 531 of file SO3Window.cpp.

int SO3::SWindow::GetLeft

(

)

Definition at line 282 of file SO3Window.cpp.

const Ogre::RenderWindow * SO3::SWindow::GetOgreRenderWindowPointer

(

)

Definition at line 135 of file SO3Window.cpp.

SRoot * SO3::SWindow::GetParentRoot

(

)

Definition at line 130 of file SO3Window.cpp.

float SO3::SWindow::GetStereoEyesSpacing

(

)

Definition at line 481 of file SO3Window.cpp.

float SO3::SWindow::GetStereoFocalLength

(

)

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

Definition at line 491 of file SO3Window.cpp.

SWindow::StereoMode SO3::SWindow::GetStereoMode

(

)

Definition at line 476 of file SO3Window.cpp.

int SO3::SWindow::GetTop

(

)

Definition at line 290 of file SO3Window.cpp.

unsigned int SO3::SWindow::GetTriangleCount

(

)

const

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

Definition at line 402 of file SO3Window.cpp.

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

Get the viewport under the given window internal position;

Definition at line 206 of file SO3Window.cpp.

SViewPort * SO3::SWindow::GetViewport

(

int

priority

)

const

Get the viewport at zorder.

Definition at line 190 of file SO3Window.cpp.

const SViewPortList & SO3::SWindow::GetViewportList

(

)

const

Get a list of the handled viewport.

Definition at line 185 of file SO3Window.cpp.

unsigned int SO3::SWindow::GetWidth

(

)

const

Definition at line 272 of file SO3Window.cpp.

WindowHandle SO3::SWindow::GetWindowHandle

(

)

Definition at line 125 of file SO3Window.cpp.

float SO3::SWindow::GetWorstFPS

(

)

const

Definition at line 422 of file SO3Window.cpp.

float SO3::SWindow::GetWorstFrameTime

(

)

const

Gets the worst frame time

Definition at line 412 of file SO3Window.cpp.

void SO3::SWindow::postRenderTargetUpdate

(

const Ogre::RenderTargetEvent &

evt

)

Definition at line 114 of file SO3Window.cpp.

void SO3::SWindow::preRenderTargetUpdate

(

const Ogre::RenderTargetEvent &

evt

)

Definition at line 107 of file SO3Window.cpp.

SRaycastResult SO3::SWindow::RayCast	(	int	pixelsX,
		int	pixelsY
	)

Definition at line 515 of file SO3Window.cpp.

void SO3::SWindow::RefreshSelector

(

)

Definition at line 119 of file SO3Window.cpp.

void SO3::SWindow::RemoveViewport

(

SViewPort *

existingViewport

)

[protected]

Remove a SViewPort object from the list of handled viewports.

Definition at line 169 of file SO3Window.cpp.

bool SO3::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 298 of file SO3Window.cpp.

void SO3::SWindow::SetStereoEyesSpacing

(

float

eyesSpacing

)

Definition at line 486 of file SO3Window.cpp.

void SO3::SWindow::SetStereoFocalLength

(

float

focalLength

)

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

Definition at line 502 of file SO3Window.cpp.

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

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

Definition at line 437 of file SO3Window.cpp.

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

Definition at line 248 of file SO3Window.cpp.

void SO3::SWindow::Update

(

)

Remarks:

, Warning, this implementation swap buffers!

Definition at line 392 of file SO3Window.cpp.

void SO3::SWindow::windowClosed

(

Ogre::RenderWindow *

rw

)

Definition at line 240 of file SO3Window.cpp.

void SO3::SWindow::windowFocusChange

(

Ogre::RenderWindow *

rw

)

Definition at line 244 of file SO3Window.cpp.

void SO3::SWindow::windowMoved

(

Ogre::RenderWindow *

rw

)

Definition at line 232 of file SO3Window.cpp.

void SO3::SWindow::WindowMovedOrResized

(

)

Definition at line 264 of file SO3Window.cpp.

void SO3::SWindow::windowResized

(

Ogre::RenderWindow *

rw

)

Definition at line 236 of file SO3Window.cpp.

---

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

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