AmnesiaAMachineForPigs/HPL2/core/include/scene/Node3D.h

/*
 * Copyright © 2011-2020 Frictional Games
 * 
 * This file is part of Amnesia: A Machine For Pigs.
 * 
 * Amnesia: A Machine For Pigs is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version. 

 * Amnesia: A Machine For Pigs is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Amnesia: A Machine For Pigs.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef HPL_NODE3D_H
#define HPL_NODE3D_H

#include "math/MathTypes.h"
#include "scene/SceneTypes.h"

namespace hpl {

	class cNode3D
	{
		friend class iEntity3D;
	public:
		cNode3D(const tString &asName="", bool abAutoDeleteChildren = true);
		virtual ~cNode3D();

		///////////////////////
		// Hierarchy
		bool AddEntity(iEntity3D* apEntity);
		bool RemoveEntity(iEntity3D* apEntity);
		void ClearEntities();
		
		cNode3D* GetParent();
		
		cNode3DIterator GetChildIterator();
		tNode3DList* GetChildList(){ return &mlstNode;}

		cEntity3DIterator GetEntityIterator();

		cNode3D* CreateChild(const tString &asName="", bool abAutoDeleteChildren = true);
		void RemoveChild(cNode3D* apNode);


		//Extra stuff that shouldn't be used externally
		void SetParent(cNode3D* apNode);
		void AddChild(cNode3D* apChild);
		
		///////////////////////
		//Properties
		const tString& GetName();

		void SetActive(bool abX){mbActive = abX;}
		bool IsActive(){return mbActive;}

		int SetVisible(bool abX, bool abCascade);
		
		cVector3f GetLocalPosition();
		cMatrixf& GetLocalMatrix();

		cVector3f GetWorldPosition();
		cMatrixf& GetWorldMatrix();

		void SetPosition(const cVector3f& avPos);
		void SetMatrix(const cMatrixf& a_mtxTransform, bool abSetChildrenUpdated=true);

		void SetWorldPosition(const cVector3f& avWorldPos);
		void SetWorldMatrix(const cMatrixf& a_mtxWorldTransform);

		void AddRotation(const cVector3f& avRot, eEulerRotationOrder aOrder);
		void AddRotation(const cQuaternion& aqRotation);

		void AddScale(const cVector3f& avScale);

		void AddTranslation(const cVector3f& avTrans);

		bool GetUsePreAnimTransform(){ return mbUsePostTransform;}
		bool GetUsePostAnimTransform(){ return mbUsePostTransform;}
		const cMatrixf& GetPreAnimTransform(){ return m_mtxPostTransform;}
		const cMatrixf& GetPostAnimTransform(){ return m_mtxPostTransform;}
		
		void SetUsePreTransform(bool abX){ mbUsePreTransform = abX;}
		void SetUsePostTransform(bool abX){ mbUsePostTransform = abX;}
		void SetPreTransform(const cMatrixf& a_mtxTransform){ m_mtxPreTransform = a_mtxTransform;}
		void SetPostTransform(const cMatrixf& a_mtxTransform){ m_mtxPostTransform = a_mtxTransform;}
		
		/**
		 * Applies the pre and post transforms to current matrix
		 */
		void ApplyPreAnimTransform(bool abSetChildrenUpdated);
		void ApplyPostAnimTransform(bool abSetChildrenUpdated);

		void SetCustomFlags(int alX){ mlCustomFlags = alX;}
		int GetCustomFlags(){ return mlCustomFlags;}
		
		/**
		 * Updates the matrix with the added scales, translations and rotation. It also resets these values.
		 */
		void UpdateMatrix(bool abSetChildrenUpdated);

		void UpdateWorldTransform();
		void SetWorldTransformUpdated();

		void UpdateEntityChildren();
	private:
		tString msName;
		bool mbActive;
		
		int mlCustomFlags;

		bool mbAutoDeleteChildren;

		cMatrixf m_mtxLocalTransform;
		cMatrixf m_mtxWorldTransform;

		cVector3f mvWorldPosition;

		bool mbUsePreTransform;
		bool mbUsePostTransform;
		
		cMatrixf m_mtxPreTransform;
		cMatrixf m_mtxPostTransform;

		cQuaternion mqRotation;
		cVector3f mvScale;
		cVector3f mvTranslation;

		bool mbTransformUpdated;

		cNode3D* mpParent;
		iEntity3D* mpEntityParent;

		tEntity3DList mlstEntity;
		tNode3DList mlstNode;
	};

};
#endif // HPL_NODE3D_H