Graphics::View Class Reference

#include <view.h>

Detailed Description

A view describes a camera which can observe a Stage.

The view processes the attached Stage through its FrameScript each frame.

Copyright

(C) 2017-2020 Individual contributors, see AUTHORS file

Inherits Core::RefCounted.

Public Member Functions
	View ()
	constructor
virtual	~View ()
	destructor
void	UpdateConstants ()
	Update constants.
bool	Render (const IndexT frameIndex, const Timing::Time time, const IndexT bufferIndex)
	render through view, returns true if framescript needs resizing
void	SetFrameScript (bool(*func)(const Math::rectangle< int > &viewport, IndexT frameIndex, IndexT bufferIndex))
	Set run function.
void	SetViewport (const Math::rectangle< int > &rect)
	Set viewport.
const Math::rectangle< int > &	GetViewport ()
	Get viewport.
void	SetCamera (const GraphicsEntityId &camera)
	set camera
const GraphicsEntityId &	GetCamera ()
	get camera
void	SetStageMask (const uint16_t stage)
	set stage
const uint16_t	GetStageMask () const
	get stage
bool	IsEnabled () const
	returns whether view is enabled
void	Enable ()
	enable this view
void	Disable ()
	disable this view
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
int	GetRefCount () const
	get the current refcount
void	AddRef ()
	increment refcount by one
void	Release ()
	decrement refcount and destroy object if refcount is zero
bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class
bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string
bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc
bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class
bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string
bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc
const Util::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Private Member Functions
	__DeclareClass (View)

Private Attributes
Math::rectangle< int >	viewport
uint16_t	stageMask
bool(*	func )(const Math::rectangle< int > &viewport, IndexT frameIndex, IndexT bufferIndex)
GraphicsEntityId	camera
bool	enabled

Friends
class	GraphicsServer

Additional Inherited Members
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Constructor & Destructor Documentation

View()

Graphics::View::View

(

)

constructor

~View()

Graphics::View::~View ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Graphics::View::__DeclareClass ( View )

private

Disable()

void Graphics::View::Disable ( )

inline

disable this view

Enable()

void Graphics::View::Enable ( )

inline

enable this view

GetCamera()

const GraphicsEntityId & Graphics::View::GetCamera ( )

inline

get camera

GetStageMask()

const uint16_t Graphics::View::GetStageMask ( ) const

inline

get stage

GetViewport()

const Math::rectangle< int > & Graphics::View::GetViewport ( )

inline

Get viewport.

IsEnabled()

bool Graphics::View::IsEnabled ( ) const

inline

returns whether view is enabled

Render()

bool Graphics::View::Render	(	const IndexT	frameIndex,
		const Timing::Time	time,
		const IndexT	bufferIndex )

render through view, returns true if framescript needs resizing

SetCamera()

void Graphics::View::SetCamera ( const GraphicsEntityId & camera )

inline

set camera

SetFrameScript()

void Graphics::View::SetFrameScript ( bool(* func )(const Math::rectangle< int > &viewport, IndexT frameIndex, IndexT bufferIndex) )

inline

Set run function.

SetStageMask()

void Graphics::View::SetStageMask ( const uint16_t stage )

inline

set stage

SetViewport()

void Graphics::View::SetViewport ( const Math::rectangle< int > & rect )

inline

Set viewport.

UpdateConstants()

void Graphics::View::UpdateConstants

(

)

Update constants.

Friends And Related Symbol Documentation

GraphicsServer

friend class GraphicsServer

friend

Member Data Documentation

camera

GraphicsEntityId Graphics::View::camera

private

enabled

bool Graphics::View::enabled

private

func

bool(* Graphics::View::func) (const Math::rectangle< int > &viewport, IndexT frameIndex, IndexT bufferIndex)

private

stageMask

uint16_t Graphics::View::stageMask

private

viewport

Math::rectangle<int> Graphics::View::viewport

private

---

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

• /github/workspace/code/render/graphics/view.h
• /github/workspace/code/render/graphics/view.cc