#include <Editor.h>

Inheritance diagram for sys::Editor:

Collaboration diagram for sys::Editor:

Public Member Functions
auto	getDefaultFont () -> ImFont *
	Editor ()
	~Editor () override
	Editor (const Editor &other)=default
	Editor (Editor &&other) noexcept
auto	operator= (const Editor &other) -> Editor &
auto	operator= (Editor &&other) noexcept -> Editor &=default
auto	clone () const -> std::unique_ptr< GameObject > override
	makes a copy a GameObject even if it's held polymorphically
auto	onUpdate (float dt) -> void override
	called once every frame.
auto	endWindow () -> void override
	currently unused, but intended to but was assumed to be necessary for a proper ImGui editor
auto	onRender () -> void override
	called every frame after update has been called for every object.
auto	load (const Stream &stream) -> void override
	Implementations will load the state of a GameObject from a th::Json Object.
auto	save (Stream &stream) const -> void override
	Implementations will load the state of a GameObject to a th::Json object.
auto	PreRender () -> void
auto	PostRender () -> void
	Post render will run all the normal Render() stuff instead of old function to allow for frame buffering to work.
auto	shouldShowGui () const -> bool
auto	drawSystemMenu () -> void
	Draw the window that shows all the systems in the game.
auto	drawSceneMenu () -> void
	draw the tree of Entities that exist in a scene
auto	EntityComponentsEditor () const -> void
auto	drawEntitiesCompact () -> bool
	used to determine how much spacing to give entities in the scene view
auto	EmitterEditor () const -> void
	draw editor for adjusting settings of the selected emitter
auto	receiveShowGUIKeyPressed (const Message *message) -> Message
auto	select (Entity *selected) -> void
	selects an Entity, and shows it's children in the Component view editor
auto	isSelected (Entity *entity) -> bool
	check whether an entity is currently selected in the editor
auto	getSelectedEntity () -> Entity *
	return selected entity, or nullptr if no entity is selected
auto	deselect (Entity *entity) -> void
	deselects and entity if it is currently selected.
auto	isPassingFilter (Entity *entity) -> bool
	See if the an Entity is passing the filter and should be drawn in the Scene View Currently unimplemented.
auto	toggleGuizmos () -> void
auto	getSliderRatio () const -> float
auto	select (ParticleEmitter *selected) -> void
	selects a particle Emitter, it will be rendered in the Emitter menu
auto	isSelected (ParticleEmitter *emitter) -> bool
	returns whether an emitter is currently selected
auto	deselect (ParticleEmitter *toDeselect) -> void
	deselects an emitter, if it is currently selected.
auto	getSceneViewPortMousePosition () -> Vector4D &
Public Member Functions inherited from System
auto	showMenu () -> void override
	Called before update each frame, for calling ImGui editor code relevant to the gameObject.
auto	getKey () const -> Key override
	Generates a unique Key that corresponds to the GameObject.
auto	getParent () const -> GameObject *override
	Gets the parent of a GameObject.
Public Member Functions inherited from GameObject
	GameObject (std::string typeName, gobj::Type parentType, gobj::Type type)
	constructor for gameobject.
virtual	~GameObject ()
	destructor for GameObject.
	GameObject (const GameObject &other)
	Copy Constructor.
auto	operator= (const GameObject &other) -> GameObject &
	copy assignment operator
	GameObject (GameObject &&other) noexcept
	Move constructor.
auto	operator= (GameObject &&other) noexcept -> GameObject &
	Move assignment operator.
virtual auto	update (float dt) -> void
	called once every frame.
virtual auto	render () -> void
	called every frame after update has been called for every object.
virtual auto	destroy () -> void
	Marks an GameObject to be destroyed.
virtual auto	onEnterEngine () -> void
	hook that is called when a GameObject enters the Engine tree.
virtual auto	onSceneStart (const std::string &sceneName) -> void
	Hook that is called before the first frame a scene is run, but after the entire scene is loaded into the engine To receive the hook, simply override the function in your class.
virtual auto	onSceneExit (const std::string &sceneName) -> void
	Hook that is called right before a scene is unloaded To receive the hook, simply override the function in your class.
virtual auto	for_each (std::function< void(GameObject &)> func) -> void
	applies a function to every child.
virtual auto	for_each (std::function< void(const GameObject &)> func) const -> void
	applies a const function to every child.
virtual auto	parentTo (GameObject *newParent) -> bool
	Sets the GameObject as a child of another GameObject.
auto	getInternalParent () const -> GameObject *
	returns the actual owning parent of the GameObject
virtual auto	addChild (std::unique_ptr< GameObject > newChild) -> bool
	Adds a child to a GameObject.
auto	destroyed () const -> bool
auto	getUUID () const -> gobj::UUID
auto	isUUID (gobj::UUID compareUUID) const -> bool
auto	getName () const -> const std::string &
	Gets the type of the object as a string.
auto	getNickname () const -> const std::string &
	Gets the nickname (custom, writable name) of a GameObject.
auto	getFormattedName () const -> const std::string &
	combines a GameObjects Type, Nickname, and UUID into one string, for use with logging.
auto	nameEquals (const std::string &compareString) const -> bool
	check whether a GameObjects typeName is equivilent to a given string.
auto	isType (gobj::Type otherType) const -> bool
	check whether the GameObject is the same as a given type.
auto	getObjectType () const -> gobj::Type
	gets the internal type of the GameObject, as an enum
auto	setNickname (const std::string &newNickname) -> void
	sets the GameObjects nickname.
auto	updates () const -> bool
auto	renders () const -> bool
auto	receivesMessages () const -> bool
auto	isActive () const -> bool
virtual auto	setShouldUpdate (bool _shouldUpdate) -> void
	set whether the GameObject should update every frame, and whether all of it's children should update every frame
virtual auto	setShouldRender (bool _shouldRender) -> void
	set whether the GameObject should render every frame, and whether all of it's children should render every frame
virtual auto	setShouldReceiveMessages (bool _shouldReceiveMessages) -> void
	set whether the GameObject should Receive Messags, and whether all of it's children should receive messages
auto	setActive (bool shouldBeActive) -> void
	set the GameObject should update, render, and receive messages

Static Public Member Functions
static auto	getEnum () -> Type
	function required by all systems
static auto	showTexturePickerMenu () -> gfx::Texture *
	creates a dropdown menu to select a new texture.
static auto	showMeshPickerMenu () -> gfx::Mesh *
	shows a dropdown menu to choose meshes
static auto	displayTexture (const gfx::Texture *texture) -> void
	show a texture in a small square

Private Member Functions
auto	SceneViewPort () -> void
	This is the Window that activates the viewport and renders the framebuffer.
void	calculateViewportCoords (float width, float height)
	helper function to calculate the coordinates of the mouse over the viewport

Static Private Member Functions
static void	drawEditorTopBar ()
	draw the top bar of the editor

Private Attributes
ImFont *	defaultFont
	The default font of the Editor.
float	sliderRatio = 0.4f
	The ratio of the total width a slider should take up.
ImGuiTextFilter	entityFilter
	IMGui filter for searching the scene tree. currently unused, as filtering a tree is non-trivial.
Entity *	selectedEntity = nullptr
	The entity currently selected in the Scene Tree.
bool	compactEntityView = false
	Whether the Scene Tree should be rendered more compact.
bool	showImGui {START_WITH_IMGUI}
	Whether the Editor should be shown.
Vector4D	editorMousePos = {0.f, 0.f, 0.f, 1.f}
	Position of the mouse relative to the scene viewport.
ParticleEmitter *	selectedEmitter = nullptr
	the emitter last selected on a particleGenerator

Additional Inherited Members
Public Types inherited from System
enum class	Type : unsigned short { system_error_type = 0 , newSystemStub = 100 , OpenGL = 200 , Input = 300 , Editor = 400 , Messaging = 500 , Camera = 600 , Logging = 700 , AudioSystem = 750 , Scoring = 800 , HandSystem = 900 , PlayerTurn = 950 , Table = 960 , SceneManager = 1000 , Particles = 1050 , ActionList = 1100 , DebugDraw = 1150 , ColliderSystem = 1300 , Options = 1400 , TestRunner = 64'000 }
Public Attributes inherited from GameObject
friend	Entity
friend	Node
friend	ChildrenHandeler
friend	Engine
Protected Member Functions inherited from System
virtual auto	systemShowMenu () -> void
	Specific systems should override this function to show their specific menu for the system.
	System (const std::string &typeName, Type systemType)
Protected Member Functions inherited from GameObject
auto	setInternalParent (GameObject *parent) -> bool
	sets the internal parent of a GameObject directly, avoiding abstractions provided by ParentTo().
auto	getGameObjectJson () const -> json
	Used for serializing GameObjects.
auto	setGameObjectJson (const json &stream) -> void
	used for deserializing GameObjects
virtual auto	getChildren () const -> std::shared_ptr< std::vector< GameObject * > >
	gets a vector of a GameObjects public (i.e.
auto	checkAddToSceneHook () -> void
	Determine if the GameObject was recently added to the engine, and if it was, call onEngineEnter.

Constructor & Destructor Documentation

◆ Editor() [1/3]

sys::Editor::Editor ( )

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~Editor()

sys::Editor::~Editor ( )

override

◆ Editor() [2/3]

sys::Editor::Editor ( const Editor & other )

default

Here is the call graph for this function:

◆ Editor() [3/3]

sys::Editor::Editor ( Editor && other )

noexcept

Here is the call graph for this function:

Member Function Documentation

◆ calculateViewportCoords()

void sys::Editor::calculateViewportCoords	(	float	width,
		float	height )

private

helper function to calculate the coordinates of the mouse over the viewport

Parameters

width	width of the viewport
height	height of the viewport

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone()

auto sys::Editor::clone ( ) const->std::unique_ptr< GameObject >

inlineoverridevirtual

makes a copy a GameObject even if it's held polymorphically

Warning: When overriding this function, make sure to set the parents object to this

Returns: a unique_ptr to a new stack allocated object that is a copy of the object

Implements GameObject.

Here is the call graph for this function:

◆ deselect() [1/2]

auto sys::Editor::deselect ( Entity * entity ) ->void

deselects and entity if it is currently selected.

used in the dtor of entities

Parameters

entity the entity to deselect

Here is the call graph for this function:

◆ deselect() [2/2]

auto sys::Editor::deselect ( ParticleEmitter * toDeselect ) ->void

deselects an emitter, if it is currently selected.

used in dtor of emitter

Parameters

toDeselect the Emitter to be deslected

Returns

◆ displayTexture()

auto sys::Editor::displayTexture ( const gfx::Texture * texture ) ->void

static

show a texture in a small square

Parameters

texture Texture to show

Here is the caller graph for this function:

◆ drawEditorTopBar()

void sys::Editor::drawEditorTopBar ( )

staticprivate

draw the top bar of the editor

Here is the call graph for this function:

Here is the caller graph for this function:

◆ drawEntitiesCompact()

auto sys::Editor::drawEntitiesCompact ( ) ->bool

used to determine how much spacing to give entities in the scene view

Returns: whether the entities should be drawn compact

◆ drawSceneMenu()

auto sys::Editor::drawSceneMenu ( ) ->void

draw the tree of Entities that exist in a scene

◆ drawSystemMenu()

auto sys::Editor::drawSystemMenu ( ) ->void

Draw the window that shows all the systems in the game.

Here is the call graph for this function:

◆ EmitterEditor()

auto sys::Editor::EmitterEditor ( ) const->void

draw editor for adjusting settings of the selected emitter

Here is the caller graph for this function:

◆ endWindow()

auto sys::Editor::endWindow ( ) ->void

inlineoverridevirtual

currently unused, but intended to but was assumed to be necessary for a proper ImGui editor

Implements GameObject.

◆ EntityComponentsEditor()

auto sys::Editor::EntityComponentsEditor ( ) const->void

Here is the caller graph for this function:

◆ getDefaultFont()

auto sys::Editor::getDefaultFont ( ) ->ImFont *

inline

◆ getEnum()

auto sys::Editor::getEnum ( ) ->Type

inlinestatic

function required by all systems

◆ getSceneViewPortMousePosition()

auto sys::Editor::getSceneViewPortMousePosition ( ) ->Vector4D &

◆ getSelectedEntity()

auto sys::Editor::getSelectedEntity ( ) ->Entity *

return selected entity, or nullptr if no entity is selected

Returns: Entity* the currently selected entity, or nullptr if no entity is selected

Here is the caller graph for this function:

◆ getSliderRatio()

auto sys::Editor::getSliderRatio ( ) const->float

nodiscard

◆ isPassingFilter()

auto sys::Editor::isPassingFilter ( Entity * entity ) ->bool

See if the an Entity is passing the filter and should be drawn in the Scene View Currently unimplemented.

Todo: Implement filtering of entities in the tree

Parameters

entity entity to check

Returns: true curretly

◆ isSelected() [1/2]

auto sys::Editor::isSelected ( Entity * entity ) ->bool

check whether an entity is currently selected in the editor

Parameters

entity entity to check

Returns: true if entity is selected

Here is the caller graph for this function:

◆ isSelected() [2/2]

auto sys::Editor::isSelected ( ParticleEmitter * emitter ) ->bool

returns whether an emitter is currently selected

Parameters

emitter emitter to check

Returns

◆ load()

auto sys::Editor::load ( const Stream & stream ) ->void

overridevirtual

Implementations will load the state of a GameObject from a th::Json Object.

Unimplemented in GameObject

Parameters

stream th::Json Object

Implements GameObject.

◆ onRender()

auto sys::Editor::onRender ( ) ->void

overridevirtual

called every frame after update has been called for every object.

Generally used for rendering an object to the screen, when applicable. Unimplemented in GameObject

Implements GameObject.

◆ onUpdate()

auto sys::Editor::onUpdate ( float dt ) ->void

overridevirtual

called once every frame.

Generally used for timers, movement, condition checks, etc. Unimplemented in GameObject

Parameters

dt	the time in seconds that has elapsed

Implements GameObject.

Here is the call graph for this function:

◆ operator=() [1/2]

auto sys::Editor::operator= ( const Editor & other ) ->Editor &

Here is the call graph for this function:

◆ operator=() [2/2]

auto sys::Editor::operator= ( Editor && other ) ->Editor &=default

defaultnoexcept

Here is the call graph for this function:

◆ PostRender()

auto sys::Editor::PostRender ( ) ->void

Post render will run all the normal Render() stuff instead of old function to allow for frame buffering to work.

◆ PreRender()

auto sys::Editor::PreRender ( ) ->void

◆ receiveShowGUIKeyPressed()

auto sys::Editor::receiveShowGUIKeyPressed ( const Message * message ) ->Message

Parameters

message

Returns

Here is the caller graph for this function:

◆ save()

auto sys::Editor::save ( Stream & stream ) const->void

overridevirtual

Implementations will load the state of a GameObject to a th::Json object.

Unimplemented in GameObject

Parameters

stream th::Json Object

Implements GameObject.

◆ SceneViewPort()

auto sys::Editor::SceneViewPort ( ) ->void

private

This is the Window that activates the viewport and renders the framebuffer.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ select() [1/2]

auto sys::Editor::select ( Entity * selected ) ->void

selects an Entity, and shows it's children in the Component view editor

Parameters

selected entity that was just selected

◆ select() [2/2]

auto sys::Editor::select ( ParticleEmitter * selected ) ->void

selects a particle Emitter, it will be rendered in the Emitter menu

Parameters

selected emitter to show in Emitter menu

◆ shouldShowGui()

auto sys::Editor::shouldShowGui ( ) const->bool

inline

◆ showMeshPickerMenu()

auto sys::Editor::showMeshPickerMenu ( ) ->gfx::Mesh *

static

shows a dropdown menu to choose meshes

Returns: the selected mesh if one was selected, otherwise nullptr

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showTexturePickerMenu()

auto sys::Editor::showTexturePickerMenu ( ) ->gfx::Texture *

static

creates a dropdown menu to select a new texture.

Returns: the new texture pointer if one was selected, nullptr if not

Todo: : it edits both of the sprites at the same time

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toggleGuizmos()

auto sys::Editor::toggleGuizmos ( ) ->void

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ compactEntityView

bool sys::Editor::compactEntityView = false

private

Whether the Scene Tree should be rendered more compact.

◆ defaultFont

ImFont* sys::Editor::defaultFont

private

The default font of the Editor.

◆ editorMousePos

Vector4D sys::Editor::editorMousePos = {0.f, 0.f, 0.f, 1.f}

private

Position of the mouse relative to the scene viewport.

◆ entityFilter

ImGuiTextFilter sys::Editor::entityFilter

private

IMGui filter for searching the scene tree. currently unused, as filtering a tree is non-trivial.

◆ selectedEmitter

ParticleEmitter* sys::Editor::selectedEmitter = nullptr

private

the emitter last selected on a particleGenerator

◆ selectedEntity

Entity* sys::Editor::selectedEntity = nullptr

private

The entity currently selected in the Scene Tree.

◆ showImGui

bool sys::Editor::showImGui {START_WITH_IMGUI}

private

Whether the Editor should be shown.

◆ sliderRatio

float sys::Editor::sliderRatio = 0.4f

private

The ratio of the total width a slider should take up.

The documentation for this class was generated from the following files:

/home/egrazil/sites/Brunot/The House/source/System/Editor.h
/home/egrazil/sites/Brunot/The House/source/System/Editor.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Editor() [1/3]

◆ ~Editor()

◆ Editor() [2/3]

◆ Editor() [3/3]

Member Function Documentation

◆ calculateViewportCoords()

◆ clone()

◆ deselect() [1/2]

◆ deselect() [2/2]

◆ displayTexture()

◆ drawEditorTopBar()

◆ drawEntitiesCompact()

◆ drawSceneMenu()

◆ drawSystemMenu()

◆ EmitterEditor()

◆ endWindow()

◆ EntityComponentsEditor()

◆ getDefaultFont()

◆ getEnum()

◆ getSceneViewPortMousePosition()

◆ getSelectedEntity()

◆ getSliderRatio()

◆ isPassingFilter()

◆ isSelected() [1/2]

◆ isSelected() [2/2]

◆ load()

◆ onRender()

◆ onUpdate()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PostRender()

◆ PreRender()

◆ receiveShowGUIKeyPressed()

◆ save()

◆ SceneViewPort()

◆ select() [1/2]

◆ select() [2/2]

◆ shouldShowGui()

◆ showMeshPickerMenu()

◆ showTexturePickerMenu()

◆ toggleGuizmos()

Member Data Documentation

◆ compactEntityView

◆ defaultFont

◆ editorMousePos

◆ entityFilter

◆ selectedEmitter

◆ selectedEntity

◆ showImGui

◆ sliderRatio