Stores information for how to construct a viewport, including camera identity, field of view, zoom focus, and animation settings. More...

Collaboration diagram for ViewportFormat:

Public Member Functions
	ViewportFormat ()
	Constructs a default ViewportFormat.
	ViewportFormat (bool is_user_camera)
	Constructs a ViewportFormat with the specified user camera flag.
void	autoSetName ()
	Automatically generates a display name for this viewport based on its current settings.
bool	operator!= (const ViewportFormat &layout) const
	Checks inequality with another ViewportFormat.
bool	operator== (const ViewportFormat &layout) const
	Checks equality with another ViewportFormat.

Public Attributes
UUID	camera_id = Constant<UUID>::Invalid
	The UUID of the assigned camera. Invalid indicates any camera may be used.
AutoZoomFocus	focus
	The auto-zoom and focus settings for this viewport.
bool	is_ortho = false
	Whether the viewport uses orthographic projection instead of perspective.
bool	is_user_camera = true
	Whether this viewport uses a user-controlled camera rather than a fixed one.
TranslatedString	name
	The user-facing display name for this viewport.
fltp08	ortho_fov = Constant<fltp08>::Invalid
	The orthographic field of view. Invalid uses the default.
Vector< 2, Angle< fltp08 > >	perspective_fov = Constant<Vector<2, Angle<fltp08>>>::Invalid
	The horizontal and vertical perspective field of view. Invalid uses the default.
bool	use_reference_size = true
	Whether the viewport should use a reference size for scaling.
Buffer< CameraAnimation >	viewport_animations
	The list of camera animations applied to this viewport.

Detailed Description

Stores information for how to construct a viewport, including camera identity, field of view, zoom focus, and animation settings.

Definition at line 14 of file ViewportLayout.h.

Constructor & Destructor Documentation

ViewportFormat::ViewportFormat ( bool is_user_camera )

explicit

Constructs a ViewportFormat with the specified user camera flag.

Parameters

[in] is_user_camera Whether this viewport uses a user-controlled camera.

bool ViewportFormat::operator!= ( const ViewportFormat & layout ) const

Checks inequality with another ViewportFormat.

Parameters

[in] layout The ViewportFormat to compare against.

bool ViewportFormat::operator== ( const ViewportFormat & layout ) const

Checks equality with another ViewportFormat.

Parameters

[in] layout The ViewportFormat to compare against.

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