anki-3d-engine/AnKi/Scene/Components/UiComponent.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/Components/SceneComponent.h>
#include <AnKi/Ui/Canvas.h>

namespace anki {

/// @addtogroup scene
/// @{

using UiQueueElementDrawCallback = void (*)(Canvas& canvas, void* userData);

/// UI scene component.
class UiComponent : public SceneComponent
{
	ANKI_SCENE_COMPONENT(UiComponent)

public:
	UiComponent(SceneNode* node)
		: SceneComponent(node, kClassType)
	{
	}

	~UiComponent()
	{
	}

	void init(UiQueueElementDrawCallback callback, void* userData)
	{
		ANKI_ASSERT(callback != nullptr);
		ANKI_ASSERT(userData != nullptr);
		m_drawCallback = callback;
		m_userData = userData;
	}

	void drawUi(Canvas& canvas)
	{
		if(m_drawCallback && m_enabled)
		{
			m_drawCallback(canvas, m_userData);
		}
	}

	Bool isEnabled() const
	{
		return m_enabled;
	}

	void setEnabled(Bool enabled)
	{
		m_enabled = enabled;
	}

private:
	UiQueueElementDrawCallback m_drawCallback = nullptr;
	void* m_userData = nullptr;
	Bool m_enabled = true;

	void update([[maybe_unused]] SceneComponentUpdateInfo& info, Bool& updated) override
	{
		updated = false;
	}
};
/// @}

} // end namespace anki