#include <Transform.h>

Inheritance diagram for Transform:

Collaboration diagram for Transform:

Public Member Functions
	Transform ()
	Transform (const Transform &)
	Transform (Transform &&) noexcept
auto	operator= (const Transform &rhs) -> Transform &=default
	~Transform () override=default
auto	parentTo (GameObject *newParent) -> bool override
	Sets the GameObject as a child of another GameObject.
auto	clone () const -> std::unique_ptr< GameObject > override
	makes a copy a GameObject even if it's held polymorphically
void	markDirty ()
	top ten ways to make the engine do extra work
auto	componentShowMenu () -> void override
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.
auto	move (float x, float y) -> void
auto	move (const Vector4D &vec) -> void
auto	x () const -> float
auto	y () const -> float
auto	z () const -> float
auto	setX (float x) -> void
auto	setY (float y) -> void
auto	setZ (float z) -> void
auto	adjustScale (float x, float y) -> void
auto	scale () const -> const Vector4D &
	Get the local scale ( this is normally what you want).
auto	scale (const Vector4D &scale) -> void
	set the local scale ( this is normally what you want to do)
auto	scale (float x, float y) -> void
	Set the local scale without overriding the z layer (this is also normally what you want to do).
auto	worldScale () -> Vector4D
	get the world scale (mostly accurate)
auto	worldScale (const Vector4D &scale) -> void
	set the world scale
auto	translation () const -> const Point2D &
	get the local translation (this is normally what you want)
auto	translation (const Vector4D &translation) -> void
	set the local translation (this is what you normally want to do)
auto	translation (float x, float y) -> void
	set the local translation without overriding the z layer (this also is what you normally want to do)
auto	worldTranslation () -> Point2D
	get the world translation
auto	worldTranslation (const Point2D &translation) -> void
	set the world translation
auto	rotation () const -> float
	get the local rotation in degrees (this is what you normally want to do)
auto	rotation (float rotation) -> void
	set the local rotation in degrees (this is what you normally want to do)
auto	worldRotation () -> float
	get the world rotation in degrees
auto	worldRotation (float rotation) -> void
	set the world rotation in degrees
auto	matrix () -> AffineMatrix &
	get the world modeling matrix ( this is normally what you want )
auto	setMatrix (AffineMatrix &newMat) -> void
auto	makeMat3Rotation (float rotation) -> Eigen::Matrix3f
auto	setRotationViaMatrix (AffineMatrix &newMat) -> void
Public Member Functions inherited from Component
auto	getType () const -> ComponentTypeEnum
auto	getKey () const -> Key override
	Generates a unique Key that corresponds to the GameObject.
auto	showMenu () -> void override
	Called before update each frame, for calling ImGui editor code relevant to the gameObject.
auto	getEntityParent () const -> Entity *
	gets the parent as an Entity.
auto	pop () const -> std::unique_ptr< Component >
	Removes the Component from its Entity parent, and gives ownership to the caller.
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	getParent () const -> GameObject *
	Gets the parent of a 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 () -> ComponentTypeEnum
static auto	bindLuaTypes (sol::state &lua) -> void

Private Member Functions
auto	recalculateMatrix () -> void
	helper function for recalculating internal Matrix
auto	getParentTransform () const -> Transform *
	helper for grabbing parent transform
auto	calculateAbsoluteMatrix () -> bool
	computes the absolute matrix, by getting parent entity's transform @precondition calculateInternalMatrix should be called before this, if the absolute matrix is dirty
auto	getWorldRotationAndScale () -> Eigen::Matrix3f
	helper for getting approximate world scale
auto	setGlobalRotationAndScale (const Eigen::Matrix3f &) -> void
	helper for setting rotation and scale based on a world rotation and scale matrix

Private Attributes
Vector4D	_scale
Point2D	_translation
float	_rotation
bool	isDirty
	True if the transformation matrix needs to be recalculated.
bool	lockedScale
	Whether to lock x and y scale when editing it in the editor.
AffineMatrix	_matrix
	The transformation matrix resulting from concatenating the matrices Formed by scalerotationtranslation matrices.
AffineMatrix	_absoluteMatrix
	A matrix that holds the absolute transform of the component, after offsetting from parent Entities.

Friends
auto	to_json (json &j, const Transform &p) ->void
auto	from_json (const json &j, Transform &p) ->void

Additional Inherited Members
Public Types inherited from Component
enum	ComponentTypeEnum : unsigned short { cErrorType = 0 , cNewComponentStub = 1 }
	This enum lists out every type of component we have. More...
Public Attributes inherited from GameObject
friend	Entity
friend	Node
friend	Engine
Protected Member Functions inherited from Component
	Component (ComponentTypeEnum type, const char *typeName)
auto	getComponentJson () const -> json
auto	getChildren () const -> std::shared_ptr< std::vector< GameObject * > > override
	override for component to return a vector of no children
Protected Member Functions inherited from GameObject
auto	setInternalParent (GameObject *parent) -> bool
	sets the internal parent of a GameObject directly, avoiding abstractions provided by ParentTo().
auto	checkAddToSceneHook () -> void
	Determine if the GameObject was recently added to the engine, and if it was, call onEngineEnter.

Constructor & Destructor Documentation

◆ Transform() [1/3]

Transform::Transform ( )

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Transform() [2/3]

Transform::Transform ( const Transform & rhs )

Here is the call graph for this function:

◆ Transform() [3/3]

Transform::Transform ( Transform && rhs )

noexcept

Here is the call graph for this function:

◆ ~Transform()

Transform::~Transform ( )

overridedefault

Here is the call graph for this function:

Member Function Documentation

◆ adjustScale()

auto Transform::adjustScale	(	float	x,
		float	y )->void

Here is the call graph for this function:

◆ bindLuaTypes()

auto Transform::bindLuaTypes ( sol::state & lua ) ->void

static

Here is the call graph for this function:

◆ calculateAbsoluteMatrix()

auto Transform::calculateAbsoluteMatrix ( ) ->bool

private

computes the absolute matrix, by getting parent entity's transform @precondition calculateInternalMatrix should be called before this, if the absolute matrix is dirty

Returns: false if can't calculate absolute matrix, true if success

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone()

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

overridevirtual

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:

Here is the caller graph for this function:

◆ componentShowMenu()

auto Transform::componentShowMenu ( ) ->void

overridevirtual

Reimplemented from Component.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ endWindow()

auto Transform::endWindow ( ) ->void

inlineoverridevirtual

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

Implements GameObject.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEnum()

auto Transform::getEnum ( ) ->ComponentTypeEnum

inlinestatic

◆ getParentTransform()

auto Transform::getParentTransform ( ) const->Transform *

private

helper for grabbing parent transform

Returns: pointer to parent transform, or nullptr if there isn't one

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getWorldRotationAndScale()

auto Transform::getWorldRotationAndScale ( ) ->Eigen::Matrix3f

private

helper for getting approximate world scale

Returns: scale representing world rotation and scale (but not translation)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ load()

auto Transform::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.

◆ makeMat3Rotation()

auto Transform::makeMat3Rotation ( float rotation ) ->Eigen::Matrix3f

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markDirty()

void Transform::markDirty ( )

top ten ways to make the engine do extra work

Here is the call graph for this function:

Here is the caller graph for this function:

◆ matrix()

auto Transform::matrix ( ) ->AffineMatrix &

get the world modeling matrix ( this is normally what you want )

Here is the call graph for this function:

Here is the caller graph for this function:

◆ move() [1/2]

auto Transform::move ( const Vector4D & vec ) ->void

Here is the call graph for this function:

◆ move() [2/2]

auto Transform::move	(	float	x,
		float	y )->void

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onRender()

auto Transform::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.

Here is the call graph for this function:

◆ onUpdate()

auto Transform::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.

Here is the caller graph for this function:

◆ operator=()

auto Transform::operator= ( const Transform & rhs ) ->Transform &=default

default

Here is the call graph for this function:

◆ parentTo()

auto Transform::parentTo ( GameObject * newParent ) ->bool

overridevirtual

Sets the GameObject as a child of another GameObject.

calls setInternalParent() by default, but can be overriden by GameObjects complicated parent requirements, like Entity. Validates pointer and requires type to be valid

Parameters

newParent the GameObject that this GameObject will be a child of

Returns: whether parenting succeeded

calls setInternalParent() by default, can be overriden by complicated parent requirements, like Entity. Validates pointer and requires type to be valid

Parameters

newParent the GameObject to parent to

Returns: whether parenting succeeded

Reimplemented from GameObject.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ recalculateMatrix()

auto Transform::recalculateMatrix ( ) ->void

private

helper function for recalculating internal Matrix

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rotation() [1/2]

auto Transform::rotation ( ) const->float

get the local rotation in degrees (this is what you normally want to do)

Here is the caller graph for this function:

◆ rotation() [2/2]

auto Transform::rotation ( float rotation ) ->void

set the local rotation in degrees (this is what you normally want to do)

Here is the call graph for this function:

◆ save()

auto Transform::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.

◆ scale() [1/3]

auto Transform::scale ( ) const->constVector4D &

Get the local scale ( this is normally what you want).

Here is the caller graph for this function:

◆ scale() [2/3]

auto Transform::scale ( const Vector4D & scale ) ->void

set the local scale ( this is normally what you want to do)

Here is the call graph for this function:

◆ scale() [3/3]

auto Transform::scale	(	float	x,
		float	y )->void

Set the local scale without overriding the z layer (this is also normally what you want to do).

Here is the call graph for this function:

◆ setGlobalRotationAndScale()

auto Transform::setGlobalRotationAndScale ( const Eigen::Matrix3f & rotationAndScale ) ->void

private

helper for setting rotation and scale based on a world rotation and scale matrix

Parameters

rotationAndScale a matrix representing the world rotation and scale to set. The function will decompose this into local rotation and scale, and set those.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMatrix()

auto Transform::setMatrix ( AffineMatrix & newMat ) ->void

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRotationViaMatrix()

auto Transform::setRotationViaMatrix ( AffineMatrix & newMat ) ->void

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setX()

auto Transform::setX ( float x ) ->void

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setY()

auto Transform::setY ( float y ) ->void

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setZ()

auto Transform::setZ ( float z ) ->void

Here is the call graph for this function:

Here is the caller graph for this function:

◆ translation() [1/3]

auto Transform::translation ( ) const->constPoint2D &

get the local translation (this is normally what you want)

Here is the caller graph for this function:

◆ translation() [2/3]

auto Transform::translation ( const Vector4D & translation ) ->void

set the local translation (this is what you normally want to do)

Here is the call graph for this function:

◆ translation() [3/3]

auto Transform::translation	(	float	x,
		float	y )->void

set the local translation without overriding the z layer (this also is what you normally want to do)

Here is the call graph for this function:

◆ worldRotation() [1/2]

auto Transform::worldRotation ( ) ->float

get the world rotation in degrees

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worldRotation() [2/2]

auto Transform::worldRotation ( float rotation ) ->void

set the world rotation in degrees

Here is the call graph for this function:

◆ worldScale() [1/2]

auto Transform::worldScale ( ) ->Vector4D

get the world scale (mostly accurate)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worldScale() [2/2]

auto Transform::worldScale ( const Vector4D & scale ) ->void

set the world scale

Here is the call graph for this function:

◆ worldTranslation() [1/2]

auto Transform::worldTranslation ( ) ->Point2D

get the world translation

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worldTranslation() [2/2]

auto Transform::worldTranslation ( const Point2D & translation ) ->void

set the world translation

Here is the call graph for this function:

◆ x()

auto Transform::x ( ) const->float

Here is the caller graph for this function:

◆ y()

auto Transform::y ( ) const->float

Here is the caller graph for this function:

◆ z()

auto Transform::z ( ) const->float

Here is the caller graph for this function:

◆ from_json

auto from_json	(	const json &	j,
		Transform &	p )->void

friend

◆ to_json

auto to_json	(	json &	j,
		const Transform &	p )->void

friend

Member Data Documentation

◆ _absoluteMatrix

AffineMatrix Transform::_absoluteMatrix

private

A matrix that holds the absolute transform of the component, after offsetting from parent Entities.

◆ _matrix

AffineMatrix Transform::_matrix

private

The transformation matrix resulting from concatenating the matrices Formed by scale*rotation*translation matrices.

◆ _rotation

float Transform::_rotation

private

◆ _scale

Vector4D Transform::_scale

private

◆ _translation

Point2D Transform::_translation

private

◆ isDirty

bool Transform::isDirty

private

True if the transformation matrix needs to be recalculated.

◆ lockedScale

bool Transform::lockedScale

private

Whether to lock x and y scale when editing it in the editor.

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

/home/egrazil/sites/Brunot/The House/source/Component/Transform.h
/home/egrazil/sites/Brunot/The House/source/Component/Transform.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ Transform() [1/3]

◆ Transform() [2/3]

◆ Transform() [3/3]

◆ ~Transform()

Member Function Documentation

◆ adjustScale()

◆ bindLuaTypes()

◆ calculateAbsoluteMatrix()

◆ clone()

◆ componentShowMenu()

◆ endWindow()

◆ getEnum()

◆ getParentTransform()

◆ getWorldRotationAndScale()

◆ load()

◆ makeMat3Rotation()

◆ markDirty()

◆ matrix()

◆ move() [1/2]

◆ move() [2/2]

◆ onRender()

◆ onUpdate()

◆ operator=()

◆ parentTo()

◆ recalculateMatrix()

◆ rotation() [1/2]

◆ rotation() [2/2]

◆ save()

◆ scale() [1/3]

◆ scale() [2/3]

◆ scale() [3/3]

◆ setGlobalRotationAndScale()

◆ setMatrix()

◆ setRotationViaMatrix()

◆ setX()

◆ setY()

◆ setZ()

◆ translation() [1/3]

◆ translation() [2/3]

◆ translation() [3/3]

◆ worldRotation() [1/2]

◆ worldRotation() [2/2]

◆ worldScale() [1/2]

◆ worldScale() [2/2]

◆ worldTranslation() [1/2]

◆ worldTranslation() [2/2]

◆ x()

◆ y()

◆ z()

Friends And Related Symbol Documentation

◆ from_json

◆ to_json

Member Data Documentation

◆ _absoluteMatrix

◆ _matrix

◆ _rotation

◆ _scale

◆ _translation

◆ isDirty

◆ lockedScale