SO3Engine/SO3Renderer/SO3ViewPort.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OpenSpace3D
For the latest info, see http://www.openspace3d.com

Copyright (c) 2010 I-maginer

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt

You may alternatively use this source under the terms of a specific version of
the OpenSpace3D Unrestricted License provided you have obtained such a license from
I-maginer.
-----------------------------------------------------------------------------
*/

#ifndef __SO3VIEWPORT_H__
#define __SO3VIEWPORT_H__

#include "../SCOLBasic/SO3Std.h"
#include "StereoManager.h"

namespace SO3
{

class SViewPort 
{
public:
        SWindow* currentWindow;
        int channel;
protected:
private:
  bool bClearDepth; //$BB
  bool bClearColor; //$BB
  SWindow* scolWindow;
  SCamera* scolCamera;
        Ogre::Viewport* O3ViewPort;
        SCompositorMap compList;

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

  ~SViewPort();

  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 SetSkyEnable(bool value);

  bool GetSkyEnable();

  void SetOverlayEnable(bool value);

  bool GetOverlayEnable();

  void SetVisibilityMask(Ogre::uint32 mask);

  Ogre::uint32 GetVisibilityMask();

  void Update();

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

  void DeleteCompositor(SCompositor* existingCompositor);

  void DeleteCompositor(std::string existingCompositorName);

  SCompositor* GetCompositor(std::string compositorName);

  const SCompositorMap& GetCompositorList() const;

  void ClearCompositors();

  SRaycastResult RayCast(int pixelsX, int pixelsY, SSubEntitySelectorBuffer* subEntitySelector);

  SRaycastResult RayCast(int pixelsX, int pixelsY);
protected:
  void AddCompositor(SCompositor* existingCompositor);

  void RemoveCompositor(SCompositor* existingCompositor);

  void RemoveCompositor(std::string compositorName);
private:
  SViewPort();
};

}

#endif

---