SO3Prerequisites.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) 2012 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
 
-----------------------------------------------------------------------------
*/
 
#ifndef __SO3_PREREQUISITES_H__
#define __SO3_PREREQUISITES_H__
 
#ifdef ANDROID
  #define _WIN32 0
  #undef _WIN32
#endif
 
// Optionnal Functionality activation / deactivation
#ifdef SO3_PLUGIN_WEBNAVIGATOR_NON_CLIENT_BUILD
  #define SO3_WEB_NAVIGATOR_BUILD 1   // Set to 0 in case you won't have compiled Cef on your machine. You'll have to remove "libcef.lib" and "libinclude/cef_dll_wrapper.lib" from link project properties.
#else
  #define SO3_WEB_NAVIGATOR_BUILD 0
#endif
 
#include <scolPlugin.h>
 
// Detect platform & compilator
#include "SO3Platform.h"
#include "SO3Std.h"
 
// includes
#include <assert.h>
#include <string>
#include <math.h>
#include <stdio.h>
#include <vector>
#include <map>
#include <queue>
#include <unordered_map>
 
// Ogre includes
#include "Ogre.h"
#include <OgreTagPoint.h>
#include <OgreOverlay.h>
#include <OgreOverlayManager.h>
#include <OgreOverlayElement.h>
#include <OgreOverlayContainer.h>
#include <OgreTextAreaOverlayElement.h>
#include <OgreWireBoundingBox.h>
#include <OgreArchiveFactory.h>
 
// Those defines are Ogre plugins, statically linked (Developper version) or internally builded (Distributable version).
#include <OgreParticleFXPlugin.h>
#include <OgreOctreePlugin.h>           
 
#if !defined(ANDROID) && !defined(APPLE_IOS) && !defined(SO3_USE_METAL) && !defined(RPI)
  #include "OgreCgPlugin.h"
#endif
 
#ifdef SO3_FLASH_ENABLE
  // External libs
  #include <External/hikari/Hikari.h>
#endif
 
// For dev, link renderer statically too
#ifdef SO3_DEVELOPPER_BUILD
  #ifdef _WIN32
    # ifndef SO3_USE_DX11
      # include "OgreD3D9Plugin.h"
    # else
      # include "OgreD3D11Plugin.h"
    # endif
  #endif
 
# ifndef SO3_USE_OPENGLES2
#   ifdef SO3_USE_GL3
#     include "OgreGL3PlusPlugin.h"
#   elif !defined(SO3_USE_METAL)
#     include "OgreGLPlugin.h"
#   endif
# elif !defined(SO3_USE_METAL)
#     include "OgreGLES2Plugin.h"
# endif
 
#if defined(__APPLE__) && defined(SO3_USE_METAL)
  # include "OgreMetalPlugin.h"
#endif
 
#if defined(_WIN64)
  //# include "OgreTinyPlugin.h"
 
  # include "OgreVulkanPlugin.h"
  # include "OgreGLSLangProgramManager.h"
#endif
 
#endif
 
#include <unordered_map>
#include <unordered_set>
 
// Set to 1 to activate Ogre's frame profiler.
#define SO3_PROFILER 0
 
// using strings without "std::"
using std::string;
 
// Constant defines
#define CONST_COLOR        255.0f
#define CONST_COLOR_ALPHA        127.0f
#define SO3_PI             3.14159265358979323846f
#define SO3_SAFE_DELETE(p) {if(p){delete(p);(p)=NULL;}}
#define SO3_SAFE_DELETE_ARRAY(p) {if(p){delete[](p);(p)=NULL;}}
#define SO3_MAX_PATH       MAX_PATH
 
// Special resource group for internal use only.
#define SO3_INTERNAL_RESOURCE_GROUP "SO3/Internal"                                                                   
#define SO3_INTERNAL_DYNAMIC_RESOURCE_GROUP  "SO3/Internal/DynResource"                                              
#define SO3_INTERNAL_DYNAMIC_READABLE_RESOURCE_GROUP "SO3/Internal/GlobalPool"                                       
#define SO3_INTERNAL_HYDRAX_RESOURCE_GROUP "Hydrax"                                                                  
#define SO3_INTERNAL_SKYX_RESOURCE_GROUP "SkyX"                                                                      
#define SO3_INTERNAL_SUBENTITY_SELECTOR_RESOURCE_GROUP "SO3/Internal/EntitySelector"                                 
 
#ifdef SO3_BUILD_DEFERRED
#define SO3_INTERNAL_DEFERRED_RESOURCE_GROUP "SO3/Internal/DeferredSystem"                                           
#endif
 
// Keywords/values of usm.ini file
#define SO3_CONFIG_RENDERER_KEYWORD        "SO3Renderer"
#define SO3_CONFIG_RENDERER_OPENGL         "OpenGL"
#define SO3_CONFIG_RENDERER_DIRECTX        "DirectX"
#define SO3_CONFIG_RENDERER_DIRECTX9       "DirectX9"
#define SO3_CONFIG_RENDERER_DIRECTX11      "DirectX11"
#define SO3_CONFIG_RENDERER_VULKAN         "Vulkan"
#define SO3_CONFIG_RENDERER_TINY           "Tiny"
#define SO3_CONFIG_RENDERER_METAL          "Metal"
#define SO3_CONFIG_FSAA_KEYWORD            "3DFSAA"
#define SO3_CONFIG_QUAD_BUFFER_KEYWORD     "QuadBuffer"
#define SO3_CONFIG_FOCAL_LENGTH_KEYWORD    "FocalLength"
#define SO3_CONFIG_EYES_SEPARATION_KEYWORD "EyeSeparation"
#define SO3_CONFIG_VSYNC_KEYWORD           "VSYNC"
 
// All so3 classes goes in this namespace.
namespace SO3
{
 
// class pre-declarations
class SAnim;
class SAnimationFrameListener;
class SAnimTrack;
class SAstronomy;
class SBitmapWidgetFactory;
class SBody;
class SBone;
class SColourGradient;
class SCamera;
class SCompositor;
class SCompositorPass;
class SCompositorTarget;
class SCompositorTechnique;
class SCompositorMaterialListener;
class SContactCallback;
class SDateTime;
 
#ifdef SO3_BUILD_DEFERRED
class SDeferredShading;
#endif
 
class SDynamicCubeMap;
class SDynamicReflectionMap;
class SData;
class SEntity;
class SEnvironment;
class SEnvironmentComponent;
class SException;
 
#ifdef SO3_FLASH_ENABLE
class SFlashControl;
class SFlashWidget;
class SFlashWidgetFactory;
#endif
 
class SKeyboardHook;
class SLogListener;
class SLight;
class SLightingManager;
class SLineEntity;
class SMaterial;
class SMaterialID;
class SMaterialPair;
class SMoon;
class SNode;
class SNodeAnimation;
class SObjWindowWidget;
class SObjWindowWidgetFactory;
class SO3ScolFileSystemArchiveFactory;
class SParticleSystem;
class SPass;
class SPhysicWorld;
class SPhysicContraint;
class SPlugin;
class SPluginManager;
template <typename NUMERIC_TYPE> class SPoint;
class SRaycastResult;
class SRenderToTexture;
class SResource;
class SResourceLoader;
class SRoot;
class SScene;
class STerrain;
class SScriptFunction;
class SSequenceAnimation;
class SSequenceAnimationTrack;
class SSequenceAnimationKey;
class SShadow;
class SShadowManager;
class SShape;
class SShapeBox;
class SSkeleton;
class SSkeletonFap;
class SSky;
class SSkyAstronomicalModel;
class SSkyLight;
class SSubEntitySelectorBuffer;
class SSubEntitySelectorMaterialSwitcher;
class SSun;
class STechnique;
class STexture;
class SUniversalClock;
class SViewPort;
class SVertexAnimation;
class SWater;
class SWebNavigatorWidget;
class SWebNavigatorWidgetFactory;
class SWidget;
class SWidgetFactory;
class SWidgetManager;
class SWindow;
 
// maps pre-declaration
typedef std::unordered_map<std::string, SAnim*> SAnimMap;
typedef std::unordered_map<unsigned short, SAnim*> SAnimIndexMap;
typedef std::vector<SAnimTrack*> SAnimTrackList;
typedef std::unordered_map<std::string, SBone*> SBoneMap;
typedef std::unordered_map<unsigned short,SBone*> SBoneIndexMap;
typedef std::unordered_map<std::string, SCompositor*> SCompositorMap;
typedef std::unordered_map<SEntity*, std::string> SEntityMap;
typedef std::unordered_map<std::string, SMaterial*> SMaterialMap;
typedef std::unordered_map<std::string, SMaterialMap*> SGroupMaterialMap;
typedef std::unordered_map<std::string, SMaterialID*> SMaterialIDMap;
typedef std::unordered_set<SMaterialPair*> SMaterialPairMap;
typedef std::unordered_map<std::string, SNode*> SNodeMap;
typedef std::unordered_map<std::string, STerrain*> STerrainMap;
typedef std::unordered_map<std::string, SScene*> SSceneMap;
typedef std::unordered_map<std::string, STexture*> STextureMap;
typedef std::unordered_map<std::string, STextureMap*> SGroupTextureMap;
typedef std::unordered_map<int, SViewPort*> SViewPortList;
typedef std::unordered_map<std::string, SWindow*> SWindowMap;
typedef std::vector<SSequenceAnimationKey*> SAnimSequenceKeyList;
typedef std::unordered_set<SSequenceAnimationKey*> SAnimSequenceKeyMap;
 
// Small enum for mouse buttons.
enum MouseButtonId
{
  MOUSE_NONE = 0,
  MOUSE_LEFT_BUTTON = 1,
  MOUSE_RIGHT_BUTTON = 2,
  MOUSE_MIDDLE_BUTTON = 16
};
 
}
 
#endif