diff options
Diffstat (limited to 'source/gameengine/Ketsji/KX_Scene.h')
| -rw-r--r-- | source/gameengine/Ketsji/KX_Scene.h | 480 |
1 files changed, 480 insertions, 0 deletions
diff --git a/source/gameengine/Ketsji/KX_Scene.h b/source/gameengine/Ketsji/KX_Scene.h new file mode 100644 index 00000000000..818368561e6 --- /dev/null +++ b/source/gameengine/Ketsji/KX_Scene.h @@ -0,0 +1,480 @@ +/** + * $Id$ + * + * ***** BEGIN GPL/BL DUAL LICENSE BLOCK ***** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. The Blender + * Foundation also sells licenses for use in proprietary software under + * the Blender License. See http://www.blender.org/BL/ for information + * about this. + * + * 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 General Public License for more details. + * + * You should have received a copy of the GNU 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. + * + * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. + * All rights reserved. + * + * The Original Code is: all of this file. + * + * Contributor(s): none yet. + * + * ***** END GPL/BL DUAL LICENSE BLOCK ***** + */ +#ifndef __KX_SCENE_H +#define __KX_SCENE_H + + +#include "KX_PhysicsEngineEnums.h" + +#include "MT_CmMatrix4x4.h" + +#include <vector> +#include <set> + +#include "GEN_Map.h" +#include "GEN_HashedPtr.h" +#include "SG_IObject.h" +#include "SCA_IScene.h" +#include "MT_Transform.h" +#include "SND_Scene.h" +#include "RAS_FramingManager.h" +#include "RAS_Rect.h" + +/** + * @section Forward declarations + */ +struct SM_MaterialProps; +struct SM_ShapeProps; + +class CListValue; +class RAS_BucketManager; +class KX_Camera; +class SCA_LogicManager; +class SCA_KeyboardManager; +class SCA_TimeEventManager; +class SCA_MouseManager; +class KX_WorldInfo; +class SND_Scene; +class SND_IAudioDevice; +class NG_NetworkDeviceInterface; +class NG_NetworkScene; +class SG_Node; +class KX_Camera; +class GEN_HashedPtr; +class KX_GameObject; +class SCA_ISystem; +class SCA_IInputDevice; +class RAS_BucketManager; +class RAS_MaterialBucket; +class RAS_IPolyMaterial; +class RAS_IRasterizer; +class RAS_IRenderTools; +class CValue; +class SG_IObject; + +/** + * The KX_Scene holds all data for an independent scene. It relates + * KX_Objects to the specific objects in the modules. + * */ +class KX_Scene : public SCA_IScene +{ + RAS_BucketManager* m_bucketmanager; + CListValue* m_tempObjectList; + + /** + * The list of objects which have been removed during the + * course of one frame. They are actually destroyed in + * LogicEndFrame() via a call to RemoveObject(). + */ + CListValue* m_euthanasyobjects; + + CListValue* m_objectlist; + CListValue* m_parentlist; // all 'root' parents + CListValue* m_lightlist; + + /** + * The set of cameras for this scene + */ + set<class KX_Camera*> m_cameras; + + /** + * Various SCA managers used by the scene + */ + SCA_LogicManager* m_logicmgr; + SCA_KeyboardManager* m_keyboardmgr; + SCA_MouseManager* m_mousemgr; + SCA_TimeEventManager* m_timemgr; + + /** + * physics engine abstraction + */ + + e_PhysicsEngine m_physicsEngine; + class PHY_IPhysicsEnvironment* m_physicsEnvironment; + + /** + * Does this scene clear the z-buffer? + */ + bool m_isclearingZbuffer; + + /** + * The name of the scene + */ + STR_String m_sceneName; + + /** + * stores the worldsettings for a scene + */ + KX_WorldInfo* m_worldinfo; + + /** + * @section Different scenes, linked to ketsji scene + */ + + + /** + * Sound scenes + */ + SND_Scene* m_soundScene; + SND_IAudioDevice* m_adi; + + /** + * Network scene. + */ + NG_NetworkDeviceInterface* m_networkDeviceInterface; + NG_NetworkScene* m_networkScene; + + /** + * A temoprary variable used to parent objects together on + * replication. Don't get confused by the name it is not + * the scene's root node! + */ + SG_Node* m_rootnode; + + /** + * The active camera for the scene + */ + KX_Camera* m_active_camera; + + /** + * The projection and view matrices of this scene + * The projection matrix is computed externally by KX_Engine + * The view mat is stored as a side effect of GetViewMatrix() + * and is totally unnessary. + */ + MT_CmMatrix4x4 m_projectionmat; + MT_CmMatrix4x4 m_viewmat; + + /** Desired canvas width set at design time. */ + unsigned int m_canvasDesignWidth; + /** Desired canvas height set at design time. */ + unsigned int m_canvasDesignHeight; + + /** + * Another temporary variable outstaying its welcome + * used in AddReplicaObject to map game objects to their + * replicas so pointers can be updated. + */ + GEN_Map <GEN_HashedPtr, void*> m_map_gameobject_to_replica; + + /** + * Another temporary variable outstaying its welcome + * used in AddReplicaObject to keep a record of all added + * objects. Logic can only be updated when all objects + * have been updated. This stores a list of the new objects. + */ + std::vector<KX_GameObject*> m_logicHierarchicalGameObjects; + + /** + * Pointer to system variable passed in in constructor + * only used in constructor so we do not need to keep it + * around in this class. + */ + + SCA_ISystem* m_kxsystem; + + /** + * The execution priority of replicated object actuators? + */ + int m_ueberExecutionPriority; + + /** + * Activity 'bubble' settings : + * Suspend (freeze) the entire scene. + */ + bool m_suspend; + + /** + * Radius in Manhattan distance of the box for activity culling. + */ + float m_activity_box_radius; + + /** + * Toggle to enable or disable activity culling. + */ + bool m_activity_culling; + + /** + * The framing settings used by this scene + */ + + RAS_FrameSettings m_frame_settings; + + /** + * This scenes viewport into the game engine + * canvas.Maintained externally, initially [0,0] -> [0,0] + */ + RAS_Rect m_viewport; + +public: + KX_Scene(class SCA_IInputDevice* keyboarddevice, + class SCA_IInputDevice* mousedevice, + class NG_NetworkDeviceInterface* ndi, + class SND_IAudioDevice* adi, + const STR_String& scenename ); + + virtual + ~KX_Scene(); + + RAS_BucketManager* GetBucketManager(); + RAS_MaterialBucket* FindBucket(RAS_IPolyMaterial* polymat); + void RenderBuckets(const MT_Transform& cameratransform, + RAS_IRasterizer* rasty, + RAS_IRenderTools* rendertools); + /** + * Update all transforms according to the scenegraph. + */ + void UpdateParents(double curtime); + SCA_IObject* AddReplicaObject(CValue* gameobj, + CValue* locationobj, + int lifespan=0); + KX_GameObject* AddNodeReplicaObject(SG_IObject* node, + CValue* gameobj); + void RemoveNodeDestructObject(SG_IObject* node, + CValue* gameobj); + void RemoveObject(CValue* gameobj); + void DelayedRemoveObject(CValue* gameobj); + void NewRemoveObject(CValue* gameobj); + void ReplaceMesh(CValue* gameobj, + void* meshobj); + /** + * @section Logic stuff + * Initiate an update of the logic system. + */ + void LogicBeginFrame(double curtime, + double deltatime); + void LogicUpdateFrame(double curtime, + double deltatime); + + void + LogicEndFrame( + ); + + CListValue* + GetObjectList( + ); + + CListValue* + GetRootParentList( + ); + + CListValue* + GetLightList( + ); + + SCA_LogicManager* + GetLogicManager( + ); + + SCA_TimeEventManager* + GetTimeEventManager( + ); + + + /** Find a camera in the scene by pointer. */ + KX_Camera* + FindCamera( + KX_Camera* + ); + + /** Find a scene in the scene by name. */ + KX_Camera* + FindCamera( + STR_String& + ); + + /** Add a camera to this scene. */ + void + AddCamera( + KX_Camera* + ); + + /** Find the currently active camera. */ + KX_Camera* + GetActiveCamera( + ); + + /** + * Set this camera to be the active camera in the scene. If the + * camera is not present in the camera list, it will be added + */ + + void + SetActiveCamera( + class KX_Camera* + ); + + /** Return the viewmatrix as used by the last frame. */ + MT_CmMatrix4x4& + GetViewMatrix( + ); + + /** + * Return the projectionmatrix as used by the last frame. This is + * set by hand :) + */ + MT_CmMatrix4x4& + GetProjectionMatrix( + ); + + /** Sets the projection matrix. */ + void + SetProjectionMatrix( + MT_CmMatrix4x4& pmat + ); + + /** + * Activates new desired canvas width set at design time. + * @param width The new desired width. + */ + void + SetCanvasDesignWidth( + unsigned int width + ); + /** + * Activates new desired canvas height set at design time. + * @param width The new desired height. + */ + void + SetCanvasDesignHeight( + unsigned int height + ); + /** + * Returns the current desired canvas width set at design time. + * @return The desired width. + */ + unsigned int + GetCanvasDesignWidth( + void + ) const; + + /** + * Returns the current desired canvas height set at design time. + * @return The desired height. + */ + unsigned int + GetCanvasDesignHeight( + void + ) const; + + /** + * Set the framing options for this scene + */ + + void + SetFramingType( + RAS_FrameSettings & frame_settings + ); + + /** + * Return a const reference to the framing + * type set by the above call. + * The contents are not guarenteed to be sensible + * if you don't call the above function. + */ + + const + RAS_FrameSettings & + GetFramingType( + ) const; + + /** + * Store the current scene's viewport on the + * game engine canvas. + */ + void SetSceneViewport(const RAS_Rect &viewport); + + /** + * Get the current scene's viewport on the + * game engine canvas. This maintained + * externally in KX_GameEngine + */ + const RAS_Rect& GetSceneViewport() const; + + /** + * @section Accessors to different scenes of this scene + */ + void SetNetworkDeviceInterface(NG_NetworkDeviceInterface* newInterface); + void SetNetworkScene(NG_NetworkScene *newScene); + void SetWorldInfo(class KX_WorldInfo* wi); + KX_WorldInfo* GetWorldInfo(); + void CalculateVisibleMeshes(RAS_IRasterizer* rasty); + void UpdateMeshTransformations(); + KX_Camera* GetpCamera(); + SND_Scene* GetSoundScene(); + NG_NetworkDeviceInterface* GetNetworkDeviceInterface(); + NG_NetworkScene* GetNetworkScene(); + + /** + * Replicate the logic bricks associated to this object. + */ + + void ReplicateLogic(class KX_GameObject* newobj); + static SG_Callbacks m_callbacks; + + const STR_String& GetName(); + + // Suspend the entire scene. + void Suspend(); + + // Resume a suspended scene. + void Resume(); + + // Update the activity box settings for objects in this scene, if needed. + void UpdateObjectActivity(void); + + // Enable/disable activity culling. + void SetActivityCulling(bool b); + + // Set the radius of the activity culling box. + void SetActivityCullingRadius(float f); + bool IsSuspended(); + bool IsClearingZBuffer(); + void EnableZBufferClearing(bool isclearingZbuffer); + + class PHY_IPhysicsEnvironment* GetPhysicsEnvironment() + { + return m_physicsEnvironment; + } + + void SetPhysicsEnvironment(class PHY_IPhysicsEnvironment* physEnv) + { + m_physicsEnvironment = physEnv; + } + + void SetGravity(const MT_Vector3& gravity); +}; + +typedef std::vector<KX_Scene*> KX_SceneList; + +#endif //__KX_SCENE_H + |