ViewportLayout

Stores information for how to construct a group of viewports such as those in the center 3D panel. More...

Inheritance diagram for ViewportLayout:

Collaboration diagram for ViewportLayout:

Public Member Functions
	ViewportLayout ()
	Constructs a default ViewportLayout.
	ViewportLayout (ViewportLayoutTheme new_theme)
	Constructs a ViewportLayout with the specified theme.
void	createDefaultOrthoAnimations (const TimeSpan &span)
	Creates default orthographic camera animations for all cameras in this layout.
void	finishReadingINI (INIFactory &factory) final override
	Called after INI reading is complete to perform any post-load setup.
void	getINI (INIFactory &factory) final override
	Serializes or deserializes this layout to/from an INI file.
bool	operator!= (const ViewportLayout &layout) const
	Checks inequality with another ViewportLayout.
bool	operator== (const ViewportLayout &layout) const
	Checks equality with another ViewportLayout.
void	setViewportTheme (ViewportLayoutTheme new_theme)
	Sets the viewport theme and reconfigures cameras to match the new theme.
uint04	themeCameraCount () const
	Returns the number of cameras defined by the current theme.
Public Member Functions inherited from INIInterface
	INIInterface ()
	Constructs an INIInterface with no default INI file.
	INIInterface (const File &default_ini)
	Constructs an INIInterface with the specified default INI file.
virtual	~INIInterface ()
	Virtual destructor for safe polymorphic cleanup.
virtual void	prepareForINI (INIFactory &)
	Called before reading or writing an INI file.
virtual bool	readINIOptions ()
	Reads INI options from the default INI file.
virtual bool	readINIOptions (File &ini_file)
	Reads INI options from the specified INI file.
virtual bool	saveINIOptions (bool multithead=false)
	Saves INI options to the default INI file.
virtual bool	saveINIOptions (File &ini_file, bool multithead=false)
	Saves INI options to the specified INI file.
void	setDefaultINIFile (const File &file)
	Sets the default INI file path used for reading and writing options.
virtual void	writeToLog (const StringView &title, LogPtr log, uint01 log_level=2U)
	Writes the current INI options to the specified log with a title.
virtual void	writeToLog (LogPtr log, uint01 log_level=2U)
	Writes the current INI options to the specified log.

Public Attributes
Buffer< ViewportFormat >	cameras
	The primary visible cameras in this layout.
Buffer< ViewportFormat >	floating_cameras
	Cameras displayed in floating/detached windows.
Buffer< ViewportFormat >	hidden_cameras
	Cameras that are part of the layout but currently hidden.
UUID	id
	The unique identifier for this viewport layout.
ViewportLayoutTheme	theme
	The active layout theme controlling viewport arrangement.

Additional Inherited Members
Protected Attributes inherited from INIInterface
File	m_default_ini
	The default file path used for reading and writing INI options.

Detailed Description

Stores information for how to construct a group of viewports such as those in the center 3D panel.

---

Manages collections of cameras with different visibility states and supports serialization through INI files.

Definition at line 62 of file ViewportLayout.h.

Constructor & Destructor Documentation

ViewportLayout()

ViewportLayout::ViewportLayout

(

ViewportLayoutTheme

new_theme

)

Constructs a ViewportLayout with the specified theme.

Parameters

[in]

new_theme

The viewport layout theme to apply.

Member Function Documentation

createDefaultOrthoAnimations()

void ViewportLayout::createDefaultOrthoAnimations

(

const TimeSpan &

span

)

Creates default orthographic camera animations for all cameras in this layout.

Parameters

[in]

span

The duration of each animation.

finishReadingINI()

void ViewportLayout::finishReadingINI ( INIFactory & factory )

finaloverridevirtual

Called after INI reading is complete to perform any post-load setup.

Parameters

[in]

factory

The INI factory that was used for reading.

Reimplemented from INIInterface.

getINI()

void ViewportLayout::getINI ( INIFactory & factory )

finaloverridevirtual

Serializes or deserializes this layout to/from an INI file.

Parameters

[in]

factory

The INI factory used for reading or writing.

Implements INIInterface.

operator!=()

bool ViewportLayout::operator!=

(

const ViewportLayout &

layout

)

const

Checks inequality with another ViewportLayout.

Parameters

[in]

layout

The ViewportLayout to compare against.

Returns

True if any field differs.

References ViewportLayout().

operator==()

bool ViewportLayout::operator==

(

const ViewportLayout &

layout

)

const

Checks equality with another ViewportLayout.

Parameters

[in]

layout

The ViewportLayout to compare against.

Returns

True if all fields are equal.

References ViewportLayout().

setViewportTheme()

void ViewportLayout::setViewportTheme

(

ViewportLayoutTheme

new_theme

)

Sets the viewport theme and reconfigures cameras to match the new theme.

Parameters

[in]

new_theme

The viewport layout theme to apply.

themeCameraCount()

uint04 ViewportLayout::themeCameraCount

(

)

const

Returns the number of cameras defined by the current theme.

Returns

The camera count for the active theme.

---

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

• Design/Headers/ViewportLayout.h