Hymn to Beauty
C++ 3D Engine
Editor Class Reference

Handles the main editor. More...

#include <Editor.hpp>

Public Member Functions

 Editor (Utility::Window *window, Video::LowLevelRenderer *lowLevelRenderer)
 Create new editor. More...
 
 ~Editor ()
 Destructor. More...
 
void RenderHymn ()
 Render the hymn using the editor's debug visualization settings. More...
 
void Show (float deltaTime)
 Show the editor. More...
 
bool HasMadeChanges () const
 Show the editor. More...
 
void Save () const
 Save the hymn being edited. More...
 
void LoadSceneState ()
 Loads the save editor state. More...
 
bool ReadyToClose () const
 Is the editor ready to be closed, have we saved everything? More...
 
bool IsClosing () const
 Is the editor preparing for closing down? More...
 
void Close ()
 Close the editor. More...
 
bool IsVisible () const
 Get whether the resource list is visible. More...
 
void SetVisible (bool visible)
 Set whether the resource list should be visible. More...
 
EntityGetCamera () const
 Get the editor camera. More...
 

Public Attributes

bool vertsLoaded = false
 
bool paintModeActive = false
 

Detailed Description

Handles the main editor.

Constructor & Destructor Documentation

◆ Editor()

Editor::Editor ( Utility::Window window,
Video::LowLevelRenderer lowLevelRenderer 
)

Create new editor.

Parameters
windowThe window to display the editor in.
lowLevelRendererThe low-level renderer to use.

◆ ~Editor()

Editor::~Editor ( )

Destructor.

Member Function Documentation

◆ Close()

void Editor::Close ( )

Close the editor.

◆ GetCamera()

Entity * Editor::GetCamera ( ) const

Get the editor camera.

Returns
Camera through which to render.

◆ HasMadeChanges()

bool Editor::HasMadeChanges ( ) const

Show the editor.

Returns
Check if you have made any changes to the scene.

◆ IsClosing()

bool Editor::IsClosing ( ) const

Is the editor preparing for closing down?

Returns
Are we closing the editor?

◆ IsVisible()

bool Editor::IsVisible ( ) const

Get whether the resource list is visible.

Returns
Whether the resource list is visible.

◆ LoadSceneState()

void Editor::LoadSceneState ( )

Loads the save editor state.

◆ ReadyToClose()

bool Editor::ReadyToClose ( ) const

Is the editor ready to be closed, have we saved everything?

Returns
Are we ready to close the editor?

◆ RenderHymn()

void Editor::RenderHymn ( )

Render the hymn using the editor's debug visualization settings.

◆ Save()

void Editor::Save ( ) const

Save the hymn being edited.

◆ SetVisible()

void Editor::SetVisible ( bool  visible)

Set whether the resource list should be visible.

Parameters
visibleWhether the resource list should be visible.

◆ Show()

void Editor::Show ( float  deltaTime)

Show the editor.

Parameters
deltaTimeTime since last frame (in seconds).

Member Data Documentation

◆ paintModeActive

bool Editor::paintModeActive = false

◆ vertsLoaded

bool Editor::vertsLoaded = false

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