#include <sqt_transform.hpp>

Public Member Functions
	S1QTTransform3D (F32x3 translation={ 0.0f, 0.0f, 0.0f }, F32x4 rotation={ 1.0f, 0.0f, 0.0f, 0.0f }, F32 scale=1.0f) noexcept

	S1QTTransform3D (FXMVECTOR translation, FXMVECTOR rotation, F32 scale) noexcept

	S1QTTransform3D (const S1QTTransform3D &transform) noexcept=default

	S1QTTransform3D (S1QTTransform3D &&transform) noexcept=default

	~S1QTTransform3D ()=default

S1QTTransform3D &	operator= (const S1QTTransform3D &transform) noexcept=default

S1QTTransform3D &	operator= (S1QTTransform3D &&transform) noexcept=default

void	SetTranslationX (F32 x) noexcept

void	SetTranslationY (F32 y) noexcept

void	SetTranslationZ (F32 z) noexcept

void	SetTranslation (F32 x, F32 y, F32 z) noexcept

void	SetTranslation (F32x3 translation) noexcept

void XM_CALLCONV	SetTranslation (FXMVECTOR translation) noexcept

void	AddTranslationX (F32 x) noexcept

void	AddTranslationY (F32 y) noexcept

void	AddTranslationZ (F32 z) noexcept

void	AddTranslation (F32 x, F32 y, F32 z) noexcept

void	AddTranslation (const F32x3 &translation) noexcept

void XM_CALLCONV	AddTranslation (FXMVECTOR translation) noexcept

F32	GetTranslationX () const noexcept

F32	GetTranslationY () const noexcept

F32	GetTranslationZ () const noexcept

const F32x3	GetTranslationView () const noexcept

const XMVECTOR XM_CALLCONV	GetTranslation () const noexcept

const XMMATRIX XM_CALLCONV	GetObjectToParentTranslationMatrix () const noexcept

const XMMATRIX XM_CALLCONV	GetParentToObjectTranslationMatrix () const noexcept

void	SetRotation (const F32x4 &rotation) noexcept

void XM_CALLCONV	SetRotation (FXMVECTOR rotation) noexcept

void XM_CALLCONV	SetRotationAroundDirection (FXMVECTOR direction, F32 angle) noexcept

const F32x4	GetRotationView () const noexcept

const XMVECTOR XM_CALLCONV	GetRotation () const noexcept

const XMMATRIX XM_CALLCONV	GetObjectToParentRotationMatrix () const noexcept

const XMMATRIX XM_CALLCONV	GetParentToObjectRotationMatrix () const noexcept

void	SetScale (F32 scale) noexcept

void	AddScale (F32 scale) noexcept

const F32	GetScale () const noexcept

const XMMATRIX XM_CALLCONV	GetObjectToParentScaleMatrix () const noexcept

const XMMATRIX XM_CALLCONV	GetParentToObjectScaleMatrix () const noexcept

const XMVECTOR XM_CALLCONV	GetObjectOrigin () const noexcept

const XMVECTOR XM_CALLCONV	GetObjectAxisX () const noexcept

const XMVECTOR XM_CALLCONV	GetObjectAxisY () const noexcept

const XMVECTOR XM_CALLCONV	GetObjectAxisZ () const noexcept

const XMVECTOR XM_CALLCONV	GetParentOrigin () const noexcept

const XMVECTOR XM_CALLCONV	GetParentAxisX () const noexcept

const XMVECTOR XM_CALLCONV	GetParentAxisY () const noexcept

const XMVECTOR XM_CALLCONV	GetParentAxisZ () const noexcept

const XMMATRIX XM_CALLCONV	GetObjectToParentMatrix () const noexcept

const XMMATRIX XM_CALLCONV	GetParentToObjectMatrix () const noexcept

const XMVECTOR XM_CALLCONV	TransformObjectToParent (FXMVECTOR vector) const noexcept

const XMVECTOR XM_CALLCONV	TransformObjectToParentPoint (FXMVECTOR point) const noexcept

const XMVECTOR XM_CALLCONV	TransformObjectToParentDirection (FXMVECTOR direction) const noexcept

const XMVECTOR XM_CALLCONV	TransformParentToObject (FXMVECTOR vector) const noexcept

const XMVECTOR XM_CALLCONV	TransformParentToObjectPoint (FXMVECTOR point) const noexcept

const XMVECTOR XM_CALLCONV	TransformParentToObjectDirection (FXMVECTOR direction) const noexcept

Private Attributes
F32x3	m_translation

F32	m_scale

F32x4	m_rotation

Detailed Description

A class of 3D transforms supporting uniform scaling, rotation using quaternions, and translation.

Constructor & Destructor Documentation

◆ S1QTTransform3D() [1/4]

mage::S1QTTransform3D::S1QTTransform3D	(	F32x3	translation = `{ 0.0f, 0.0f, 0.0f }`,
		F32x4	rotation = `{ 1.0f, 0.0f, 0.0f, 0.0f }`,
		F32	scale = `1.0f`
	)

explicitnoexcept

Constructs a transform from the given translation, rotation and scale component.

Parameters

[in]	translation	The translation component.
[in]	rotation	The rotation component.
[in]	scale	The scale component.

◆ S1QTTransform3D() [2/4]

mage::S1QTTransform3D::S1QTTransform3D	(	FXMVECTOR	translation,
		FXMVECTOR	rotation,
		F32	scale
	)

explicitnoexcept

Constructs a transform from the given translation, rotation and scale component.

Parameters

[in]	translation	The translation component.
[in]	rotation	The rotation component.
[in]	scale	The scale component.

◆ S1QTTransform3D() [3/4]

mage::S1QTTransform3D::S1QTTransform3D ( const S1QTTransform3D & transform )

defaultnoexcept

Constructs a transform from the given transform.

Parameters

[in] transform A reference to the transform to copy.

◆ S1QTTransform3D() [4/4]

mage::S1QTTransform3D::S1QTTransform3D ( S1QTTransform3D && transform )

defaultnoexcept

Constructs a transform by moving the given transform.

Parameters

[in] transform A reference to the transform to move.

◆ ~S1QTTransform3D()

mage::S1QTTransform3D::~S1QTTransform3D ( )

default

Destructs this transform.

Member Function Documentation

◆ AddScale()

void mage::S1QTTransform3D::AddScale ( F32 scale )

noexcept

Adds the given scale component to the scale component of this transform.

Parameters

[in] scale The scale component to add.

◆ AddTranslation() [1/3]

void mage::S1QTTransform3D::AddTranslation	(	F32	x,
		F32	y,
		F32	z
	)

noexcept

Adds the given translation component to the translation component of this transform.

Parameters

[in]	x	The x-value of the translation component to add.
[in]	y	The y-value of the translation component to add.
[in]	z	The z-value of the translation component to add.

◆ AddTranslation() [2/3]

void mage::S1QTTransform3D::AddTranslation ( const F32x3 & translation )

noexcept

Adds the given translation component to the translation component of this transform.

Parameters

[in] translation A reference to the translation component to add.

◆ AddTranslation() [3/3]

void XM_CALLCONV mage::S1QTTransform3D::AddTranslation ( FXMVECTOR translation )

noexcept

Adds the given translation component to the translation component of this transform.

Parameters

[in] translation The translation component to add.

◆ AddTranslationX()

void mage::S1QTTransform3D::AddTranslationX ( F32 x )

noexcept

Adds the given x-value to the translation component of this transform.

Parameters

[in] x The x-value of the translation component to add.

◆ AddTranslationY()

void mage::S1QTTransform3D::AddTranslationY ( F32 y )

noexcept

Adds the given y-value to the translation component of this transform.

Parameters

[in] y The y-value of the translation component to add.

◆ AddTranslationZ()

void mage::S1QTTransform3D::AddTranslationZ ( F32 z )

noexcept

Adds the given z-value to the translation component of this transform.

Parameters

[in] z The z-value of the translation component to add.

◆ GetObjectAxisX()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::GetObjectAxisX ( ) const

noexcept

Returns the direction of the local x-axis of this transform expressed in object space coordinates.

Returns: The direction of the local x-axis of this transform expressed in object space coordinates.

◆ GetObjectAxisY()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::GetObjectAxisY ( ) const

noexcept

Returns the direction of the local y-axis of this transform expressed in object space coordinates.

Returns: The direction of the local y-axis of this transform expressed in object space coordinates.

◆ GetObjectAxisZ()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::GetObjectAxisZ ( ) const

noexcept

Returns the direction of the local z-axis of this transform expressed in object space coordinates.

Returns: The direction of the local z-axis of this transform expressed in object space coordinates.

◆ GetObjectOrigin()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::GetObjectOrigin ( ) const

noexcept

Returns the position of the local origin of this transform expressed in object space coordinates.

Returns: The position of the local origin of this transform expressed in object space coordinates.

◆ GetObjectToParentMatrix()

const XMMATRIX XM_CALLCONV mage::S1QTTransform3D::GetObjectToParentMatrix ( ) const

noexcept

Returns the object-to-parent matrix of this transform.

Returns: The object-to-parent matrix of this transform.

◆ GetObjectToParentRotationMatrix()

const XMMATRIX XM_CALLCONV mage::S1QTTransform3D::GetObjectToParentRotationMatrix ( ) const

noexcept

Returns the object-to-parent rotation matrix of this transform.

Returns: The object-to-parent rotation matrix of this transform.

◆ GetObjectToParentScaleMatrix()

const XMMATRIX XM_CALLCONV mage::S1QTTransform3D::GetObjectToParentScaleMatrix ( ) const

noexcept

Returns the object-to-parent scale matrix of this transform.

Returns: The scale object-to-parent matrix of this transform.

◆ GetObjectToParentTranslationMatrix()

const XMMATRIX XM_CALLCONV mage::S1QTTransform3D::GetObjectToParentTranslationMatrix ( ) const

noexcept

Returns the object-to-parent translation matrix of this transform.

Returns: The object-to-parent translation matrix of this transform.

◆ GetParentAxisX()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::GetParentAxisX ( ) const

noexcept

Returns the direction of the local x-axis of this transform expressed in parent space coordinates.

Returns: The direction of the local x-axis of this transform expressed in parent space coordinates.

◆ GetParentAxisY()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::GetParentAxisY ( ) const

noexcept

Returns the direction of the local y-axis of this transform expressed in parent space coordinates.

Returns: The direction of the local y-axis of this transform expressed in parent space coordinates.

◆ GetParentAxisZ()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::GetParentAxisZ ( ) const

noexcept

Returns the direction of the local z-axis of this transform expressed in parent space coordinates.

Returns: The direction of the local z-axis of this transform expressed in parent space coordinates.

◆ GetParentOrigin()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::GetParentOrigin ( ) const

noexcept

Returns the position of the local origin of this transform expressed in parent space coordinates.

Returns: The position of the local origin of this transform expressed in parent space coordinates.

◆ GetParentToObjectMatrix()

const XMMATRIX XM_CALLCONV mage::S1QTTransform3D::GetParentToObjectMatrix ( ) const

noexcept

Returns the parent-to-object matrix of this transform.

Returns: The parent-to-object matrix of this transform.

◆ GetParentToObjectRotationMatrix()

const XMMATRIX XM_CALLCONV mage::S1QTTransform3D::GetParentToObjectRotationMatrix ( ) const

noexcept

Returns the parent-to-object rotation matrix of this transform.

Returns: The parent-to-object rotation matrix of this transform.

◆ GetParentToObjectScaleMatrix()

const XMMATRIX XM_CALLCONV mage::S1QTTransform3D::GetParentToObjectScaleMatrix ( ) const

noexcept

Returns the parent-to-object scale matrix of this transform.

Returns: The parent-to-object scale matrix of this transform.

◆ GetParentToObjectTranslationMatrix()

const XMMATRIX XM_CALLCONV mage::S1QTTransform3D::GetParentToObjectTranslationMatrix ( ) const

noexcept

Returns the parent-to-object translation matrix of this transform.

Returns: The parent-to-object translation matrix of this transform.

◆ GetRotation()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::GetRotation ( ) const

noexcept

Returns the rotation component of this transform.

Returns: The rotation component of this transform.

◆ GetRotationView()

const F32x4 mage::S1QTTransform3D::GetRotationView ( ) const

noexcept

Returns the rotation component of this transform.

Returns: The rotation component of this transform.

◆ GetScale()

const F32 mage::S1QTTransform3D::GetScale ( ) const

noexcept

Returns the scale component of this transform.

Returns: The scale component of this transform.

◆ GetTranslation()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::GetTranslation ( ) const

noexcept

Returns the translation component of this transform.

Returns: The translation component of this transform.

◆ GetTranslationView()

const F32x3 mage::S1QTTransform3D::GetTranslationView ( ) const

noexcept

Returns the translation component of this transform.

Returns: The translation component of this transform.

◆ GetTranslationX()

F32 mage::S1QTTransform3D::GetTranslationX ( ) const

noexcept

Returns the x-value of the translation component of this transform.

Returns: The x-value of the translation component of this transform.

◆ GetTranslationY()

F32 mage::S1QTTransform3D::GetTranslationY ( ) const

noexcept

Returns the y-value of the translation component of this transform.

Returns: The y-value of the translation component of this transform.

◆ GetTranslationZ()

F32 mage::S1QTTransform3D::GetTranslationZ ( ) const

noexcept

Returns the z-value of the translation component of this transform.

Returns: The z-value of the translation component of this transform.

◆ operator=() [1/2]

S1QTTransform3D& mage::S1QTTransform3D::operator= ( const S1QTTransform3D & transform )

defaultnoexcept

Copies the given transform to this transform.

Parameters

[in] transform A reference to the transform to copy.

Returns: A reference to the copy of the given transform (i.e. this transform).

◆ operator=() [2/2]

S1QTTransform3D& mage::S1QTTransform3D::operator= ( S1QTTransform3D && transform )

defaultnoexcept

Moves the given transform to this transform.

Parameters

[in] transform A reference to the transform to move.

Returns: A reference to the moved transform (i.e. this transform).

◆ SetRotation() [1/2]

void mage::S1QTTransform3D::SetRotation ( const F32x4 & rotation )

noexcept

Sets the rotation component of this transform to the given rotation component.

Parameters

[in] rotation A reference to the rotation component.

◆ SetRotation() [2/2]

void XM_CALLCONV mage::S1QTTransform3D::SetRotation ( FXMVECTOR rotation )

noexcept

Sets the rotation component of this transform to the given rotation component.

Parameters

[in] rotation The rotation component.

◆ SetRotationAroundDirection()

void XM_CALLCONV mage::S1QTTransform3D::SetRotationAroundDirection	(	FXMVECTOR	direction,
		F32	angle
	)

noexcept

Sets the rotation component of this transform to a rotation of the given angle around the given direction.

Parameters

[in]	direction	The unit-length direction.
[in]	angle	The angle.

◆ SetScale()

void mage::S1QTTransform3D::SetScale ( F32 scale )

noexcept

Sets the scale component of this transform to the given scale component.

Parameters

[in] scale The scale component.

◆ SetTranslation() [1/3]

void mage::S1QTTransform3D::SetTranslation	(	F32	x,
		F32	y,
		F32	z
	)

noexcept

Sets the translation component of this transform to the given translation component.

Parameters

[in]	x	The x-value of the translation component.
[in]	y	The y-value of the translation component.
[in]	z	The z-value of the translation component.

◆ SetTranslation() [2/3]

void mage::S1QTTransform3D::SetTranslation ( F32x3 translation )

noexcept

Sets the translation component of this transform to the given translation component.

Parameters

[in] translation The translation component.

◆ SetTranslation() [3/3]

void XM_CALLCONV mage::S1QTTransform3D::SetTranslation ( FXMVECTOR translation )

noexcept

Sets the translation component of this transform to the given translation component.

Parameters

[in] translation The translation component.

◆ SetTranslationX()

void mage::S1QTTransform3D::SetTranslationX ( F32 x )

noexcept

Sets the x-value of the translation component of this transform to the given value.

Parameters

[in] x The x-value of the translation component.

◆ SetTranslationY()

void mage::S1QTTransform3D::SetTranslationY ( F32 y )

noexcept

Sets the y-value of the translation component of this transform to the given value.

Parameters

[in] y The y-value of the translation component.

◆ SetTranslationZ()

void mage::S1QTTransform3D::SetTranslationZ ( F32 z )

noexcept

Sets the z-value of the translation component of this transform to the given value.

Parameters

[in] z The z-value of the translation component.

◆ TransformObjectToParent()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::TransformObjectToParent ( FXMVECTOR vector ) const

noexcept

Transforms the given vector expressed in object space coordinates to parent space coordinates.

Parameters

[in] vector The vector expressed in object space coordinates.

Returns: The transformed vector expressed in parent space coordinates.

◆ TransformObjectToParentDirection()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::TransformObjectToParentDirection ( FXMVECTOR direction ) const

noexcept

Transforms the given direction expressed in object space coordinates to parent space coordinates.

Parameters

[in] direction The direction expressed in object space coordinates.

Returns: The transformed direction expressed in parent space coordinates.

◆ TransformObjectToParentPoint()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::TransformObjectToParentPoint ( FXMVECTOR point ) const

noexcept

Transforms the given point expressed in object space coordinates to parent space coordinates.

Parameters

[in] point The point expressed in object space coordinates.

Returns: The transformed point expressed in parent space coordinates.

◆ TransformParentToObject()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::TransformParentToObject ( FXMVECTOR vector ) const

noexcept

Transforms the given vector expressed in parent space coordinates to object space coordinates.

Parameters

[in] vector The vector expressed in parent space coordinates.

Returns: The transformed vector expressed in object space coordinates.

◆ TransformParentToObjectDirection()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::TransformParentToObjectDirection ( FXMVECTOR direction ) const

noexcept

Transforms the given direction expressed in parent space coordinates to object space coordinates.

Parameters

[in] direction The direction expressed in parent space coordinates.

Returns: The transformed direction expressed in object space coordinates.

◆ TransformParentToObjectPoint()

const XMVECTOR XM_CALLCONV mage::S1QTTransform3D::TransformParentToObjectPoint ( FXMVECTOR point ) const

noexcept

Transforms the given point expressed in parent space coordinates to object space coordinates.

Parameters

[in] point The point expressed in parent space coordinates.

Returns: The transformed point expressed in object space coordinates.

Member Data Documentation

◆ m_rotation

F32x4 mage::S1QTTransform3D::m_rotation

private

The rotation component (unit quaternion) of this transform.

◆ m_scale

F32 mage::S1QTTransform3D::m_scale

private

The scale component of this transform.

◆ m_translation

F32x3 mage::S1QTTransform3D::m_translation

private

The translation component of this transform.

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ S1QTTransform3D() [1/4]

◆ S1QTTransform3D() [2/4]

◆ S1QTTransform3D() [3/4]

◆ S1QTTransform3D() [4/4]

◆ ~S1QTTransform3D()

Member Function Documentation

◆ AddScale()

◆ AddTranslation() [1/3]

◆ AddTranslation() [2/3]

◆ AddTranslation() [3/3]

◆ AddTranslationX()

◆ AddTranslationY()

◆ AddTranslationZ()

◆ GetObjectAxisX()

◆ GetObjectAxisY()

◆ GetObjectAxisZ()

◆ GetObjectOrigin()

◆ GetObjectToParentMatrix()

◆ GetObjectToParentRotationMatrix()

◆ GetObjectToParentScaleMatrix()

◆ GetObjectToParentTranslationMatrix()

◆ GetParentAxisX()

◆ GetParentAxisY()

◆ GetParentAxisZ()

◆ GetParentOrigin()

◆ GetParentToObjectMatrix()

◆ GetParentToObjectRotationMatrix()

◆ GetParentToObjectScaleMatrix()

◆ GetParentToObjectTranslationMatrix()

◆ GetRotation()

◆ GetRotationView()

◆ GetScale()

◆ GetTranslation()

◆ GetTranslationView()

◆ GetTranslationX()

◆ GetTranslationY()

◆ GetTranslationZ()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SetRotation() [1/2]

◆ SetRotation() [2/2]

◆ SetRotationAroundDirection()

◆ SetScale()

◆ SetTranslation() [1/3]

◆ SetTranslation() [2/3]

◆ SetTranslation() [3/3]

◆ SetTranslationX()

◆ SetTranslationY()

◆ SetTranslationZ()

◆ TransformObjectToParent()

◆ TransformObjectToParentDirection()

◆ TransformObjectToParentPoint()

◆ TransformParentToObject()

◆ TransformParentToObjectDirection()

◆ TransformParentToObjectPoint()

Member Data Documentation

◆ m_rotation

◆ m_scale

◆ m_translation