#include <TransformComponent.h>

Inheritance diagram for Divide::TransformComponent:

Public Types
enum class	ScalingMode : U8 { UNIFORM = 0u , NON_UNIFORM }

Public Member Functions
	TransformComponent (SceneGraphNode *parentSGN, PlatformContext &context)

void	reset ()

void	getWorldMatrix (mat4< F32 > &matOut) const

void	getWorldMatrixInterpolated (mat4< F32 > &matrixOut) const

mat4< F32 >	getWorldMatrix () const

mat4< F32 >	getWorldMatrixInterpolated () const

void	getLocalRotationMatrix (mat4< F32 > &matOut) const

void	getLocalRotationMatrixInterpolated (mat4< F32 > &matOut) const

void	getWorldRotationMatrix (mat4< F32 > &matOut) const

void	getWorldRotationMatrixInterpolated (mat4< F32 > &matOut) const

void	setPosition (const vec3< F32 > &position) override
	Component <-> Transform interface.

void	setPosition (F32 x, F32 y, F32 z) override
	Set the local X,Y and Z position.

void	setPositionX (F32 positionX) override
	Set the object's position on the X axis.

void	setPositionY (F32 positionY) override
	Set the object's position on the Y axis.

void	setPositionZ (F32 positionZ) override
	Set the object's position on the Z axis.

void	translate (const vec3< F32 > &axisFactors) override
	Add the specified translation factors to the current local position.

void	setScale (const vec3< F32 > &amount) override
	Set the local X,Y and Z scale factors.

void	setScaleX (F32 amount) override
	Set the scaling factor on the X axis.

void	setScaleY (F32 amount) override
	Set the scaling factor on the Y axis.

void	setScaleZ (F32 amount) override
	Set the scaling factor on the Z axis.

void	scale (const vec3< F32 > &axisFactors) override
	Add the specified scale factors to the current local position.

void	scaleX (F32 amount) override
	Increase the scaling factor on the X axis by the specified factor.

void	scaleY (F32 amount) override
	Increase the scaling factor on the Y axis by the specified factor.

void	scaleZ (F32 amount) override
	Increase the scaling factor on the Z axis by the specified factor.

void	setRotation (const vec3< F32 > &axis, Angle::DEGREES< F32 > degrees) override

void	setRotation (Angle::DEGREES< F32 > pitch, Angle::DEGREES< F32 > yaw, Angle::DEGREES< F32 > roll) override

void	setRotation (const Quaternion< F32 > &quat) override
	Set the local orientation so that it matches the specified quaternion.

void	setRotationX (Angle::DEGREES< F32 > angle) override

void	setRotationY (Angle::DEGREES< F32 > angle) override

void	setRotationZ (Angle::DEGREES< F32 > angle) override

void	rotate (const vec3< F32 > &axis, Angle::DEGREES< F32 > degrees) override

void	rotate (Angle::DEGREES< F32 > pitch, Angle::DEGREES< F32 > yaw, Angle::DEGREES< F32 > roll) override

void	rotate (const Quaternion< F32 > &quat) override
	Apply the specified Quaternion rotation starting from the current orientation.

void	rotateSlerp (const Quaternion< F32 > &quat, D64 deltaTime) override
	Perform a SLERP rotation towards the specified quaternion.

void	rotateX (Angle::DEGREES< F32 > angle) override
	Rotate on the X axis (Axis-Angle used) by the specified angle (either degrees or radians)

void	rotateY (Angle::DEGREES< F32 > angle) override
	Rotate on the Y axis (Axis-Angle used) by the specified angle (either degrees or radians)

void	rotateZ (Angle::DEGREES< F32 > angle) override
	Rotate on the Z axis (Axis-Angle used) by the specified angle (either degrees or radians)

const vec3< F32 >	getLocalDirection (const vec3< F32 > &worldForward=WORLD_Z_NEG_AXIS) const

const vec3< F32 >	getWorldDirection (const vec3< F32 > &worldForward=WORLD_Z_NEG_AXIS) const

void	setDirection (const vec3< F32 > &fwdDirection, const vec3< F32 > &upDirection=WORLD_Y_AXIS)
	Sets a new, local only, direction for the current component based on the specified world forward direction.

void	setTransform (const TransformValues &values)

bool	isUniformScaled () const noexcept

vec3< F32 >	getWorldPosition () const
	Return the position.

vec3< F32 >	getLocalPosition () const
	Return the local position.

vec3< F32 >	getWorldPositionInterpolated () const
	Return the position.

vec3< F32 >	getLocalPositionInterpolated () const
	Return the local position.

vec3< F32 >	getFwdVector () const
	Return the derived forward direction.

vec3< F32 >	getUpVector () const
	Return the derived up direction.

vec3< F32 >	getRightVector () const
	Return the derived right direction.

vec3< F32 >	getWorldScale () const
	Return the scale factor.

vec3< F32 >	getLocalScale () const
	Return the local scale factor.

vec3< F32 >	getWorldScaleInterpolated () const
	Return the scale factor.

vec3< F32 >	getLocalScaleInterpolated () const
	Return the local scale factor.

Quaternion< F32 >	getWorldOrientation () const
	Return the orientation quaternion.

Quaternion< F32 >	getLocalOrientation () const
	Return the local orientation quaternion.

Quaternion< F32 >	getWorldOrientationInterpolated () const
	Return the orientation quaternion.

Quaternion< F32 >	getLocalOrientationInterpolated () const
	Return the local orientation quaternion.

void	getWorldTransforms (vec3< F32 > &positionOut, vec3< F32 > &scaleOut, Quaternion< F32 > &rotationOut)

void	getWorldTransformsInterpolated (vec3< F32 > &positionOut, vec3< F32 > &scaleOut, Quaternion< F32 > &rotationOut)

void	setTransforms (const mat4< F32 > &transform)

TransformValues	getLocalValues () const

void	pushTransforms ()

bool	popTransforms ()

void	resetCache ()

void	setOffset (bool state, const mat4< F32 > &offset=mat4< F32 >()) noexcept

bool	saveCache (ByteBuffer &outputBuffer) const override

bool	loadCache (ByteBuffer &inputBuffer) override

	PROPERTY_R_IW (TransformValues, cachedDerivedTransform)

	PROPERTY_RW (bool, editorLockPosition, false)

	PROPERTY_RW (bool, editorLockRotation, false)

	PROPERTY_RW (bool, editorLockScale, false)

	PROPERTY_RW (ScalingMode, scalingMode, ScalingMode::UNIFORM)

	PROPERTY_R_IW (mat4< F32 >, localMatrix, MAT4_IDENTITY)

	PROPERTY_R_IW (mat4< F32 >, localMatrixInterpolated, MAT4_IDENTITY)

virtual void	setPosition (const vec3< F32 > &position)=0
	Set the local X,Y and Z position.

virtual void	setPosition (F32 x, F32 y, F32 z)=0
	Set the local X,Y and Z position.

virtual void	setScale (const vec3< F32 > &amount)=0
	Set the local X,Y and Z scale factors.

void	setScale (F32 amount)
	Set an uniform scale on all three axis.

void	setScale (F32 x, F32 y, F32 z)
	Set a scaling factor for each axis.

virtual void	setRotation (const vec3< F32 > &axis, Angle::DEGREES< F32 > degrees)=0

virtual void	setRotation (Angle::DEGREES< F32 > pitch, Angle::DEGREES< F32 > yaw, Angle::DEGREES< F32 > roll)=0

virtual void	setRotation (const Quaternion< F32 > &quat)=0
	Set the local orientation so that it matches the specified quaternion.

virtual void	rotate (const vec3< F32 > &axis, Angle::DEGREES< F32 > degrees)=0

virtual void	rotate (Angle::DEGREES< F32 > pitch, Angle::DEGREES< F32 > yaw, Angle::DEGREES< F32 > roll)=0

virtual void	rotate (const Quaternion< F32 > &quat)=0
	Apply the specified Quaternion rotation starting from the current orientation.

void	rotate (F32 xAxis, F32 yAxis, F32 zAxis, Angle::DEGREES< F32 > degrees)
	Apply an axis-angle rotation.

void	rotate (const vec3< F32 > &euler)
	Apply an euler rotation.

Public Member Functions inherited from Divide::ITransform
virtual	~ITransform ()=default

virtual void	setPosition (const vec3< F32 > &position)=0
	Set the local X,Y and Z position.

virtual void	setPosition (F32 x, F32 y, F32 z)=0
	Set the local X,Y and Z position.

virtual void	setPositionX (F32 positionX)=0
	Set the object's position on the X axis.

virtual void	setPositionY (F32 positionY)=0
	Set the object's position on the Y axis.

virtual void	setPositionZ (F32 positionZ)=0
	Set the object's position on the Z axis.

virtual void	translate (const vec3< F32 > &axisFactors)=0
	Add the specified translation factors to the current local position.

virtual void	setScale (const vec3< F32 > &amount)=0
	Set the local X,Y and Z scale factors.

virtual void	setScaleX (F32 amount)=0
	Set the scaling factor on the X axis.

virtual void	setScaleY (F32 amount)=0
	Set the scaling factor on the Y axis.

virtual void	setScaleZ (F32 amount)=0
	Set the scaling factor on the Z axis.

virtual void	scale (const vec3< F32 > &axisFactors)=0
	Add the specified scale factors to the current local position.

virtual void	scaleX (F32 amount)=0
	Increase the scaling factor on the X axis by the specified factor.

virtual void	scaleY (F32 amount)=0
	Increase the scaling factor on the Y axis by the specified factor.

virtual void	scaleZ (F32 amount)=0
	Increase the scaling factor on the Z axis by the specified factor.

virtual void	setRotation (const vec3< F32 > &axis, Angle::DEGREES< F32 > degrees)=0

virtual void	setRotation (Angle::DEGREES< F32 > pitch, Angle::DEGREES< F32 > yaw, Angle::DEGREES< F32 > roll)=0

virtual void	setRotation (const Quaternion< F32 > &quat)=0
	Set the local orientation so that it matches the specified quaternion.

virtual void	setRotationX (Angle::DEGREES< F32 > angle)=0

virtual void	setRotationY (Angle::DEGREES< F32 > angle)=0

virtual void	setRotationZ (Angle::DEGREES< F32 > angle)=0

virtual void	rotate (const vec3< F32 > &axis, Angle::DEGREES< F32 > degrees)=0

virtual void	rotate (Angle::DEGREES< F32 > pitch, Angle::DEGREES< F32 > yaw, Angle::DEGREES< F32 > roll)=0

virtual void	rotate (const Quaternion< F32 > &quat)=0
	Apply the specified Quaternion rotation starting from the current orientation.

virtual void	rotateSlerp (const Quaternion< F32 > &quat, D64 deltaTime)=0
	Perform a SLERP rotation towards the specified quaternion.

virtual void	rotateX (Angle::DEGREES< F32 > angle)=0
	Rotate on the X axis (Axis-Angle used) by the specified angle (either degrees or radians)

virtual void	rotateY (Angle::DEGREES< F32 > angle)=0
	Rotate on the Y axis (Axis-Angle used) by the specified angle (either degrees or radians)

virtual void	rotateZ (Angle::DEGREES< F32 > angle)=0
	Rotate on the Z axis (Axis-Angle used) by the specified angle (either degrees or radians)

void	setScale (F32 amount)
	Set an uniform scale on all three axis.

void	setScale (F32 x, F32 y, F32 z)
	Set a scaling factor for each axis.

void	setRotationEuler (const vec3< F32 > &euler)
	Set the euler rotation in degrees.

void	translate (F32 x, F32 y, F32 z)
	Translate the object on each axis by the specified amount.

void	translateX (F32 positionX)
	Translate the object on the X axis by the specified amount.

void	translateY (F32 positionY)
	Translate the object on the Y axis by the specified amount.

void	translateZ (F32 positionZ)
	Translate the object on the Z axis by the specified amount.

void	scale (F32 amount)
	Increase the scaling factor on all three axis by an uniform factor.

void	scale (F32 x, F32 y, F32 z)
	Increase the scaling factor on all three axis by the specified amounts.

void	rotate (F32 xAxis, F32 yAxis, F32 zAxis, Angle::DEGREES< F32 > degrees)
	Apply an axis-angle rotation.

void	rotate (const vec3< F32 > &euler)
	Apply an euler rotation.

virtual void	getScale (vec3< F32 > &scaleOut) const =0
	Return the scale factor.

virtual void	getPosition (vec3< F32 > &posOut) const =0
	Return the position.

virtual void	getOrientation (Quaternion< F32 > &quatOut) const =0
	Return the orientation quaternion.

Protected Member Functions
void	setTransformDirty (TransformType type) noexcept

void	setTransformDirty (U32 typeMask) noexcept

void	updateCachedValues ()

void	onParentTransformDirty (U32 transformMask) noexcept

void	onParentUsageChanged (NodeUsageContext context) noexcept

void	onParentChanged (const SceneGraphNode oldParent, const SceneGraphNode newParent)

void	getScale (vec3< F32 > &scaleOut) const override
	Return the scale factor.

void	getPosition (vec3< F32 > &posOut) const override
	Return the position.

void	getOrientation (Quaternion< F32 > &quatOut) const override
	Return the orientation quaternion.

Quaternion< F32 >	getDerivedOrientation () const

vec3< F32 >	getDerivedPosition () const

vec3< F32 >	getDerivedScale () const

void	updateLocalMatrix (D64 interpolationFactor)

Private Types
using	Parent = BaseComponentType< TransformComponent, ComponentType::TRANSFORM >

using	TransformStack = std::stack< TransformValues >

Private Member Functions
void	updateLocalMatrixLocked ()

void	updateLocalMatrixInterpolated (D64 interpolationFactor)

Private Attributes
std::pair< bool, mat4< F32 > >	_transformOffset

std::atomic_uint	_transformUpdatedMask {}

TransformValues	_prevTransformValues

TransformValues	_transformValuesInterpolated

TransformStack	_transformStack {}

Transform	_transformInterface

NodeUsageContext	_parentUsageContext

bool	_cacheDirty = true

bool	_uniformScaled = true

SharedMutex	_localMatrixLock {}

SharedMutex	_lock {}

Friends
class	TransformSystem

class	Attorney::TransformComponentSGN

template<typename T , typename U >
class	ECSSystem

Detailed Description

Definition at line 53 of file TransformComponent.h.

Member Typedef Documentation

◆ Parent

using Divide::TransformComponent::Parent = BaseComponentType< TransformComponent, ComponentType::TRANSFORM >

private

Definition at line 53 of file TransformComponent.h.

◆ TransformStack

using Divide::TransformComponent::TransformStack = std::stack<TransformValues>

private

Definition at line 225 of file TransformComponent.h.

Member Enumeration Documentation

◆ ScalingMode

enum class Divide::TransformComponent::ScalingMode : U8

strong

Enumerator
UNIFORM
NON_UNIFORM

Definition at line 57 of file TransformComponent.h.

Constructor & Destructor Documentation

◆ TransformComponent()

Divide::TransformComponent::TransformComponent	(	SceneGraphNode *	parentSGN,
		PlatformContext &	context
	)

Definition at line 10 of file TransformComponent.cpp.

Member Function Documentation

◆ getDerivedOrientation()

Quaternion< F32 > Divide::TransformComponent::getDerivedOrientation ( ) const

protected

Definition at line 746 of file TransformComponent.cpp.

◆ getDerivedPosition()

vec3< F32 > Divide::TransformComponent::getDerivedPosition ( ) const

protected

Definition at line 686 of file TransformComponent.cpp.

◆ getDerivedScale()

vec3< F32 > Divide::TransformComponent::getDerivedScale ( ) const

protected

Definition at line 716 of file TransformComponent.cpp.

◆ getFwdVector()

vec3< F32 > Divide::TransformComponent::getFwdVector ( ) const

Return the derived forward direction.

Definition at line 794 of file TransformComponent.cpp.

◆ getLocalDirection()

const vec3< F32 > Divide::TransformComponent::getLocalDirection ( const vec3< F32 > & worldForward = WORLD_Z_NEG_AXIS ) const

Definition at line 410 of file TransformComponent.cpp.

◆ getLocalOrientation()

Quaternion< F32 > Divide::TransformComponent::getLocalOrientation ( ) const

Return the local orientation quaternion.

Definition at line 778 of file TransformComponent.cpp.

◆ getLocalOrientationInterpolated()

Quaternion< F32 > Divide::TransformComponent::getLocalOrientationInterpolated ( ) const

Return the local orientation quaternion.

Definition at line 809 of file TransformComponent.cpp.

◆ getLocalPosition()

vec3< F32 > Divide::TransformComponent::getLocalPosition ( ) const

Return the local position.

Definition at line 766 of file TransformComponent.cpp.

◆ getLocalPositionInterpolated()

vec3< F32 > Divide::TransformComponent::getLocalPositionInterpolated ( ) const

Return the local position.

Definition at line 784 of file TransformComponent.cpp.

◆ getLocalRotationMatrix()

void Divide::TransformComponent::getLocalRotationMatrix ( mat4< F32 > & matOut ) const

This returns a "normal matrix". If we have uniform scaling, this is just the upper 3x3 part of our world matrix If we have non-uniform scaling, that 3x3 mat goes through an inverse-transpose step to get rid of any scaling factors but keep rotations Padded to fit into a mat4 for convenient. Can cast to a mat3 afterwards as row 3 and column 3 are just 0,0,0,1

Definition at line 548 of file TransformComponent.cpp.

◆ getLocalRotationMatrixInterpolated()

void Divide::TransformComponent::getLocalRotationMatrixInterpolated ( mat4< F32 > & matOut ) const

Definition at line 559 of file TransformComponent.cpp.

◆ getLocalScale()

vec3< F32 > Divide::TransformComponent::getLocalScale ( ) const

Return the local scale factor.

Definition at line 772 of file TransformComponent.cpp.

◆ getLocalScaleInterpolated()

vec3< F32 > Divide::TransformComponent::getLocalScaleInterpolated ( ) const

Return the local scale factor.

Definition at line 789 of file TransformComponent.cpp.

◆ getLocalValues()

TransformValues Divide::TransformComponent::getLocalValues ( ) const

Definition at line 499 of file TransformComponent.cpp.

◆ getOrientation()

void Divide::TransformComponent::getOrientation ( Quaternion< F32 > & quatOut ) const

overrideprotectedvirtual

Return the orientation quaternion.

void Divide::TransformComponent::getWorldTransforms	(	vec3< F32 > &	positionOut,
		vec3< F32 > &	scaleOut,
		Quaternion< F32 > &	rotationOut
	)

Divide::TransformComponent::PROPERTY_R_IW	(	mat4< F32 >	,
		localMatrix	,
		MAT4_IDENTITY
	)

Divide::TransformComponent::PROPERTY_R_IW	(	mat4< F32 >	,
		localMatrixInterpolated	,
		MAT4_IDENTITY
	)

Divide::TransformComponent::PROPERTY_R_IW	(	TransformValues	,
		cachedDerivedTransform
	)

Divide::TransformComponent::PROPERTY_RW	(	bool	,
		editorLockPosition	,
		false
	)

Divide::TransformComponent::PROPERTY_RW	(	bool	,
		editorLockRotation	,
		false
	)

Divide::TransformComponent::PROPERTY_RW	(	bool	,
		editorLockScale	,
		false
	)

Divide::TransformComponent::PROPERTY_RW	(	ScalingMode	,
		scalingMode	,
		ScalingMode::UNIFORM
	)

void Divide::TransformComponent::setDirection	(	const vec3< F32 > &	fwdDirection,
		const vec3< F32 > &	upDirection = `WORLD_Y_AXIS`
	)

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Parent

◆ TransformStack

Member Enumeration Documentation

◆ ScalingMode

Constructor & Destructor Documentation

◆ TransformComponent()

Member Function Documentation

◆ getDerivedOrientation()

◆ getDerivedPosition()

◆ getDerivedScale()

◆ getFwdVector()

◆ getLocalDirection()

◆ getLocalOrientation()

◆ getLocalOrientationInterpolated()

◆ getLocalPosition()

◆ getLocalPositionInterpolated()

◆ getLocalRotationMatrix()

◆ getLocalRotationMatrixInterpolated()

◆ getLocalScale()

◆ getLocalScaleInterpolated()

◆ getLocalValues()

◆ getOrientation()

◆ getPosition()

◆ getRightVector()

◆ getScale()

◆ getUpVector()

◆ getWorldDirection()

◆ getWorldMatrix() [1/2]

◆ getWorldMatrix() [2/2]

◆ getWorldMatrixInterpolated() [1/2]

◆ getWorldMatrixInterpolated() [2/2]

◆ getWorldOrientation()

◆ getWorldOrientationInterpolated()

◆ getWorldPosition()

◆ getWorldPositionInterpolated()

◆ getWorldRotationMatrix()

◆ getWorldRotationMatrixInterpolated()

◆ getWorldScale()

◆ getWorldScaleInterpolated()

◆ getWorldTransforms()

◆ getWorldTransformsInterpolated()

◆ isUniformScaled()

◆ loadCache()

◆ onParentChanged()

◆ onParentTransformDirty()

◆ onParentUsageChanged()

◆ popTransforms()

◆ PROPERTY_R_IW() [1/3]

◆ PROPERTY_R_IW() [2/3]

◆ PROPERTY_R_IW() [3/3]

◆ PROPERTY_RW() [1/4]

◆ PROPERTY_RW() [2/4]

◆ PROPERTY_RW() [3/4]

◆ PROPERTY_RW() [4/4]

◆ pushTransforms()

◆ reset()

◆ resetCache()

◆ rotate() [1/8]

◆ rotate() [2/8]

◆ rotate() [3/8]

◆ rotate() [4/8]

◆ rotate() [5/8]

◆ rotate() [6/8]

◆ rotate() [7/8]

◆ rotate() [8/8]

◆ rotateSlerp()

◆ rotateX()

◆ rotateY()

◆ rotateZ()

◆ saveCache()

◆ scale()