2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2008-2010 Ricardo Quesada
|
|
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
|
|
Copyright (c) 2011 Zynga Inc.
|
|
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
2023-12-08 00:13:39 +08:00
|
|
|
Copyright (c) 2019-present Axmol Engine contributors (see AUTHORS.md).
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-10-01 16:24:52 +08:00
|
|
|
https://axmolengine.github.io/
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifndef __CCSCENE_H__
|
|
|
|
#define __CCSCENE_H__
|
|
|
|
|
|
|
|
#include <string>
|
2023-06-11 13:08:08 +08:00
|
|
|
#include "2d/Node.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
class Camera;
|
|
|
|
class BaseLight;
|
|
|
|
class Renderer;
|
|
|
|
class EventListenerCustom;
|
|
|
|
class EventCustom;
|
2024-03-30 08:56:32 +08:00
|
|
|
#if defined(AX_ENABLE_PHYSICS)
|
2019-11-23 20:27:39 +08:00
|
|
|
class PhysicsWorld;
|
|
|
|
#endif
|
2024-03-30 08:56:32 +08:00
|
|
|
#if defined(AX_ENABLE_3D_PHYSICS) && AX_ENABLE_BULLET_INTEGRATION
|
2019-11-23 20:27:39 +08:00
|
|
|
class Physics3DWorld;
|
|
|
|
#endif
|
2024-03-30 08:56:32 +08:00
|
|
|
#if defined(AX_ENABLE_NAVMESH)
|
2019-11-23 20:27:39 +08:00
|
|
|
class NavMesh;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup _2d
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** @class Scene
|
|
|
|
* @brief Scene is a subclass of Node that is used only as an abstract concept.
|
|
|
|
|
|
|
|
Scene and Node are almost identical with the difference that Scene has its
|
|
|
|
anchor point (by default) at the center of the screen.
|
|
|
|
|
|
|
|
For the moment Scene has no other logic than that, but in future releases it might have
|
|
|
|
additional logic.
|
|
|
|
|
|
|
|
It is a good practice to use a Scene as the parent of all your nodes.
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
Scene will create a default camera for you.
|
|
|
|
*/
|
2022-07-16 10:43:05 +08:00
|
|
|
class AX_DLL Scene : public Node
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
2021-12-25 10:04:45 +08:00
|
|
|
/** Creates a new Scene object.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @return An autoreleased Scene object.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
static Scene* create();
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
/** Creates a new Scene object with a predefined size.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @param size The predefined size of scene.
|
|
|
|
* @return An autoreleased Scene object.
|
|
|
|
* @js NA
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
static Scene* createWithSize(const Vec2& size);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
using Node::addChild;
|
|
|
|
virtual std::string getDescription() const override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Get all cameras.
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @return The vector of all cameras, ordered by camera depth.
|
|
|
|
* @js NA
|
|
|
|
*/
|
|
|
|
const std::vector<Camera*>& getCameras();
|
|
|
|
|
|
|
|
/** Get the default camera.
|
|
|
|
* @js NA
|
|
|
|
* @return The default camera of scene.
|
|
|
|
*/
|
|
|
|
Camera* getDefaultCamera() const { return _defaultCamera; }
|
|
|
|
|
|
|
|
/** Get lights.
|
|
|
|
* @return The vector of lights.
|
|
|
|
* @js NA
|
|
|
|
*/
|
|
|
|
const std::vector<BaseLight*>& getLights() const { return _lights; }
|
|
|
|
|
|
|
|
/** Render the scene.
|
|
|
|
* @param renderer The renderer use to render the scene.
|
|
|
|
* @param eyeTransform The AdditionalTransform of camera.
|
|
|
|
* @param eyeProjection The projection matrix of camera.
|
|
|
|
* @js NA
|
|
|
|
*/
|
|
|
|
virtual void render(Renderer* renderer, const Mat4& eyeTransform, const Mat4* eyeProjection = nullptr);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2024-02-13 13:14:59 +08:00
|
|
|
void visit(Renderer* renderer, const Mat4& parentTransform, uint32_t parentFlags) override;
|
|
|
|
void visit() override;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** override function */
|
|
|
|
virtual void removeAllChildren() override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2022-03-18 21:46:07 +08:00
|
|
|
Scene();
|
2019-11-23 20:27:39 +08:00
|
|
|
virtual ~Scene();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
bool init() override;
|
2021-10-23 23:27:14 +08:00
|
|
|
bool initWithSize(const Vec2& size);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
void setCameraOrderDirty() { _cameraOrderDirty = true; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
void onProjectionChanged(EventCustom* event);
|
|
|
|
|
2021-06-24 17:04:04 +08:00
|
|
|
private:
|
|
|
|
void initDefaultCamera();
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
protected:
|
|
|
|
friend class Node;
|
|
|
|
friend class ProtectedNode;
|
|
|
|
friend class SpriteBatchNode;
|
|
|
|
friend class Camera;
|
|
|
|
friend class BaseLight;
|
|
|
|
friend class Renderer;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
|
|
|
std::vector<Camera*> _cameras; // weak ref to Camera
|
2022-07-01 12:17:08 +08:00
|
|
|
|
|
|
|
/* weak ref, default camera created by scene, at _cameras[0], Caution! the default camera can not be added to _cameras
|
|
|
|
before onEnter is called. */
|
|
|
|
Camera* _defaultCamera = nullptr;
|
|
|
|
/* indicates if the order is dirty and if so then it needs sorting */
|
|
|
|
bool _cameraOrderDirty = true;
|
2021-12-25 10:04:45 +08:00
|
|
|
EventListenerCustom* _event;
|
|
|
|
|
|
|
|
std::vector<BaseLight*> _lights;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
private:
|
2022-07-16 10:43:05 +08:00
|
|
|
AX_DISALLOW_COPY_AND_ASSIGN(Scene);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2024-03-30 08:56:32 +08:00
|
|
|
#if (AX_ENABLE_PHYSICS || (defined(AX_ENABLE_3D_PHYSICS) && AX_ENABLE_BULLET_INTEGRATION))
|
2019-11-23 20:27:39 +08:00
|
|
|
public:
|
2024-03-30 08:56:32 +08:00
|
|
|
# if defined(AX_ENABLE_PHYSICS)
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Get the physics world of the scene.
|
|
|
|
* @return The physics world of the scene.
|
|
|
|
* @js NA
|
|
|
|
*/
|
|
|
|
PhysicsWorld* getPhysicsWorld() const { return _physicsWorld; }
|
2021-12-25 10:04:45 +08:00
|
|
|
# endif
|
|
|
|
|
2024-03-30 08:56:32 +08:00
|
|
|
# if defined(AX_ENABLE_3D_PHYSICS) && AX_ENABLE_BULLET_INTEGRATION
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Get the 3d physics world of the scene.
|
|
|
|
* @return The 3d physics world of the scene.
|
|
|
|
* @js NA
|
|
|
|
*/
|
|
|
|
Physics3DWorld* getPhysics3DWorld() { return _physics3DWorld; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
|
|
|
/**
|
2019-11-23 20:27:39 +08:00
|
|
|
* Set Physics3D debug draw camera.
|
|
|
|
*/
|
|
|
|
void setPhysics3DDebugCamera(Camera* camera);
|
2021-12-25 10:04:45 +08:00
|
|
|
# endif
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Create a scene with physics.
|
|
|
|
* @return An autoreleased Scene object with physics.
|
|
|
|
* @js NA
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
static Scene* createWithPhysics();
|
|
|
|
|
2022-03-18 21:46:07 +08:00
|
|
|
bool initWithPhysics();
|
2021-06-24 17:04:04 +08:00
|
|
|
bool initPhysicsWorld();
|
2024-01-13 01:08:01 +08:00
|
|
|
virtual void fixedUpdate(float delta) {}
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
protected:
|
|
|
|
void addChildToPhysicsWorld(Node* child);
|
|
|
|
|
2024-03-30 08:56:32 +08:00
|
|
|
# if defined(AX_ENABLE_PHYSICS)
|
2019-11-23 20:27:39 +08:00
|
|
|
PhysicsWorld* _physicsWorld = nullptr;
|
2021-12-25 10:04:45 +08:00
|
|
|
# endif
|
|
|
|
|
2024-03-30 08:56:32 +08:00
|
|
|
# if defined(AX_ENABLE_3D_PHYSICS) && AX_ENABLE_BULLET_INTEGRATION
|
2021-12-25 10:04:45 +08:00
|
|
|
Physics3DWorld* _physics3DWorld = nullptr;
|
|
|
|
Camera* _physics3dDebugCamera = nullptr;
|
|
|
|
# endif
|
2024-03-30 08:56:32 +08:00
|
|
|
#endif // (defined(AX_ENABLE_PHYSICS) || defined(AX_ENABLE_3D_PHYSICS))
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2024-03-30 08:56:32 +08:00
|
|
|
#if defined(AX_ENABLE_NAVMESH)
|
2019-11-23 20:27:39 +08:00
|
|
|
public:
|
|
|
|
/** set navigation mesh */
|
|
|
|
void setNavMesh(NavMesh* navMesh);
|
|
|
|
/** get navigation mesh */
|
|
|
|
NavMesh* getNavMesh() const { return _navMesh; }
|
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* Set NavMesh debug draw camera.
|
|
|
|
*/
|
|
|
|
void setNavMeshDebugCamera(Camera* camera);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
protected:
|
2021-12-25 10:04:45 +08:00
|
|
|
NavMesh* _navMesh = nullptr;
|
|
|
|
Camera* _navMeshDebugCamera = nullptr;
|
2019-11-23 20:27:39 +08:00
|
|
|
#endif
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2024-03-30 08:56:32 +08:00
|
|
|
#if (defined(AX_ENABLE_PHYSICS) || (defined(AX_ENABLE_3D_PHYSICS) && AX_ENABLE_BULLET_INTEGRATION) || defined(AX_ENABLE_NAVMESH))
|
2019-11-23 20:27:39 +08:00
|
|
|
public:
|
|
|
|
void stepPhysicsAndNavigation(float deltaTime);
|
|
|
|
#endif
|
|
|
|
};
|
|
|
|
|
|
|
|
// end of _2d group
|
|
|
|
/// @}
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_END
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
#endif // __CCSCENE_H__
|