#include <Camera.h>

Inheritance diagram for sys::Camera:

Collaboration diagram for sys::Camera:

Public Member Functions
	Camera ()
	~Camera () override=default
	Camera (const Camera &other)=default
	Camera (Camera &&other) noexcept
auto	operator= (const Camera &other) -> Camera &
auto	operator= (Camera &&other) noexcept -> Camera &=default
auto	clone () const -> std::unique_ptr< GameObject > override
	makes a copy a GameObject even if it's held polymorphically
auto	onUpdate (float dt) -> void override
	called once every frame.
auto	endWindow () -> void override
	currently unused, but intended to but was assumed to be necessary for a proper ImGui editor
auto	onRender () -> void override
	called every frame after update has been called for every object.
auto	load (const Stream &stream) -> void override
	Implementations will load the state of a GameObject from a th::Json Object.
auto	save (Stream &stream) const -> void override
	Implementations will load the state of a GameObject to a th::Json object.
Public Member Functions inherited from System
auto	showMenu () -> void override
	Called before update each frame, for calling ImGui editor code relevant to the gameObject.
auto	getKey () const -> Key override
	Generates a unique Key that corresponds to the GameObject.
auto	getParent () const -> GameObject *override
	Gets the parent of a GameObject.
Public Member Functions inherited from GameObject
	GameObject (std::string typeName, gobj::Type parentType, gobj::Type type)
	constructor for gameobject.
virtual	~GameObject ()
	destructor for GameObject.
	GameObject (const GameObject &other)
	Copy Constructor.
auto	operator= (const GameObject &other) -> GameObject &
	copy assignment operator
	GameObject (GameObject &&other) noexcept
	Move constructor.
auto	operator= (GameObject &&other) noexcept -> GameObject &
	Move assignment operator.
virtual auto	update (float dt) -> void
	called once every frame.
virtual auto	render () -> void
	called every frame after update has been called for every object.
virtual auto	destroy () -> void
	Marks an GameObject to be destroyed.
virtual auto	onEnterEngine () -> void
	hook that is called when a GameObject enters the Engine tree.
virtual auto	onSceneStart (const std::string &sceneName) -> void
	Hook that is called before the first frame a scene is run, but after the entire scene is loaded into the engine To receive the hook, simply override the function in your class.
virtual auto	onSceneExit (const std::string &sceneName) -> void
	Hook that is called right before a scene is unloaded To receive the hook, simply override the function in your class.
virtual auto	for_each (std::function< void(GameObject &)> func) -> void
	applies a function to every child.
virtual auto	for_each (std::function< void(const GameObject &)> func) const -> void
	applies a const function to every child.
virtual auto	parentTo (GameObject *newParent) -> bool
	Sets the GameObject as a child of another GameObject.
auto	getInternalParent () const -> GameObject *
	returns the actual owning parent of the GameObject
virtual auto	addChild (std::unique_ptr< GameObject > newChild) -> bool
	Adds a child to a GameObject.
auto	addChildLua (std::unique_ptr< GameObject > &newChild) -> bool
	for lua
auto	destroyed () const -> bool
auto	getUUID () const -> gobj::UUID
auto	coolerGetUUID () const -> unsigned int
auto	isUUID (gobj::UUID compareUUID) const -> bool
auto	getName () const -> const std::string &
	Gets the type of the object as a string.
auto	getNickname () const -> const std::string &
	Gets the nickname (custom, writable name) of a GameObject.
auto	getFormattedName () const -> const std::string &
	combines a GameObjects Type, Nickname, and UUID into one string, for use with logging.
auto	nameEquals (const std::string &compareString) const -> bool
	check whether a GameObjects typeName is equivilent to a given string.
auto	isType (gobj::Type otherType) const -> bool
	check whether the GameObject is the same as a given type.
auto	getObjectType () const -> gobj::Type
	gets the internal type of the GameObject, as an enum
auto	setNickname (const std::string &newNickname) -> void
	sets the GameObjects nickname.
auto	updates () const -> bool
auto	renders () const -> bool
auto	receivesMessages () const -> bool
auto	isActive () const -> bool
virtual auto	setShouldUpdate (bool _shouldUpdate) -> void
	set whether the GameObject should update every frame, and whether all of it's children should update every frame
virtual auto	setShouldRender (bool _shouldRender) -> void
	set whether the GameObject should render every frame, and whether all of it's children should render every frame
virtual auto	setShouldReceiveMessages (bool _shouldReceiveMessages) -> void
	set whether the GameObject should Receive Messags, and whether all of it's children should receive messages
auto	setActive (bool shouldBeActive) -> void
	set the GameObject should update, render, and receive messages
auto	getGameObjectJson () const -> json
	Used for serializing GameObjects.
auto	setGameObjectJson (const json &stream) -> void
	used for deserializing GameObjects

Static Public Member Functions
static auto	getEnum () -> Type
	function required by all systems
static auto	init (GLFWwindow *window, int width, int height) -> void
static auto	view () -> const Eigen::Matrix4f &
	gets the view transform for the camera
static auto	projection () -> const Eigen::Matrix4f &
	Gets the orthogonal projection matrix for the camera.
static auto	screen () -> const Eigen::Matrix4f &
static void	calculateAllTransforms (int width, int height)
	helper function to update all the camera transforms based on camera's position, and new width and height

Static Public Attributes
static float	farPlane = 1000.f
static float	nearPlane = -1000.f

Protected Member Functions
auto	systemShowMenu () -> void override
	Specific systems should override this function to show their specific menu for the system.
Protected Member Functions inherited from System
	System (const std::string &typeName, Type systemType)
Protected Member Functions inherited from GameObject
auto	setInternalParent (GameObject *parent) -> bool
	sets the internal parent of a GameObject directly, avoiding abstractions provided by ParentTo().
virtual auto	getChildren () const -> std::shared_ptr< std::vector< GameObject * > >
	gets a vector of a GameObjects public (i.e.
auto	checkAddToSceneHook () -> void
	Determine if the GameObject was recently added to the engine, and if it was, call onEngineEnter.

Static Private Member Functions
static auto	resizeViewport (GLFWwindow *window, int width, int height) -> void
	callback function that opengl calls when the window resizes
static auto	calculateProjection (int width, int height, Eigen::Vector3f cameraPos) -> void
	helper function to calculate the projection matrix transform
static auto	calculateScreen (int w, int h) -> void
	helper function to calculate the screen matrix transform
static auto	lookAt (const Eigen::Vector3f &eye, const Eigen::Vector3f center, const Eigen::Vector3f up) -> Eigen::Matrix4f
	calculate the camera matrix transform, based on pointing to a specific object

Static Private Attributes
static Eigen::Matrix4f	viewTransform
	the world to camera space transform
static Eigen::Matrix4f	projectionTransform
	the camera space to NDC transform
static Eigen::Matrix4f	NDCToScreen
	the NDC to screen transform

Additional Inherited Members
Public Types inherited from System
enum class	Type : unsigned short { system_error_type = 0 , newSystemStub = 100 , OpenGL = 200 , Input = 300 , Editor = 400 , Messaging = 500 , Camera = 600 , Logging = 700 , AudioSystem = 750 , Scoring = 800 , HandSystem = 900 , PlayerTurn = 950 , Table = 960 , SceneManager = 1000 , ScriptingManager = 1050 , Particles = 1075 , ActionList = 1100 , DebugDraw = 1150 , ColliderSystem = 1300 , Options = 1400 , GameRules = 1500 , TestRunner = 64'000 }
Public Attributes inherited from GameObject
friend	Entity
friend	Node
friend	Engine

Constructor & Destructor Documentation

◆ Camera() [1/3]

sys::Camera::Camera ( )

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~Camera()

sys::Camera::~Camera ( )

overridedefault

◆ Camera() [2/3]

sys::Camera::Camera ( const Camera & other )

default

Here is the call graph for this function:

◆ Camera() [3/3]

sys::Camera::Camera ( Camera && other )

noexcept

Here is the call graph for this function:

Member Function Documentation

◆ calculateAllTransforms()

void sys::Camera::calculateAllTransforms	(	int	width,
		int	height )

static

helper function to update all the camera transforms based on camera's position, and new width and height

Parameters

width	the width of the viewport, in pixels (get this from opengl)
height	the height of the viewport, in pixels (get this from opengl)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateProjection()

auto sys::Camera::calculateProjection	(	int	width,
		int	height,
		Eigen::Vector3f	cameraPos )->void

staticprivate

helper function to calculate the projection matrix transform

Parameters

width	width in pixels of the window
height	height in pixels of the window
cameraPos	where the camera is

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateScreen()

auto sys::Camera::calculateScreen	(	int	w,
		int	h )->void

staticprivate

helper function to calculate the screen matrix transform

Parameters

width	width in pixels of the window
height	height in pixels of the window

Here is the caller graph for this function:

◆ clone()

auto sys::Camera::clone ( ) const->std::unique_ptr< GameObject >

inlineoverridevirtual

makes a copy a GameObject even if it's held polymorphically

Warning: When overriding this function, make sure to set the parents object to this

Returns: a unique_ptr to a new stack allocated object that is a copy of the object

Implements GameObject.

Here is the call graph for this function:

◆ endWindow()

auto sys::Camera::endWindow ( ) ->void

inlineoverridevirtual

currently unused, but intended to but was assumed to be necessary for a proper ImGui editor

Implements GameObject.

◆ getEnum()

auto sys::Camera::getEnum ( ) ->Type

inlinestatic

function required by all systems

◆ init()

auto sys::Camera::init	(	GLFWwindow *	window,
		int	width,
		int	height )->void

static

Here is the call graph for this function:

Here is the caller graph for this function:

◆ load()

auto sys::Camera::load ( const Stream & stream ) ->void

overridevirtual

Implementations will load the state of a GameObject from a th::Json Object.

Unimplemented in GameObject

Parameters

stream th::Json Object

Implements GameObject.

◆ lookAt()

auto sys::Camera::lookAt	(	const Eigen::Vector3f &	eye,
		const Eigen::Vector3f	center,
		const Eigen::Vector3f	up )->Eigen::Matrix4f

staticprivate

calculate the camera matrix transform, based on pointing to a specific object

Parameters

eye	where the cameras is
center	where the camera should look to
up	the relative up vector of the camera

Returns: a world to camera transform

Here is the caller graph for this function:

◆ onRender()

auto sys::Camera::onRender ( ) ->void

overridevirtual

called every frame after update has been called for every object.

Generally used for rendering an object to the screen, when applicable. Unimplemented in GameObject

Implements GameObject.

◆ onUpdate()

auto sys::Camera::onUpdate ( float dt ) ->void

overridevirtual

called once every frame.

Generally used for timers, movement, condition checks, etc. Unimplemented in GameObject

Parameters

dt	the time in seconds that has elapsed

Implements GameObject.

◆ operator=() [1/2]

auto sys::Camera::operator= ( Camera && other ) ->Camera &=default

defaultnoexcept

Here is the call graph for this function:

◆ operator=() [2/2]

auto sys::Camera::operator= ( const Camera & other ) ->Camera &

Here is the call graph for this function:

◆ projection()

auto sys::Camera::projection ( ) ->constEigen::Matrix4f &

static

Gets the orthogonal projection matrix for the camera.

Returns: an Eigen Mat4 const ref

Here is the caller graph for this function:

◆ resizeViewport()

auto sys::Camera::resizeViewport	(	GLFWwindow *	window,
		int	width,
		int	height )->void

staticprivate

callback function that opengl calls when the window resizes

Parameters

window	the window that is being resized. we ignore this as we only have one window
width	width in pixels of the window
height	height in pixels of the window

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

auto sys::Camera::save ( Stream & stream ) const->void

overridevirtual

Implementations will load the state of a GameObject to a th::Json object.

Unimplemented in GameObject

Parameters

stream th::Json Object

Implements GameObject.

◆ screen()

auto sys::Camera::screen ( ) ->constEigen::Matrix4f &

static

Here is the caller graph for this function:

◆ systemShowMenu()

void sys::Camera::systemShowMenu ( ) ->void

overrideprotectedvirtual

Specific systems should override this function to show their specific menu for the system.

Reimplemented from System.

◆ view()

auto sys::Camera::view ( ) ->constEigen::Matrix4f &

static

gets the view transform for the camera

Returns: an Eigen Mat4 const ref

Here is the caller graph for this function:

Member Data Documentation

◆ farPlane

float sys::Camera::farPlane = 1000.f

static

◆ NDCToScreen

Eigen::Matrix4f sys::Camera::NDCToScreen

staticprivate

the NDC to screen transform

◆ nearPlane

float sys::Camera::nearPlane = -1000.f

static

◆ projectionTransform

Eigen::Matrix4f sys::Camera::projectionTransform

staticprivate

the camera space to NDC transform

◆ viewTransform

Eigen::Matrix4f sys::Camera::viewTransform

staticprivate

the world to camera space transform

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

/home/egrazil/sites/Brunot/The House/source/System/Camera.h
/home/egrazil/sites/Brunot/The House/source/System/Camera.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Private Member Functions

Static Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Camera() [1/3]

◆ ~Camera()

◆ Camera() [2/3]

◆ Camera() [3/3]

Member Function Documentation

◆ calculateAllTransforms()

◆ calculateProjection()

◆ calculateScreen()

◆ clone()

◆ endWindow()

◆ getEnum()

◆ init()

◆ load()

◆ lookAt()

◆ onRender()

◆ onUpdate()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ projection()

◆ resizeViewport()

◆ save()

◆ screen()

◆ systemShowMenu()

◆ view()

Member Data Documentation

◆ farPlane

◆ NDCToScreen

◆ nearPlane

◆ projectionTransform

◆ viewTransform