anki-3d-engine/AnKi/Scene/SceneGraph.h

// Copyright (C) 2009-present, Panagiotis Christopoulos Charitos and contributors.
// All rights reserved.
// Code licensed under the BSD License.
// http://www.anki3d.org/LICENSE

#pragma once

#include <AnKi/Scene/Common.h>
#include <AnKi/Scene/SceneNode.h>
#include <AnKi/Math.h>
#include <AnKi/Util/HashMap.h>
#include <AnKi/Util/BlockArray.h>
#include <AnKi/Scene/Events/EventManager.h>
#include <AnKi/Resource/Common.h>
#include <AnKi/Util/CVarSet.h>
#include <AnKi/Core/Common.h>

namespace anki {

ANKI_CVAR(NumericCVar<F32>, Scene, ProbeEffectiveDistance, 256.0f, 1.0f, kMaxF32, "How far various probes can render")
ANKI_CVAR(NumericCVar<F32>, Scene, ProbeShadowEffectiveDistance, 32.0f, 1.0f, kMaxF32, "How far to render shadows for the various probes")

// Gpu scene arrays
ANKI_CVAR(NumericCVar<U32>, Scene, MinGpuSceneTransforms, 2 * 10 * 1024, 8, 100 * 1024, "The min number of transforms stored in the GPU scene")
ANKI_CVAR(NumericCVar<U32>, Scene, MinGpuSceneMeshes, 8 * 1024, 8, 100 * 1024, "The min number of meshes stored in the GPU scene")
ANKI_CVAR(NumericCVar<U32>, Scene, MinGpuSceneParticleEmitters, 1 * 1024, 8, 100 * 1024,
		  "The min number of particle emitters stored in the GPU scene")
ANKI_CVAR(NumericCVar<U32>, Scene, MinGpuSceneLights, 2 * 1024, 8, 100 * 1024, "The min number of lights stored in the GPU scene")
ANKI_CVAR(NumericCVar<U32>, Scene, MinGpuSceneReflectionProbes, 128, 8, 100 * 1024, "The min number of reflection probes stored in the GPU scene")
ANKI_CVAR(NumericCVar<U32>, Scene, MinGpuSceneGlobalIlluminationProbes, 128, 8, 100 * 1024, "The min number of GI probes stored in the GPU scene")
ANKI_CVAR(NumericCVar<U32>, Scene, MinGpuSceneDecals, 2 * 1024, 8, 100 * 1024, "The min number of decals stored in the GPU scene")
ANKI_CVAR(NumericCVar<U32>, Scene, MinGpuSceneFogDensityVolumes, 512, 8, 100 * 1024, "The min number fog density volumes stored in the GPU scene")
ANKI_CVAR(NumericCVar<U32>, Scene, MinGpuSceneRenderables, 10 * 1024, 8, 100 * 1024, "The min number of renderables stored in the GPU scene")

class SceneComponentArrays
{
public:
#define ANKI_DEFINE_SCENE_COMPONENT(name, weight, sceneNodeCanHaveMany, icon, serializable) \
	SceneBlockArray<name##Component>& get##name##s() \
	{ \
		return m_##name##Array; \
	} \
	const SceneBlockArray<name##Component>& get##name##s() const \
	{ \
		return m_##name##Array; \
	}
#include <AnKi/Scene/Components/SceneComponentClasses.def.h>

private:
#define ANKI_DEFINE_SCENE_COMPONENT(name, weight, sceneNodeCanHaveMany, icon, serializable) SceneBlockArray<name##Component> m_##name##Array;
#include <AnKi/Scene/Components/SceneComponentClasses.def.h>
};

// The scene graph that  all the scene entities
class SceneGraph : public MakeSingleton<SceneGraph>
{
	template<typename>
	friend class MakeSingleton;

	friend class SceneNode;
	friend class UpdateSceneNodesTask;
	friend class Event;

public:
	Error init(AllocAlignedCallback allocCallback, void* allocCallbackData);

	StackMemoryPool& getFrameMemoryPool() const
	{
		return m_framePool;
	}

	SceneNode& getActiveCameraNode()
	{
		const SceneNode& cam = static_cast<const SceneGraph*>(this)->getActiveCameraNode();
		return const_cast<SceneNode&>(cam);
	}

	const SceneNode& getActiveCameraNode() const;

	void setActiveCameraNode(SceneNode* cam);

	SceneNode& getEditorUiNode()
	{
		ANKI_ASSERT(m_editorUi);
		return *m_editorUi;
	}

	U32 getSceneNodesCount() const
	{
		return m_nodesCount;
	}

	EventManager& getEventManager()
	{
		return m_events;
	}
	const EventManager& getEventManager() const
	{
		return m_events;
	}

	void update(Second prevUpdateTime, Second crntTime);

	// Note: Thread-safe against itself. Can be called by SceneNode::update
	SceneNode* tryFindSceneNode(const CString& name);

	// Note: Thread-safe against itself. Can be called by SceneNode::update
	SceneNode& findSceneNode(const CString& name);

	// Iterate the scene nodes using a lambda
	template<typename Func>
	void visitNodes(Func func)
	{
		for(SceneNode& psn : m_nodes)
		{
			if(func(psn) == FunctorContinue::kStop)
			{
				break;
			}
		}
	}

	// Create a new SceneNode
	// Note: Thread-safe against itself. Can be called by SceneNode::update
	template<typename TNode>
	TNode* newSceneNode(CString name)
	{
		TNode* node = newInstance<TNode>(SceneMemoryPool::getSingleton(), name);
		LockGuard lock(m_nodesForRegistrationMtx);
		m_nodesForRegistration.pushBack(node);
		return node;
	}

	const Vec3& getSceneMin() const
	{
		return m_sceneMin;
	}

	const Vec3& getSceneMax() const
	{
		return m_sceneMax;
	}

	// Get a unique UUID.
	// Note: It's thread-safe.
	U32 getNewUuid()
	{
		return m_nodesUuid.fetchAdd(1);
	}

	SceneComponentArrays& getComponentArrays()
	{
		return m_componentArrays;
	}

	LightComponent* getDirectionalLight() const
	{
		return m_activeDirLight;
	}

	SkyboxComponent* getSkybox() const
	{
		return m_activeSkybox;
	}

	Array<Vec3, 2> getSceneBounds() const
	{
		ANKI_ASSERT(m_sceneMin < m_sceneMax);
		return {m_sceneMin, m_sceneMax};
	}

	// If enable is true the components will be checking for updates of resources. Useful for the editor resource updates. It has a perf hit so it
	// should be enabled only by the editor
	void setCheckForResourceUpdates(Bool enable)
	{
		m_checkForResourceUpdates = enable;
	}

	Error saveToTextFile(CString filename);

private:
	class UpdateSceneNodesCtx;

	class InitMemPoolDummy
	{
	public:
		~InitMemPoolDummy()
		{
			SceneMemoryPool::freeSingleton();
		}
	} m_initMemPoolDummy;

	static constexpr U32 kForceSetSceneBoundsFrameCount = 60 * 2; // Re-set the scene bounds after 2".

	mutable StackMemoryPool m_framePool;

	IntrusiveList<SceneNode> m_nodes;
	U32 m_nodesCount = 0;
	GrHashMap<CString, SceneNode*> m_nodesDict;

	SceneNode* m_mainCam = nullptr;
	SceneNode* m_defaultMainCam = nullptr;
	SceneNode* m_editorUi = nullptr;

	EventManager m_events;

	U64 m_frame = 0;

	Vec3 m_sceneMin = Vec3(-0.1f);
	Vec3 m_sceneMax = Vec3(+0.1f);

	IntrusiveList<SceneNode> m_nodesForRegistration;
	SceneDynamicArray<std::pair<SceneNode*, SceneString>> m_nodesRenamed;
	SpinLock m_nodesForRegistrationMtx;

	Bool m_checkForResourceUpdates = false;

	Atomic<U32> m_nodesUuid = {1};

	SceneComponentArrays m_componentArrays;

	LightComponent* m_activeDirLight = nullptr;
	SkyboxComponent* m_activeSkybox = nullptr;

	SceneGraph();

	~SceneGraph();

	void updateNodes(U32 tid, UpdateSceneNodesCtx& ctx);
	void updateNode(U32 tid, SceneNode& node, UpdateSceneNodesCtx& ctx);

	void sceneNodeChangedName(SceneNode& node, CString oldName);
};

} // end namespace anki