Project

General

Profile

SO3Engine
Public Member Functions | Protected Member Functions | List of all members
SO3::SViewPort Class Reference

#include <SO3ViewPort.h>

Inheritance diagram for SO3::SViewPort:

Public Member Functions

 SViewPort (SWindow *parent, SCamera *targetCamera, int priority, const float &x, const float &y, const float &w, const float &h)
 
 ~SViewPort ()
 
Ogre::Viewport * GetOgreViewPortPointer ()
 
SWindow * GetParentWindow () const
 
std::string GetMaterialScheme ()
 
void SetMaterialScheme (const std::string &existingScheme)
 
void SetPositionAndSize (const float &x, const float &y, const float &w, const float &h)
 
void ResizeToWindow (const float &w, const float &h)
 
float GetLeft ()
 
float GetTop ()
 
float GetWidth ()
 
float GetHeight ()
 
int GetLeftPixels ()
 
int GetTopPixels ()
 
int GetWidthPixels ()
 
int GetHeightPixels ()
 
int GetPriority ()
 
bool GetShadowsEnabled ()
 
void SetShadowsEnabled (const bool &enableShadows)
 
void SetBackgroundColour (const int &backgroundColor)
 
int GetBackgroundColor ()
 
SCamera * GetCamera ()
 
void SetCamera (SCamera *camera)
 
bool UpdateStereoCompositorState (const Ogre::String compname, bool state)
 
void UpdateStereoCamera (Ogre::Camera *camera)
 
void RestoreStereoCamera ()
 
void UpdateStereoCameraMatrix (Ogre::Camera *camera)
 
void UnregisterStereoViewport ()
 
void RegisterStereoViewport ()
 
bool IsStereoViewportRegistered ()
 
bool GetClearDepth ()
 
void SetClearDepth (const bool &state)
 
bool GetClearColor ()
 
void SetClearColor (const bool &value)
 
void SetSkyEnable (const bool &value)
 
bool GetSkyEnable ()
 
void SetOverlayEnable (const bool &value)
 
bool GetOverlayEnable ()
 
void SetDeferredEnable (const bool &value)
 
bool GetDeferredEnable ()
 
void SetSSAOEnable (const bool &value)
 
bool GetSSAOEnable ()
 
SSsaoHandler * GetSSAOhandler ()
 
void SetHDREnable (const bool &value)
 
bool GetHDREnable ()
 
SHdrHandler * GetHDRhandler ()
 
void SetHDRBlurAmount (const float &value)
 
void SetHDREffectAmount (const float &value)
 
void SetHDRGamma (const float &value)
 
void SetDeferredAntiAliasingMode (const SDeferredShading::DeferredShadingAntiAliasingMode &value)
 
SDeferredShading::DeferredShadingAntiAliasingMode GetDeferredAntiAliasingMode ()
 
void SetDeferredDebugMode (const int &value)
 
int GetDeferredDebugMode ()
 
void SetVisibilityMask (const Ogre::uint32 &mask)
 
Ogre::uint32 GetVisibilityMask ()
 
void SetVisibilityMaskIndexEnable (const Ogre::uint32 flagIndex, const bool enable)
 
bool GetVisibilityMaskIndexEnable (const Ogre::uint32 flagIndex)
 
void Update ()
 
SCompositor * CreateCompositor (const std::string &newCompositorName, const std::string &newSchemeName)
 
void DeleteCompositor (SCompositor *existingCompositor)
 
void DeleteCompositor (const std::string &existingCompositorName)
 
SCompositor * GetCompositor (const std::string &compositorName)
 
const SCompositorMap & GetCompositorList () const
 
void ClearCompositors ()
 
bool GetScreenPosFromWorldPos (Ogre::Vector3 worldPosition, Ogre::Vector2 &screenPos)
 
SRaycastResult RayCast (const int &pixelsX, const int &pixelsY, SSubEntitySelectorBuffer *subEntitySelector)
 
SRaycastResult RayCast (const int &pixelsX, const int &pixelsY)
 
Ogre::Vector3 RayCastCamera (const int &pixelsX, const int &pixelsY, const float distance, Ogre::Vector3 &outDirection)
 
unsigned int GetNumRenderedFaces ()
 
unsigned int GetNumRenderedBatches ()
 
void ToPixelPos (int &px, int &py)
 
void ToPixelPos (float &px, float &py)
 
void ToWindowPos (int &px, int &py)
 
void ToWindowPos (float &px, float &py)
 

Protected Member Functions

void AddCompositor (SCompositor *existingCompositor)
 
void RemoveCompositor (SCompositor *existingCompositor)
 
void RemoveCompositor (const std::string &compositorName)
 
virtual void viewportDimensionsChanged (Ogre::Viewport *viewport)
 
virtual Ogre::Technique * handleSchemeNotFound (unsigned short schemeIndex, const Ogre::String &schemeName, Ogre::Material *originalMaterial, unsigned short lodIndex, const Ogre::Renderable *rend)
 

Detailed Description

Definition at line 55 of file SO3ViewPort.h.

Constructor & Destructor Documentation

◆ SViewPort()

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

Constructor.

Definition at line 27 of file SO3ViewPort.cpp.

◆ ~SViewPort()

SViewPort::~SViewPort ( )

Destructor.

Definition at line 76 of file SO3ViewPort.cpp.

Member Function Documentation

◆ AddCompositor()

void SViewPort::AddCompositor ( SCompositor *  existingCompositor)
protected

Add a SCompositor object to the list of available compositors.

Definition at line 669 of file SO3ViewPort.cpp.

◆ ClearCompositors()

void SViewPort::ClearCompositors ( )

Erase all the handled compositors.

Definition at line 655 of file SO3ViewPort.cpp.

◆ CreateCompositor()

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

Create a new SCompositor Object

Definition at line 633 of file SO3ViewPort.cpp.

◆ DeleteCompositor() [1/2]

void SViewPort::DeleteCompositor ( const std::string &  existingCompositorName)

Definition at line 644 of file SO3ViewPort.cpp.

◆ DeleteCompositor() [2/2]

void SViewPort::DeleteCompositor ( SCompositor *  existingCompositor)

Delete an existing SCompositor Object

Definition at line 649 of file SO3ViewPort.cpp.

◆ GetBackgroundColor()

int SViewPort::GetBackgroundColor ( )

Definition at line 215 of file SO3ViewPort.cpp.

◆ GetCamera()

SCamera * SViewPort::GetCamera ( )

Definition at line 220 of file SO3ViewPort.cpp.

◆ GetClearColor()

bool SViewPort::GetClearColor ( )

Definition at line 361 of file SO3ViewPort.cpp.

◆ GetClearDepth()

bool SViewPort::GetClearDepth ( )

Definition at line 334 of file SO3ViewPort.cpp.

◆ GetCompositor()

SCompositor * SViewPort::GetCompositor ( const std::string &  compositorName)

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

Definition at line 619 of file SO3ViewPort.cpp.

◆ GetCompositorList()

const SCompositorMap & SViewPort::GetCompositorList ( ) const

Get a list of the available compositors.

Definition at line 628 of file SO3ViewPort.cpp.

◆ GetDeferredAntiAliasingMode()

SDeferredShading::DeferredShadingAntiAliasingMode SViewPort::GetDeferredAntiAliasingMode ( )

Definition at line 464 of file SO3ViewPort.cpp.

◆ GetDeferredDebugMode()

int SViewPort::GetDeferredDebugMode ( )

Definition at line 484 of file SO3ViewPort.cpp.

◆ GetDeferredEnable()

bool SViewPort::GetDeferredEnable ( )

Definition at line 443 of file SO3ViewPort.cpp.

◆ GetHDREnable()

bool SViewPort::GetHDREnable ( )

Definition at line 540 of file SO3ViewPort.cpp.

◆ GetHDRhandler()

SHdrHandler * SViewPort::GetHDRhandler ( )

Definition at line 548 of file SO3ViewPort.cpp.

◆ GetHeight()

float SViewPort::GetHeight ( )

Definition at line 168 of file SO3ViewPort.cpp.

◆ GetHeightPixels()

int SViewPort::GetHeightPixels ( )

Definition at line 188 of file SO3ViewPort.cpp.

◆ GetLeft()

float SViewPort::GetLeft ( )

Definition at line 153 of file SO3ViewPort.cpp.

◆ GetLeftPixels()

int SViewPort::GetLeftPixels ( )

Definition at line 173 of file SO3ViewPort.cpp.

◆ GetMaterialScheme()

std::string SViewPort::GetMaterialScheme ( )

Definition at line 108 of file SO3ViewPort.cpp.

◆ GetNumRenderedBatches()

unsigned int SViewPort::GetNumRenderedBatches ( )

Definition at line 1028 of file SO3ViewPort.cpp.

◆ GetNumRenderedFaces()

unsigned int SViewPort::GetNumRenderedFaces ( )

Definition at line 980 of file SO3ViewPort.cpp.

◆ GetOgreViewPortPointer()

Ogre::Viewport * SViewPort::GetOgreViewPortPointer ( )

Definition at line 98 of file SO3ViewPort.cpp.

◆ GetOverlayEnable()

bool SViewPort::GetOverlayEnable ( )

Definition at line 405 of file SO3ViewPort.cpp.

◆ GetParentWindow()

SWindow * SViewPort::GetParentWindow ( ) const

Definition at line 103 of file SO3ViewPort.cpp.

◆ GetPriority()

int SViewPort::GetPriority ( )

Definition at line 193 of file SO3ViewPort.cpp.

◆ GetScreenPosFromWorldPos()

bool SViewPort::GetScreenPosFromWorldPos ( Ogre::Vector3  worldPosition,
Ogre::Vector2 &  screenPos 
)

Get a pixel position from a world position

Definition at line 703 of file SO3ViewPort.cpp.

◆ GetShadowsEnabled()

bool SViewPort::GetShadowsEnabled ( )

Definition at line 198 of file SO3ViewPort.cpp.

◆ GetSkyEnable()

bool SViewPort::GetSkyEnable ( )

Definition at line 394 of file SO3ViewPort.cpp.

◆ GetSSAOEnable()

bool SViewPort::GetSSAOEnable ( )

Definition at line 524 of file SO3ViewPort.cpp.

◆ GetSSAOhandler()

SSsaoHandler * SViewPort::GetSSAOhandler ( )

Definition at line 529 of file SO3ViewPort.cpp.

◆ GetTop()

float SViewPort::GetTop ( )

Definition at line 158 of file SO3ViewPort.cpp.

◆ GetTopPixels()

int SViewPort::GetTopPixels ( )

Definition at line 178 of file SO3ViewPort.cpp.

◆ GetVisibilityMask()

Ogre::uint32 SViewPort::GetVisibilityMask ( )

Definition at line 578 of file SO3ViewPort.cpp.

◆ GetVisibilityMaskIndexEnable()

bool SViewPort::GetVisibilityMaskIndexEnable ( const Ogre::uint32  flagIndex)

Definition at line 597 of file SO3ViewPort.cpp.

◆ GetWidth()

float SViewPort::GetWidth ( )

Definition at line 163 of file SO3ViewPort.cpp.

◆ GetWidthPixels()

int SViewPort::GetWidthPixels ( )

Definition at line 183 of file SO3ViewPort.cpp.

◆ handleSchemeNotFound()

Ogre::Technique * SViewPort::handleSchemeNotFound ( unsigned short  schemeIndex,
const Ogre::String &  schemeName,
Ogre::Material *  originalMaterial,
unsigned short  lodIndex,
const Ogre::Renderable *  rend 
)
protectedvirtual

This scheme handler is used to generate the depth texture.

Definition at line 970 of file SO3ViewPort.cpp.

◆ IsStereoViewportRegistered()

bool SViewPort::IsStereoViewportRegistered ( )

Definition at line 329 of file SO3ViewPort.cpp.

◆ RayCast() [1/2]

SRaycastResult SViewPort::RayCast ( const int &  pixelsX,
const int &  pixelsY 
)
Parameters
pixelXx viewport coordonate in screen pixels
pixelYy viewport coordonate in screen pixels

Definition at line 919 of file SO3ViewPort.cpp.

◆ RayCast() [2/2]

SRaycastResult SViewPort::RayCast ( const int &  pixelsX,
const int &  pixelsY,
SSubEntitySelectorBuffer *  subEntitySelector 
)
Parameters
pixelXx buffer coordonate in screen pixels
pixelYy buffer coordonate in screen pixels

Definition at line 733 of file SO3ViewPort.cpp.

◆ RayCastCamera()

Ogre::Vector3 SViewPort::RayCastCamera ( const int &  pixelsX,
const int &  pixelsY,
const float  distance,
Ogre::Vector3 &  outDirection 
)

Definition at line 928 of file SO3ViewPort.cpp.

◆ RegisterStereoViewport()

void SViewPort::RegisterStereoViewport ( )

Definition at line 324 of file SO3ViewPort.cpp.

◆ RemoveCompositor() [1/2]

void SViewPort::RemoveCompositor ( const std::string &  compositorName)
protected

Remove a SCompositor object from the list of available compositors.

Definition at line 689 of file SO3ViewPort.cpp.

◆ RemoveCompositor() [2/2]

void SViewPort::RemoveCompositor ( SCompositor *  existingCompositor)
protected

Remove a SCompositor object from the list of available compositors.

Definition at line 684 of file SO3ViewPort.cpp.

◆ ResizeToWindow()

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

Definition at line 137 of file SO3ViewPort.cpp.

◆ RestoreStereoCamera()

void SViewPort::RestoreStereoCamera ( )

Definition at line 309 of file SO3ViewPort.cpp.

◆ SetBackgroundColour()

void SViewPort::SetBackgroundColour ( const int &  backgroundColor)

Definition at line 209 of file SO3ViewPort.cpp.

◆ SetCamera()

void SViewPort::SetCamera ( SCamera *  camera)

Definition at line 225 of file SO3ViewPort.cpp.

◆ SetClearColor()

void SViewPort::SetClearColor ( const bool &  value)

Definition at line 366 of file SO3ViewPort.cpp.

◆ SetClearDepth()

void SViewPort::SetClearDepth ( const bool &  state)

Definition at line 339 of file SO3ViewPort.cpp.

◆ SetDeferredAntiAliasingMode()

void SViewPort::SetDeferredAntiAliasingMode ( const SDeferredShading::DeferredShadingAntiAliasingMode &  value)

Definition at line 448 of file SO3ViewPort.cpp.

◆ SetDeferredDebugMode()

void SViewPort::SetDeferredDebugMode ( const int &  value)

Definition at line 469 of file SO3ViewPort.cpp.

◆ SetDeferredEnable()

void SViewPort::SetDeferredEnable ( const bool &  value)

Definition at line 411 of file SO3ViewPort.cpp.

◆ SetHDRBlurAmount()

void SViewPort::SetHDRBlurAmount ( const float &  value)

Definition at line 553 of file SO3ViewPort.cpp.

◆ SetHDREffectAmount()

void SViewPort::SetHDREffectAmount ( const float &  value)

Definition at line 559 of file SO3ViewPort.cpp.

◆ SetHDREnable()

void SViewPort::SetHDREnable ( const bool &  value)

Definition at line 534 of file SO3ViewPort.cpp.

◆ SetHDRGamma()

void SViewPort::SetHDRGamma ( const float &  value)

Definition at line 565 of file SO3ViewPort.cpp.

◆ SetMaterialScheme()

void SViewPort::SetMaterialScheme ( const std::string &  existingScheme)

Definition at line 118 of file SO3ViewPort.cpp.

◆ SetOverlayEnable()

void SViewPort::SetOverlayEnable ( const bool &  value)

Definition at line 399 of file SO3ViewPort.cpp.

◆ SetPositionAndSize()

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

Definition at line 131 of file SO3ViewPort.cpp.

◆ SetShadowsEnabled()

void SViewPort::SetShadowsEnabled ( const bool &  enableShadows)

Definition at line 203 of file SO3ViewPort.cpp.

◆ SetSkyEnable()

void SViewPort::SetSkyEnable ( const bool &  value)

Definition at line 388 of file SO3ViewPort.cpp.

◆ SetSSAOEnable()

void SViewPort::SetSSAOEnable ( const bool &  value)

Definition at line 497 of file SO3ViewPort.cpp.

◆ SetVisibilityMask()

void SViewPort::SetVisibilityMask ( const Ogre::uint32 &  mask)

Definition at line 571 of file SO3ViewPort.cpp.

◆ SetVisibilityMaskIndexEnable()

void SViewPort::SetVisibilityMaskIndexEnable ( const Ogre::uint32  flagIndex,
const bool  enable 
)

Definition at line 583 of file SO3ViewPort.cpp.

◆ ToPixelPos() [1/2]

void SViewPort::ToPixelPos ( float &  px,
float &  py 
)

Definition at line 1093 of file SO3ViewPort.cpp.

◆ ToPixelPos() [2/2]

void SViewPort::ToPixelPos ( int &  px,
int &  py 
)

Convert the given window coordinates into pixel coordinates applicable for this viewport.

Parameters
[in,out]px,pyPosition to be converted. Input: window coordinates, output: viewport coordinates (pixels).

Definition at line 1075 of file SO3ViewPort.cpp.

◆ ToWindowPos() [1/2]

void SViewPort::ToWindowPos ( float &  px,
float &  py 
)

Definition at line 1129 of file SO3ViewPort.cpp.

◆ ToWindowPos() [2/2]

void SViewPort::ToWindowPos ( int &  px,
int &  py 
)

Convert the given viewport pixel coordinates into window coordinates.

Parameters
[in,out]px,pyPosition to be converted. Input: viewport pixel coordinates, output: window coordinates (points on iOS, window pixels on Android).

Definition at line 1111 of file SO3ViewPort.cpp.

◆ UnregisterStereoViewport()

void SViewPort::UnregisterStereoViewport ( )

Definition at line 319 of file SO3ViewPort.cpp.

◆ Update()

void SViewPort::Update ( )

Definition at line 607 of file SO3ViewPort.cpp.

◆ UpdateStereoCamera()

void SViewPort::UpdateStereoCamera ( Ogre::Camera *  camera)

Definition at line 304 of file SO3ViewPort.cpp.

◆ UpdateStereoCameraMatrix()

void SViewPort::UpdateStereoCameraMatrix ( Ogre::Camera *  camera)

Definition at line 314 of file SO3ViewPort.cpp.

◆ UpdateStereoCompositorState()

bool SViewPort::UpdateStereoCompositorState ( const Ogre::String  compname,
bool  state 
)

Definition at line 299 of file SO3ViewPort.cpp.

◆ viewportDimensionsChanged()

void SViewPort::viewportDimensionsChanged ( Ogre::Viewport *  viewport)
protectedvirtual

Definition at line 940 of file SO3ViewPort.cpp.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8