App::ViewerApplication Class Reference

#include <viewerapplication.h>

Detailed Description

Derived from RenderApplication, adds support for Stages, Views and GraphicsEntities to the asynchronous render app.

(C) 2007 Radon Labs GmbH (C) 2013-2018 Individual contributors, see AUTHORS file

Inherits App::RenderApplication.

Public Member Functions
	ViewerApplication ()
	constructor
virtual	~ViewerApplication ()
	destructor
virtual bool	Open ()
	open the application
virtual void	Close ()
	close the application
Public Member Functions inherited from App::RenderApplication
	RenderApplication ()
	constructor
virtual	~RenderApplication ()
	destructor
void	SetLogFileEnabled (bool b)
	enable/disable log file creation
void	SetOverrideRootDirectory (const Util::String &rootDir)
	override root-directory
void	SetMountStandardArchivesEnabled (bool b)
	enable/disable standard archive mounting
void	SetMultithreadedRendering (bool b)
	set multithreaded rendering
void	SetWindowData (const Util::Blob &data)
	sets the parent window
virtual void	Run ()
	run the application
Public Member Functions inherited from App::Application
	Application ()
	constructor
virtual	~Application ()
	destructor
void	SetCompanyName (const Util::String &n)
	set company name
const Util::String &	GetCompanyName () const
	get company name
void	SetAppTitle (const Util::String &n)
	set application name
const Util::String &	GetAppTitle () const
	get application name
void	SetAppID (const Util::String &n)
	set application id
const Util::String &	GetAppID () const
	get application id
void	SetAppVersion (const Util::String &n)
	set application version
const Util::String &	GetAppVersion () const
	get application version
void	SetCmdLineArgs (const Util::CommandLineArgs &a)
	set command line args
const Util::CommandLineArgs &	GetCmdLineArgs () const
	get command line args
virtual void	Exit ()
	exit the application, call right before leaving main()
bool	IsOpen () const
	return true if app is open
int	GetReturnCode () const
	get the return code

Protected Member Functions
virtual void	OnProcessInput ()
	process input (called before rendering)
virtual void	OnUpdateFrame ()
	update world
Protected Member Functions inherited from App::RenderApplication
Util::String	LookupProjectDirectory ()
	lookup the toolkit project key in the registry (Win32 only!)
void	SetQuitRequested (bool b)
	set quit requested flag
bool	IsQuitRequested () const
	return true if quit requested
virtual void	OnConfigureDisplay ()
	called to configure display
virtual void	OnSetupResourceMappers ()
	called to setup resource mappers
Timing::Time	GetTime () const
	get current absolute time
Timing::Time	GetFrameTime () const
	get current frame time
	_declare_timer (MainThreadFrameTimeAll)
	_declare_timer (MainThreadWaitForGraphicsFrame)
Protected Member Functions inherited from App::Application
void	SetReturnCode (int c)
	set return code

Protected Attributes
bool	useResolveRect
Math::rectangle< int >	resolveRect
Ptr< Graphics::GraphicsServer >	graphicsServer
Ptr< Debug::DebugShapeRenderer >	debugShapeRenderer
Ptr< Debug::DebugTextRenderer >	debugTextRenderer
Ptr< Graphics::Stage >	stage
Ptr< Graphics::View >	view
Ptr< Graphics::CameraEntity >	camera
RenderUtil::MayaCameraUtil	mayaCameraUtil
Protected Attributes inherited from App::RenderApplication
Ptr< Core::CoreServer >	coreServer
Ptr< Jobs::JobSystem >	jobSystem
Ptr< IO::GameContentServer >	gameContentServer
Ptr< IO::IoServer >	ioServer
Ptr< IO::IoInterface >	ioInterface
Ptr< Graphics::GraphicsInterface >	graphicsInterface
Ptr< Graphics::Display >	display
Ptr< Input::InputServer >	inputServer
Ptr< FrameSync::FrameSyncTimer >	frameSyncTimer
Ptr< Resources::ResourceManager >	resManager
Util::Blob	windowData
Timing::Time	time
Timing::Time	frameTime
bool	useMultithreadedRendering
bool	quitRequested
bool	logFileEnabled
bool	mountStandardArchivesEnabled
Util::String	overrideRootDirectory
Protected Attributes inherited from App::Application
Util::String	companyName
Util::String	appName
Util::String	appID
Util::String	appVersion
Util::CommandLineArgs	args
bool	isOpen
int	returnCode

Constructor & Destructor Documentation

ViewerApplication()

App::ViewerApplication::ViewerApplication

(

)

constructor

~ViewerApplication()

App::ViewerApplication::~ViewerApplication ( )

virtual

destructor

Member Function Documentation

Close()

void App::ViewerApplication::Close ( )

virtual

close the application

Reimplemented from App::RenderApplication.

OnProcessInput()

void App::ViewerApplication::OnProcessInput ( )

protectedvirtual

process input (called before rendering)

Reimplemented from App::RenderApplication.

OnUpdateFrame()

void App::ViewerApplication::OnUpdateFrame ( )

protectedvirtual

update world

Reimplemented from App::RenderApplication.

Open()

bool App::ViewerApplication::Open ( )

virtual

open the application

Reimplemented from App::RenderApplication.

Member Data Documentation

camera

Ptr<Graphics::CameraEntity> App::ViewerApplication::camera

protected

debugShapeRenderer

Ptr<Debug::DebugShapeRenderer> App::ViewerApplication::debugShapeRenderer

protected

debugTextRenderer

Ptr<Debug::DebugTextRenderer> App::ViewerApplication::debugTextRenderer

protected

graphicsServer

Ptr<Graphics::GraphicsServer> App::ViewerApplication::graphicsServer

protected

mayaCameraUtil

RenderUtil::MayaCameraUtil App::ViewerApplication::mayaCameraUtil

protected

resolveRect

Math::rectangle<int> App::ViewerApplication::resolveRect

protected

stage

Ptr<Graphics::Stage> App::ViewerApplication::stage

protected

useResolveRect

bool App::ViewerApplication::useResolveRect

protected

view

Ptr<Graphics::View> App::ViewerApplication::view

protected

---

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

• /github/workspace/code/render/apprender/viewerapplication.h
• /github/workspace/code/render/apprender/viewerapplication.cc