BansheeEngine/Source/BansheeCore/Scene/BsTransform.h

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
#pragma once

#include "BsCorePrerequisites.h"
#include "Math/BsMatrix4.h"
#include "Math/BsVector3.h"
#include "Math/BsQuaternion.h"
#include "Reflection/BsRTTIType.h"

namespace bs
{
	/** @addtogroup Scene
	 *  @{
	 */

	/** 
	 * Contains information about 3D object's position, rotation and scale, and provides methods to manipulate it. 
	 */
	class BS_CORE_EXPORT Transform : public IReflectable
	{
	public:
		Transform();

		/**	Sets the local position of the object. */
		void setPosition(const Vector3& position) { mPosition = position; }

		/**	Gets the local position of the object. */
		const Vector3& getPosition() const { return mPosition; }

		/** Shorthand for getPosition(). */
		const Vector3& pos() const { return mPosition; }

		/**	Sets the local rotation of the object. */
		void setRotation(const Quaternion& rotation) { mRotation = rotation; }

		/**	Gets the local rotation of the object. */
		const Quaternion& getRotation() const { return mRotation; }

		/** Shorthand for getRotation(). */
		const Quaternion& rot() const { return mRotation; }

		/**	Sets the local scale of the object. */
		void setScale(const Vector3& scale) { mScale = scale; }

		/**	Gets the local scale of the object. */
		const Vector3& getScale() const { return mScale; }

		/** Shorthand for getScale(). */
		const Vector3& scl() const { return mScale; }

		/** 
		 * Converts the provided world position to a space relative to the provided parent, as sets it as the current
		 * transform's position. 
		 */
		void setWorldPosition(const Vector3& position, const Transform& parent);

		/** 
		 * Converts the provided world rotation to a space relative to the provided parent, as sets it as the current
		 * transform's rotation. 
		 */
		void setWorldRotation(const Quaternion& rotation, const Transform& parent);

		/** 
		 * Converts the provided world scale to a space relative to the provided parent, as sets it as the current
		 * transform's scale. 
		 */
		void setWorldScale(const Vector3& scale, const Transform& parent);

		/** Builds the transform matrix from current properties. */
		Matrix4 getMatrix() const;

		/** Builds the inverse transform matrix from current properties. */
		Matrix4 getInvMatrix() const;

		/** 
		 * Makes the current transform relative to the provided transform. In another words, converts from a world 
		 * coordinate system to one local to the provided transform. 
		 */
		void makeLocal(const Transform& parent);

		/**
		 * Makes the current transform absolute. In another words, converts from a local coordinate system relative to
		 * the provided transform, to a world coordinate system.
		 */
		void makeWorld(const Transform& parent);

		/**
		 * Orients the object so it is looking at the provided @p location (world space) where @p up is used for 
		 * determining the location of the object's Y axis.
		 */
		void lookAt(const Vector3& location, const Vector3& up = Vector3::UNIT_Y);

		/**	Moves the object's position by the vector offset provided along world axes. */
		void move(const Vector3& vec);

		/**	Moves the object's position by the vector offset provided along it's own axes (relative to orientation). */
		void moveRelative(const Vector3& vec);

		/**
		 * Gets the Z (forward) axis of the object.
		 *
		 * @return	Forward axis of the object.
		 */
		Vector3 getForward() const { return getRotation().rotate(-Vector3::UNIT_Z); }

		/**
		 * Gets the Y (up) axis of the object.
		 *
		 * @return	Up axis of the object.
		 */
		Vector3 getUp() const { return getRotation().rotate(Vector3::UNIT_Y); }

		/**
		 * Gets the X (right) axis of the object.
		 *
		 * @return	Right axis of the object.
		 */
		Vector3 getRight() const { return getRotation().rotate(Vector3::UNIT_X); }

		/**
		 * Rotates the game object so it's forward axis faces the provided direction.
		 *
		 * @param[in]	forwardDir	The forward direction to face.
		 *
		 * @note	Local forward axis is considered to be negative Z.
		 */
		void setForward(const Vector3& forwardDir);

		/**	Rotate the object around an arbitrary axis. */
		void rotate(const Vector3& axis, const Radian& angle);

		/**	Rotate the object around an arbitrary axis using a Quaternion. */
		void rotate(const Quaternion& q);

		/**
		 * Rotates around local Z axis.
		 *
		 * @param[in]	angle	Angle to rotate by.
		 */
		void roll(const Radian& angle);

		/**
		 * Rotates around Y axis.
		 *
		 * @param[in]	angle	Angle to rotate by.
		 */
		void yaw(const Radian& angle);

		/**
		 * Rotates around X axis
		 *
		 * @param[in]	angle	Angle to rotate by.
		 */
		void pitch(const Radian& angle);
	private:
		Vector3 mPosition;
		Quaternion mRotation;
		Vector3 mScale;

		/************************************************************************/
		/* 								RTTI		                     		*/
		/************************************************************************/
	public:
		friend class TransformRTTI;
		static RTTITypeBase* getRTTIStatic();
		RTTITypeBase* getRTTI() const override;
	};

	/** @} */
}