Added transformables
This commit is contained in:
Robert
parent
98425f45c8
commit
f86fcad89f
5 changed files with 544 additions and 3 deletions
248
include/transformable.hpp
Normal file
248
include/transformable.hpp
Normal file
|
|
@ -0,0 +1,248 @@
|
|||
/*****************************************************************//**
|
||||
* \file transformable.hpp
|
||||
* \brief Contains utility for anything that has a geometry
|
||||
*
|
||||
* \author Lauchmelder
|
||||
* \date January 2021
|
||||
*********************************************************************/
|
||||
|
||||
#ifndef TRANSFORMABLE_HPP
|
||||
#define TRANSFORMABLE_HPP
|
||||
|
||||
#include <core.hpp>
|
||||
|
||||
namespace oglu
|
||||
{
|
||||
/**
|
||||
* @brief Defines position, rotation and scale.
|
||||
*
|
||||
* This class wraps a 4x4 transformation matrix and provides useful
|
||||
* helper functions to perform translations, rotations and scalings.
|
||||
*/
|
||||
class OGLU_API Transformable
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* @brief Create new identity transformation.
|
||||
*
|
||||
* An identity transformation is a matrix with all 1's on the diagonal.
|
||||
* When applied to a vector it leaves it unchanged.
|
||||
*/
|
||||
Transformable();
|
||||
|
||||
/**
|
||||
* @brief Copies another transformation.
|
||||
*
|
||||
* The transformation matrix of @p other is copied.
|
||||
*/
|
||||
Transformable(const Transformable& other);
|
||||
~Transformable();
|
||||
|
||||
/**
|
||||
* @brief Sets the position.
|
||||
*
|
||||
* This sets an absolute position, means that it resets any previous
|
||||
* translations.
|
||||
*
|
||||
* @param[in] x New x position
|
||||
* @param[in] y New y position
|
||||
* @param[in] z New z position
|
||||
*/
|
||||
void SetPosition(float x, float y, float z);
|
||||
|
||||
/**
|
||||
* @brief Sets the position.
|
||||
*
|
||||
* This sets an absolute position, means that it resets any previous
|
||||
* translations.
|
||||
*
|
||||
* @param[in] position An array of floats containing three scalars
|
||||
*/
|
||||
void SetPosition(const float* translation);
|
||||
|
||||
/**
|
||||
* @brief Sets the rotation.
|
||||
*
|
||||
* This sets an absolute rotation, means that it resets any previous
|
||||
* rotations.
|
||||
*
|
||||
* @param[in] rotX New rotation around x axis
|
||||
* @param[in] rotY New rotation around y axis
|
||||
* @param[in] rotZ New rotation around z axis
|
||||
*/
|
||||
void SetRotation(float rotX, float rotY, float rotZ);
|
||||
|
||||
/**
|
||||
* @brief Sets the rotation.
|
||||
*
|
||||
* This sets an absolute rotation, means that it resets any previous
|
||||
* rotations.
|
||||
*
|
||||
* @param[in] rotation An array of floats containing three scalars
|
||||
*/
|
||||
void SetRotation(const float* rotation);
|
||||
|
||||
/**
|
||||
* @brief Sets the rotation.
|
||||
*
|
||||
* This sets an absolute rotation, means that it resets any previous
|
||||
* rotations.
|
||||
*
|
||||
* @param[in] angle The angle to rotate by
|
||||
* @param[in] xAxis The x component of the rotation axis
|
||||
* @param[in] yAxis The y component of the rotation axis
|
||||
* @param[in] zAxis The z component of the rotation axis
|
||||
*/
|
||||
void SetRotation(float angle, float xAxis, float yAxis, float zAxis);
|
||||
|
||||
/**
|
||||
* @brief Sets the rotation.
|
||||
*
|
||||
* This sets an absolute rotation, means that it resets any previous
|
||||
* rotations.
|
||||
*
|
||||
* @param[in] angle The angle to rotate by
|
||||
* @param[in] axis An array of floats containing the three rotation axis components
|
||||
*/
|
||||
void SetRotation(float angle, const float* axis);
|
||||
|
||||
/**
|
||||
* @brief Sets the scaling.
|
||||
*
|
||||
* This sets an absolute scaling, means that it resets any previous
|
||||
* scaling.
|
||||
*
|
||||
* @param[in] scaleX The scaling in x direction
|
||||
* @param[in] scaleY The scaling in y direction
|
||||
* @param[in] scaleZ The scaling in z direction
|
||||
*/
|
||||
void SetScale(float scaleX, float scaleY, float scaleZ);
|
||||
|
||||
/**
|
||||
* @brief Sets the scaling.
|
||||
*
|
||||
* This sets an absolute scaling, means that it resets any previous
|
||||
* scaling.
|
||||
*
|
||||
* @param[in] scale An array of floats containing three scalars
|
||||
*/
|
||||
void SetScale(const float* scale);
|
||||
|
||||
/**
|
||||
* @brief Performs a translation.
|
||||
*
|
||||
* This function applies a translation to the object, it operates
|
||||
* operates on the current position.
|
||||
*
|
||||
* @param[in] x Offset along the x axis
|
||||
* @param[in] y Offset along the y axis
|
||||
* @param[in] z Offset along the z axis
|
||||
*/
|
||||
void Move(float x, float y, float z);
|
||||
|
||||
/**
|
||||
* @brief Performs a translation.
|
||||
*
|
||||
* This function applies a translation to the object, it operates
|
||||
* operates on the current position.
|
||||
*
|
||||
* @param[in] position An array of floats containing the offset values
|
||||
*/
|
||||
void Move(const float* translation);
|
||||
|
||||
/**
|
||||
* @brief Performs a rotation.
|
||||
*
|
||||
* This function applies a rotation to the object, it operates
|
||||
* operates on the current rotation.
|
||||
*
|
||||
* @param[in] rotX Rotation around the x axis
|
||||
* @param[in] rotY Rotation around the y axis
|
||||
* @param[in] rotZ Rotation around the z axis
|
||||
*/
|
||||
void Rotate(float rotX, float rotY, float rotZ);
|
||||
|
||||
/**
|
||||
* @brief Performs a rotation.
|
||||
*
|
||||
* This function applies a rotation to the object, it operates
|
||||
* operates on the current rotation.
|
||||
*
|
||||
* @param[in] rotation An array of floats containing the rotation values
|
||||
*/
|
||||
void Rotate(const float* rotation);
|
||||
|
||||
/**
|
||||
* @brief Performs a rotation.
|
||||
*
|
||||
* This function applies a rotation to the object, it operates
|
||||
* operates on the current rotation.
|
||||
*
|
||||
* @param[in] angle The angle to rotate by
|
||||
* @param[in] xAxis x component of the rotation axis
|
||||
* @param[in] yAxis y component of the rotation axis
|
||||
* @param[in] zAxis z component of the rotation axis
|
||||
*/
|
||||
void Rotate(float angle, float xAxis, float yAxis, float zAxis);
|
||||
|
||||
/**
|
||||
* @brief Performs a rotation.
|
||||
*
|
||||
* This function applies a rotation to the object, it operates
|
||||
* operates on the current rotation.
|
||||
*
|
||||
* @param[in] angle The angle to rotate by
|
||||
* @param[in] An array of floats containing the components of the rotation axis
|
||||
*/
|
||||
void Rotate(float angle, const float* axis);
|
||||
|
||||
/**
|
||||
* @brief Performs scaling.
|
||||
*
|
||||
* This function applies scaling to the object, it operates
|
||||
* operates on the current scaling.
|
||||
*
|
||||
* @param[in] scaleX Scaling in x direction
|
||||
* @param[in] scaleX Scaling in y direction
|
||||
* @param[in] scaleX Scaling in z direction
|
||||
*/
|
||||
void Scale(float scaleX, float scaleY, float scaleZ);
|
||||
|
||||
/**
|
||||
* @brief Performs scaling.
|
||||
*
|
||||
* This function applies scaling to the object, it operates
|
||||
* operates on the current scaling.
|
||||
*
|
||||
* @param[in] scale An array of floats containing three scaling values
|
||||
*/
|
||||
void Scale(const float* scale);
|
||||
|
||||
/**
|
||||
* @brief Returns a transformation matrix.
|
||||
*
|
||||
* Internally, this function multiplies the translation, rotation,
|
||||
* and scaling matrices into one transformation matrix which is
|
||||
* then returned.
|
||||
*
|
||||
* This multiplication is only performed when a change occured to one
|
||||
* of those matrices (so when there was a translation, rotation or scaling).
|
||||
* So it is okay to call this function multiple times without huge performance
|
||||
* loss, as long as no transformations occur inbetween.
|
||||
*
|
||||
* @return An array of 16 floats representing the transformation matrix
|
||||
*/
|
||||
const float* GetMatrix();
|
||||
|
||||
private:
|
||||
// TODO: Separate translation, rotation and scaling matrices.
|
||||
// Combine them only when the user wants the transformation matrix
|
||||
float* translation; ///< Translation matrix
|
||||
float* rotation; ///< Rotation matrix
|
||||
float* scaling; ///< Scaling matrix
|
||||
|
||||
bool calculateMatrix; ///< Wether GetMatrix() needs to re-calculate the transformation matrix
|
||||
};
|
||||
}
|
||||
|
||||
#endif
|
||||
Loading…
Add table
Add a link
Reference in a new issue