UI::ViewportWindow

#include "GUI/Elements/Windows/ViewportWindow.h"

Inherits from IWindow, std::enable_shared_from_this< IWindow >

Public Classes

	Name
struct	ViewportSpace <br>Helper struct containing various information about the current scene view space.

Public Functions

	Name
	ViewportWindow(ViewportModule * module, int index, bool show)
virtual void	render() override
void	updateGrids()
void	updateSpace()<br>Update state of the viewport reference matrix based on app context.

Public Attributes

	Name
std::shared_ptr< Vp::AggregateCamera >	m_camera
ViewportModule *	m_module
ViewportWindowSettings	m_settings
ViewportSpace	m_space

Additional inherited members

Public Functions inherited from IWindow

	Name
	IWindow(std::string title, bool show =false)
	IWindow(std::string title, int instanceIndex, bool show)
virtual	~IWindow() =default
virtual const char *	getID() const =0
WPtr< InputController >	getInput()<br>Returns window input controller.
const char *	getName()
bool *	getShowPtr()
const std::string &	getTitle() const
void	hide()
bool	isVisible() const
const void	setTitle(std::string title)
void	show()

Protected Functions inherited from IWindow

	Name
void	updateWindowInfo()<br>Collect information about the current window.

Public Attributes inherited from IWindow

	Name
bool	m_autoFocus <br>When true the window will get focus immediately upon hovering over it.
int	m_instanceIndex <br>Window instance identifier, for windows with multiple instances of same type, -1 default.
std::string	m_title <br>Visible window title.
bool	m_windowInfoUpdated <br>A flag indicating the updateWindowInfo() method was called.
WindowManager *	m_windowManager <br>Weak reference to a WindowManager set when this window is added to it.
glm::vec2	m_windowMax <br>Bottom right corner of the window.
glm::vec2	m_windowMin <br>Top left corner of the window, same as m_windowPos (separate variable for clarity)
glm::vec2	m_windowPos <br>Top-left corner of the window in screen coordinates.
glm::ivec2	m_windowSize <br>Window width and height dimensions.

Protected Attributes inherited from IWindow

	Name
Ptr< InputController >	m_input
std::string	m_name <br>Full ImGui window identifier.
bool	m_nameNeedsUpdate <br>Workaround to avoid setting the name in the constructor (cannot call getID there)
bool	m_show

Friends inherited from IWindow

	Name
class	WindowManager

Public Functions Documentation

function ViewportWindow

cpp

ViewportWindow(
    ViewportModule * module,
    int index,
    bool show
)

ViewportWindow(
    ViewportModule * module,
    int index,
    bool show
)

TodoMH This is example code, it can be removed anytime.

todoend

function render

cpp

virtual void render() override

virtual void render() override

Reimplements: IWindow::render

function updateGrids

cpp

void updateGrids()

void updateGrids()

function updateSpace

cpp

void updateSpace()

void updateSpace()

Update state of the viewport reference matrix based on app context.

Public Attributes Documentation

variable m_camera

cpp

std::shared_ptr< Vp::AggregateCamera > m_camera;

std::shared_ptr< Vp::AggregateCamera > m_camera;

variable m_module

cpp

ViewportModule * m_module;

ViewportModule * m_module;

variable m_settings

cpp

ViewportWindowSettings m_settings;

ViewportWindowSettings m_settings;

variable m_space

cpp

ViewportSpace m_space;

ViewportSpace m_space;

Updated on 2025-05-31 at 12:55:31 +0000

UI::ViewportWindow ​

Public Classes ​

Public Functions ​

Public Attributes ​

Additional inherited members ​

Public Functions Documentation ​

function ViewportWindow ​

function render ​

function updateGrids ​

function updateSpace ​

Public Attributes Documentation ​

variable m_camera ​

variable m_module ​

variable m_settings ​

variable m_space ​