xiiBasisAxis Struct Reference

An enum that allows to select on of the six main axis (positive / negative) More...

#include <Declarations.h>

Inheritance diagram for xiiBasisAxis:

Public Types
enum	Enum : StorageType {   PositiveX , PositiveY , PositiveZ , NegativeX ,   NegativeY , NegativeZ , Default = PositiveX }
	An enum that allows to select on of the six main axis (positive / negative)
using	StorageType = xiiInt8

Static Public Member Functions
static xiiVec3	GetBasisVector (xiiBasisAxis::Enum basisAxis)
	Returns the vector for the given axis. E.g. (1, 0, 0) or (0, -1, 0), etc.
static xiiVec3d	GetBasisVectorDouble (xiiBasisAxis::Enum basisAxis)
	Returns the vector for the given axis. E.g. (1, 0, 0) or (0, -1, 0), etc.
static xiiMat3	CalculateTransformationMatrix (xiiBasisAxis::Enum forwardDir, xiiBasisAxis::Enum rightDir, xiiBasisAxis::Enum dir, float fUniformScale=1.0f, float fScaleX=1.0f, float fScaleY=1.0f, float fScaleZ=1.0f)
	Computes a matrix representing the transformation. 'Forward' represents the X axis, 'Right' the Y axis and 'Up' the Z axis.
static xiiMat3d	CalculateTransformationMatrix (xiiBasisAxis::Enum forwardDir, xiiBasisAxis::Enum rightDir, xiiBasisAxis::Enum dir, double fUniformScale=1.0, double fScaleX=1.0, double fScaleY=1.0, double fScaleZ=1.0)
	Computes a matrix representing the transformation. 'Forward' represents the X axis, 'Right' the Y axis and 'Up' the Z axis.
static xiiQuat	GetBasisRotation (xiiBasisAxis::Enum identity, xiiBasisAxis::Enum axis)
	Returns a quaternion that rotates from 'identity' to 'axis'.
static xiiQuatd	GetBasisRotationDouble (xiiBasisAxis::Enum identity, xiiBasisAxis::Enum axis)
	Returns a quaternion that rotates from 'identity' to 'axis'.
static xiiQuat	GetBasisRotation_PosX (xiiBasisAxis::Enum axis)
	Returns a quaternion that rotates from 'PositiveX' to 'axis'.
static xiiQuatd	GetBasisRotationDouble_PosX (xiiBasisAxis::Enum axis)
	Returns a quaternion that rotates from 'PositiveX' to 'axis'.
static xiiBasisAxis::Enum	GetOrthogonalAxis (xiiBasisAxis::Enum axis1, xiiBasisAxis::Enum axis2, bool bFlip)
	Returns the axis that is orthogonal to axis1 and axis2. If 'flip' is set, it returns the negated axis.

Detailed Description

An enum that allows to select on of the six main axis (positive / negative)

Member Function Documentation

GetOrthogonalAxis()

xiiBasisAxis::Enum xiiBasisAxis::GetOrthogonalAxis ( xiiBasisAxis::Enum axis1, xiiBasisAxis::Enum axis2, bool bFlip )

static

Returns the axis that is orthogonal to axis1 and axis2. If 'flip' is set, it returns the negated axis.

If axis1 and axis2 are not orthogonal to each other, the value of axis1 is returned as the result.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/Math/Declarations.h
• /home/runner/work/XII/XII/Source/Engine/Foundation/Math/Implementation/Math.cpp