SO3Engine/SCOLBasic/SO3Std.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 __SO3STD_H__
#define __SO3STD_H__

// Detect platform & compilator
#include "SO3Prerequisites.h"

#include "../SO3Utils/SO3Point.h"

// Dependencies includes
#include "Ogre.h"
#include <OgreTagpoint.h>
#include "OgreFontManager.h"
#include "OgreTextAreaOverlayElement.h"
#include "OgreWireBoundingBox.h"
#include "OgreArchiveFactory.h"
#include "OgreNewt.h"

// Those defines are Ogre plugins, statically linked (Developper version) or internally builded (Distributable version).
# include <OgreParticleFXPlugin.h>
# include <OgreCgPlugin.h>
# include <OgreOctreePlugin.h>
# include <StereoPlugin.h>

// For dev, link renderer statically too
#ifdef SO3_DEVELOPPER_BUILD
# include "OgreD3D9Plugin.h"
//# include "OgreD3D11Plugin.h"
# include "OgreGLPlugin.h"
#endif

// using strings without "std::"
using std::string;

#ifndef ASSERT
# define ASSERT assert
#endif

#define DELETEARRAY(x)  if(x) {delete []x; x = NULL;}
#define CHECKALLOC(x)   if(!x) {return false;}
#define EXPAND(x)       x, sizeof(x)/sizeof(TCHAR)
#define AROUNDINT(x)    ((((x)-floor(x)) < (ceil(x)-(x))) ? ((int)floor(x)) : ((int)ceil(x)))
#define SCOL_TYPTYPE(x) (int (__cdecl *)(struct Mmachine *))ITOM(x)
#define SO3_MAX_PATH    MAX_PATH

// Special resource group for internal use only.
#define SO3_INTERNAL_RESOURCE_GROUP "SO3/Internal"                                                      //!< SO3 Internal base resource group (Warning : not in Ogre global resources pool)
#define SO3_INTERNAL_DYNAMIC_RESOURCE_GROUP SO3_INTERNAL_RESOURCE_GROUP##"/DynResource"                 //!< SO3 Internal resource group for dynamic material and textures (Warning : not in Ogre global resources pool)
#define SO3_INTERNAL_DYNAMIC_READABLE_RESOURCE_GROUP SO3_INTERNAL_DYNAMIC_RESOURCE_GROUP##"/GlobalPool" //!< SO3 Internal resource group for dynamic material and textures that can be accessed in other resource group (Warning : is in Ogre global resources pool)
#define SO3_INTERNAL_HYDRAX_RESOURCE_GROUP "Hydrax"                                                     //!< Hydrax resources must be in Hydrax group
#define SO3_INTERNAL_SKYX_RESOURCE_GROUP "SkyX"                                                         //!< Skyx resources must be in SkyX group

// Renderer
# define SO3_FLASH_FILE      0
# define SO3_FLASH_URL       1

// Rotation Matrix Type
# define SO3_MATRIX_XYZ           0
# define SO3_MATRIX_XZY                 1
# define SO3_MATRIX_YXZ           2
# define SO3_MATRIX_YZX                 3
# define SO3_MATRIX_ZXY           4
# define SO3_MATRIX_ZYX                 5

// Physic Solver Mode Type
# define SO3_SM_EXACT                0
# define SO3_SM_ADAPTATIVE                           1

// Physic Friction Mode Type
# define SO3_FM_EXACT                0
# define SO3_FM_ADAPTATIVE                           1

// Physic Platform Mode Type
# define SO3_PA_DEFAULT          0
# define SO3_PA_MEDIUM                       1
# define SO3_PA_BEST                           2

// Fog mode
# define SO3_FOG_NONE             0
# define SO3_FOG_EXP                            1
# define SO3_FOG_EXP2             2
# define SO3_FOG_LINEAR           3

// Pass Shadow Technique
# define SO3_SHADOWTYPE_NONE                                                                                0
# define SO3_SHADOWDETAILTYPE_ADDITIVE                                                              1
# define SO3_SHADOWDETAILTYPE_MODULATIVE                                                            2
# define SO3_SHADOWDETAILTYPE_INTEGRATED                                                            4
# define SO3_SHADOWDETAILTYPE_STENCIL                                                               16
# define SO3_SHADOWDETAILTYPE_TEXTURE                                                               32
# define SO3_SHADOWTYPE_STENCIL_MODULATIVE                                                  18
# define SO3_SHADOWTYPE_STENCIL_ADDITIVE                                                            17
# define SO3_SHADOWTYPE_TEXTURE_MODULATIVE                                                  34
# define SO3_SHADOWTYPE_TEXTURE_ADDITIVE                                                            33
# define SO3_SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED             37
# define SO3_SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED           38

// Shadow Texture Camera Setup
# define SO3_DEFAULT_SHADOW_CAMERA                                                              0
# define SO3_FOCUSED_SHADOW_CAMERA                                                              1
# define SO3_PLANE_SHADOW_CAMERA                                                                  2
# define SO3_LISPSM_SHADOW_CAMERA                                                                 3

// Shadow Caster Type
# define SO3_DEPTH_SHADOWMAP_CASTER_FLOAT    (1)

// Resource Type
# define SO3_RESOURCE_MESH                                                                          0
# define SO3_RESOURCE_MATERIAL                                                      1
# define SO3_RESOURCE_TEXTURE                                                   2
# define SO3_RESOURCE_SKELETON                                                3
# define SO3_RESOURCE_GPUPROGRAM                                                          4
# define SO3_RESOURCE_HIGHLEVELGPUPROGRAM                               5
# define SO3_RESOURCE_COMPOSITOR                                                          6
# define SO3_RESOURCE_PARTICLE_SYSTEM                                           7

// Booleen Type
# define SO3_FALSE                                                                        0
# define SO3_TRUE                                                           1

// Billboard Particle Type
# define SO3_PARTICLE_BB_POINT                                             (1)
# define SO3_PARTICLE_BB_SELFORIENTED                    (1<<2)
# define SO3_PARTICLE_BB_COMMONORIENTED          (1<<3)

// Emitter Type
# define SO3_EMITTER_BOX                                       (1)
# define SO3_EMITTER_CYLINDER                      (1<<2)
# define SO3_EMITTER_ELLIPSOID                     (1<<3)
# define SO3_EMITTER_HOLLOWELLIPSOID   (1<<4)
# define SO3_EMITTER_POINT                           (1<<5)
# define SO3_EMITTER_RING                            (1<<6)

// Object Flag
#define SO3_OBJECT_MOUSE_ENABLE                                               (1)
#define SO3_OBJECT_MOUSE_FOREGROUND                                     (1<<2)

// Polygon Mode
#define SO3_POLY_POINTS                               (1)
#define SO3_POLY_SOLID                          (1<<2)
#define SO3_POLY_WIREFRAME                  (1<<3)

// Camera Projection Type
#define SO3_PROJECTION_PERSPECTIVE   (1)
#define SO3_PROJECTION_ORTHOGRAPHIC  (1<<2)

// CallBack Physic Material Type 
#define SO3_MATERIALPAIR_COLLISION                                    0
#define SO3_MATERIALPAIR_OVERLAP_STARTED        1
#define SO3_MATERIALPAIR_OVERLAP_ENDED          2
#define SO3_MATERIALPAIR_BUOYANCY_COLLISION     3

// CallBack Body Type 
#define SO3_BODY_LEAVE_WORLD                    0

// Widget event indexes declaration
#define SO3_WIDGET_SCRIPT_EVENT               0
#define SO3_WIDGET_IS_INSIDE_EVENT                            1
#define SO3_WIDGET_ENTER_EVENT                      2
#define SO3_WIDGET_EXIT_EVENT                         3
#define SO3_WIDGET_MOUSE_DOWN_EVENT               4
#define SO3_WIDGET_MOUSE_UP_EVENT                         5
#define SO3_WIDGET_MOUSEWHEEL_EVENT                           6
// Anim type
#define SO3_ANIM_END                                                        0

// Scene type
#define SO3_SCENE_PRE_RENDER_EVENT              0
#define SO3_SCENE_POST_RENDER_EVENT       1

// Buffer type
#define SO3_BUFFER_PRE_RENDER_EVENT             0
#define SO3_BUFFER_POST_RENDER_EVENT    1

// Log Type
#define SO3_LL_LOW      1
#define SO3_LL_NORMAL     2
#define SO3_LL_BOREME     3

#define SO3_LOGS_CB                                               0

// Multi sampling OpenGL Type
#define WGL_SAMPLE_BUFFERS_ARB           0x2041
#define WGL_SAMPLES_ARB                      0x2042

/*#ifdef _DEBUG
# define DEBUG_NEW new(_NORMAL_BLOCK, __FILE__, __LINE__)
# define new DEBUG_NEW
#endif*/

#endif

---