GraphicsFeature::GraphicsFeatureUnit Class Reference

#include <graphicsfeatureunit.h>

Detailed Description

Sets up the core rendering system and provides properties and managers for default usage, such as rendering models, animations, particles, etc.

Copyright

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

Inherits Game::FeatureUnit.

Private Member Functions
__DeclareClass(GraphicsFeatureUnit) __DeclareSingleton(GraphicsFeatureUnit) public	~GraphicsFeatureUnit ()
	destructor
void	OnAttach () override
	called from GameServer::AttachGameFeature()
void	OnActivate () override
	Called upon activation of feature unit.
void	OnDeactivate () override
	Called upon deactivation of feature unit.
void	OnBeginFrame () override
	called on begin of frame
void	OnBeforeViews () override
	Called before views.
void	OnFrame () override
	called in the middle of the feature trigger cycle
void	OnEndFrame () override
	called at the end of the feature trigger cycle
void	OnRenderDebug () override
	called when game debug visualization is on
void	SetWindowTitle (const Util::StringAtom &title)
	Set window title.
void	SetGraphicsDebugging (bool value)
	Set Graphics Debugging on/off.
Ptr< Graphics::View >	GetDefaultView () const
	retrieve the default view
ViewHandle	GetDefaultViewHandle () const
	retrieve the default view handle
void	SetFrameScript (IO::URI const &uri)
	set framescript. must be done before OnActivate!

Private Attributes
Graphics::GraphicsEntityId	globalLight
IO::URI	defaultFrameScript
Util::StringAtom	title
Ptr< Graphics::View >	defaultView
Ptr< Graphics::GraphicsServer >	gfxServer
Ptr< Input::InputServer >	inputServer
CoreGraphics::WindowId	mainWindow
Ptr< Game::Manager >	graphicsManager
Ptr< Game::Manager >	cameraManager
ViewHandle	defaultViewHandle
Core::CVar *	r_debug
Core::CVar *	r_show_frame_inspector

Additional Inherited Members
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
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)
Protected Attributes inherited from Game::FeatureUnit
Util::Array< Ptr< Manager > >	managers
bool	active
Util::CommandLineArgs	args
	cmdline args for configuration from cmdline

Constructor & Destructor Documentation

~GraphicsFeatureUnit()

GraphicsFeature::GraphicsFeatureUnit::~GraphicsFeatureUnit ( )

private

destructor

Member Function Documentation

GetDefaultView()

Ptr< Graphics::View > GraphicsFeature::GraphicsFeatureUnit::GetDefaultView ( ) const

inlineprivate

retrieve the default view

GetDefaultViewHandle()

ViewHandle GraphicsFeature::GraphicsFeatureUnit::GetDefaultViewHandle ( ) const

inlineprivate

retrieve the default view handle

OnActivate()

void GraphicsFeature::GraphicsFeatureUnit::OnActivate ( )

overrideprivatevirtual

Called upon activation of feature unit.

Reimplemented from Game::FeatureUnit.

OnAttach()

void GraphicsFeature::GraphicsFeatureUnit::OnAttach ( )

overrideprivatevirtual

called from GameServer::AttachGameFeature()

Reimplemented from Game::FeatureUnit.

OnBeforeViews()

void GraphicsFeature::GraphicsFeatureUnit::OnBeforeViews ( )

overrideprivatevirtual

Called before views.

Reimplemented from Game::FeatureUnit.

OnBeginFrame()

void GraphicsFeature::GraphicsFeatureUnit::OnBeginFrame ( )

overrideprivatevirtual

called on begin of frame

Reimplemented from Game::FeatureUnit.

OnDeactivate()

void GraphicsFeature::GraphicsFeatureUnit::OnDeactivate ( )

overrideprivatevirtual

Called upon deactivation of feature unit.

Reimplemented from Game::FeatureUnit.

OnEndFrame()

void GraphicsFeature::GraphicsFeatureUnit::OnEndFrame ( )

overrideprivatevirtual

called at the end of the feature trigger cycle

Reimplemented from Game::FeatureUnit.

OnFrame()

void GraphicsFeature::GraphicsFeatureUnit::OnFrame ( )

overrideprivatevirtual

called in the middle of the feature trigger cycle

Reimplemented from Game::FeatureUnit.

OnRenderDebug()

void GraphicsFeature::GraphicsFeatureUnit::OnRenderDebug ( )

overrideprivatevirtual

called when game debug visualization is on

Reimplemented from Game::FeatureUnit.

SetFrameScript()

void GraphicsFeature::GraphicsFeatureUnit::SetFrameScript ( IO::URI const & uri )

inlineprivate

set framescript. must be done before OnActivate!

SetGraphicsDebugging()

void GraphicsFeature::GraphicsFeatureUnit::SetGraphicsDebugging ( bool value )

inlineprivate

Set Graphics Debugging on/off.

SetWindowTitle()

void GraphicsFeature::GraphicsFeatureUnit::SetWindowTitle ( const Util::StringAtom & title )

inlineprivate

Set window title.

Member Data Documentation

cameraManager

Ptr<Game::Manager> GraphicsFeature::GraphicsFeatureUnit::cameraManager

private

defaultFrameScript

IO::URI GraphicsFeature::GraphicsFeatureUnit::defaultFrameScript

private

defaultView

Ptr<Graphics::View> GraphicsFeature::GraphicsFeatureUnit::defaultView

private

defaultViewHandle

ViewHandle GraphicsFeature::GraphicsFeatureUnit::defaultViewHandle

private

gfxServer

Ptr<Graphics::GraphicsServer> GraphicsFeature::GraphicsFeatureUnit::gfxServer

private

globalLight

Graphics::GraphicsEntityId GraphicsFeature::GraphicsFeatureUnit::globalLight

private

graphicsManager

Ptr<Game::Manager> GraphicsFeature::GraphicsFeatureUnit::graphicsManager

private

inputServer

Ptr<Input::InputServer> GraphicsFeature::GraphicsFeatureUnit::inputServer

private

mainWindow

CoreGraphics::WindowId GraphicsFeature::GraphicsFeatureUnit::mainWindow

private

r_debug

Core::CVar* GraphicsFeature::GraphicsFeatureUnit::r_debug

private

r_show_frame_inspector

Core::CVar* GraphicsFeature::GraphicsFeatureUnit::r_show_frame_inspector

private

title

Util::StringAtom GraphicsFeature::GraphicsFeatureUnit::title

private

---

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

• /github/workspace/code/addons/graphicsfeature/graphicsfeatureunit.h
• /github/workspace/code/addons/graphicsfeature/graphicsfeatureunit.cc