ns::App Class Reference

Inheritance diagram for ns::App:

Public Member Functions
	App ()
	Contructs an App from ns::Config configuration.
	App (std::string title, sf::Vector2u resolution, float scale=1.f, int fps=Settings::user_config.frame_rate, int ups=Settings::user_config.update_rate)
	Constructs an App from constructor arguments. More...
virtual	~App ()
	Delete all Scene, Camera and DebugText objects and free loaded resources.
auto	getTitle () const -> const std::string &
	Returns the title of the App. More...
auto	getWindow () -> AppWindow &
	Get the AppWindow. More...
auto	getMousePosition () const -> sf::Vector2f
auto	getMousePosition (Camera &cam) const -> sf::Vector2f
auto	getTouchPosition (int finger) const -> sf::Vector2f
auto	getTouchPosition (int finger, Camera &cam) const -> sf::Vector2f
auto	allScenes () -> std::list< Scene > &
	Get all the Scene objects created within the App. More...
auto	getScene (const std::string &name) -> Scene &
	Get a Scene by name. More...
auto	allCameras () -> std::list< Camera > &
	Get all the Camera objects created within the App. More...
auto	getCamera (const std::string &name) -> Camera &
	Get a Camera by name. More...
void	toggleFullscreen ()
	Toggle fullscreen display.
auto	getDt () const -> float
void	run ()
	Starts the game loop.
Public Member Functions inherited from ns::AppStateInterface
virtual void	preRender ()
Public Member Functions inherited from ns::ShaderHolder
void	setShader (sf::Shader *shader)
	Set the shader to be applied when rendering. More...
auto	getShader () const -> sf::Shader *
	Get the current Shader. More...
void	toggleShader ()
	Toggle shader.
void	clearShader ()
	Remove the shader. More...

Protected Member Functions
auto	createScene (const std::string &name) -> Scene &
	Creates a Scene object and returns a reference to it. More...
auto	createCamera (const std::string &name, int order, const ns::IntRect &view={{0, 0}, sf::Vector2i(Settings::user_config.resolution)}, const ns::FloatRect &viewport={0, 0, 1.f, 1.f}) -> Camera &
	Creates a Camera object and returns a reference to it. More...
auto	createCamera (const std::string &name, int order, const ns::FloatRect &viewport) -> Camera &
	Creates a Camera object and returns a reference to it. More...
void	addDebugText (const std::string &label, const sf::Vector2f &position, const sf::Color &color=ns::DebugTextInterface::color)
	Creates a label only DebugText object and render it on the AppWindow directly.
template<typename T >
void	addDebugText (const std::string &label, T *var_address, const sf::Vector2f &position, const sf::Color &color=ns::DebugTextInterface::color)
	Creates a DebugText object and render it on the AppWindow directly. More...
template<typename T >
void	addDebugText (const std::string &label, std::function< T()> fn, const sf::Vector2f &position, const sf::Color &color=ns::DebugTextInterface::color)
	Creates a DebugText object and render it on the AppWindow directly. More...
void	sleep ()
	The App enters sleep mode, the App will not update. Used for Android when application runs in background.
void	awake ()
	The App awakes from sleep mode. Used for Android when application run as main process.
void	onEvent (const sf::Event &event) override
	Handles SFML events. More...
void	update () override
	App update method. More...

Detailed Description

Definition at line 39 of file App.hpp.

Constructor & Destructor Documentation

App()

ns::App::App	(	std::string	title,
		sf::Vector2u	resolution,
		float	scale = 1.f,
		int	fps = Settings::user_config.frame_rate,
		int	ups = Settings::user_config.update_rate
	)

Constructs an App from constructor arguments.

Parameters

title	App title
resolution	Resolution of you application
scale	Resolution * scale = WindowSize
fps	Desired framerate limit
ups	Update per second

Member Function Documentation

addDebugText() [1/2]

template<typename T >

void ns::App::addDebugText ( const std::string &  label, T *  var_address, const sf::Vector2f &  position, const sf::Color &  color = ns::DebugTextInterface::color  )

protected

Creates a DebugText object and render it on the AppWindow directly.

DebugText takes the address of a variable and will display its value on the AppWindow at the given position. The label is displayed near the value. DebugText let you visualize the variable's value changing in real time.

Template Parameters

T	Type of the variable to be displayed

Parameters

label	Label of the DebugText
var_address	Address of the variable
position	Position of the DebugText on the AppWindow
color	Fill color of the DebugText

Definition at line 277 of file App.hpp.

addDebugText() [2/2]

template<typename T >

void ns::App::addDebugText ( const std::string &  label, std::function< T()>  fn, const sf::Vector2f &  position, const sf::Color &  color = ns::DebugTextInterface::color  )

protected

Creates a DebugText object and render it on the AppWindow directly.

Template Parameters

T	Type of the value returned by the lambda function

Parameters

label	Label of the DebugText
fn	Lambda function to be evaluated
position	Position of the DebugText on the AppWindow
color	Fill color of the DebugText

Definition at line 284 of file App.hpp.

allCameras()

auto ns::App::allCameras

(

)

-> std::list< Camera > &

Get all the Camera objects created within the App.

Returns

Vector of Camera objects

allScenes()

auto ns::App::allScenes

(

)

-> std::list< Scene > &

Get all the Scene objects created within the App.

Returns

Vector of Scene objects

createCamera() [1/2]

auto ns::App::createCamera ( const std::string &  name, int  order, const ns::IntRect &  view = {{0, 0}, sf::Vector2i(Settings::user_config.resolution)}, const ns::FloatRect &  viewport = {0, 0, 1.f, 1.f}  ) -> Camera &

protected

Creates a Camera object and returns a reference to it.

Parameters

name	Name of the Camera
order	Order of rendering of the Camera
view	Rectangle representing the position and size of the Camera
viewport	Viewport of the Camera on the AppWindow

Returns

Reference to the created Camera object

createCamera() [2/2]

auto ns::App::createCamera ( const std::string &  name, int  order, const ns::FloatRect &  viewport  ) -> Camera &

protected

Creates a Camera object and returns a reference to it.

Parameters

name	Name of the Camera
order	Order of rendering of the Camera
view	Rectangle representing the position and size of the Camera

Returns

Reference to the created Camera object *

createScene()

auto ns::App::createScene ( const std::string &  name ) -> Scene &

protected

Creates a Scene object and returns a reference to it.

Parameters

width	Width of the new Scene
height	Height of the new Scene

Returns

Reference to the created Scene object

getCamera()

auto ns::App::getCamera

(

const std::string &

name

)

-> Camera &

Get a Camera by name.

Parameters

name	Name of the Camera to get

Returns

Reference to the requested Camera

getScene()

auto ns::App::getScene

(

const std::string &

name

)

-> Scene &

Get a Scene by name.

Parameters

name	Name of the Scene to get

Returns

Reference to the requested Scene object

getTitle()

auto ns::App::getTitle

(

)

const -> const std::string &

Returns the title of the App.

Returns

Title of the App

getWindow()

auto ns::App::getWindow

(

)

-> AppWindow &

Get the AppWindow.

Returns

Reference to the AppWindow

onEvent()

void ns::App::onEvent ( const sf::Event &  event )

overrideprotectedvirtual

Handles SFML events.

Virtual method, can be defined by the user. onEvent will be called each time a window event occurs.

Parameters

event

The sf::Event that happened

Reimplemented from ns::AppStateInterface.

update()

void ns::App::update ( )

overrideprotectedvirtual

App update method.

Pure virtual method, has to be defined by the user. update will be called as many times it needs to match the ups (update per second) parameter

Reimplemented from ns::AppStateInterface.

Reimplemented in ns::StateStackApp, and ns::StateMachineApp.

---

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

• App.hpp