XformMatrix.h

Go to the documentation of this file.

/*

License

Menge
Copyright © and trademark ™ 2012-14 University of North Carolina at Chapel Hill. 
All rights reserved.

Permission to use, copy, modify, and distribute this software and its documentation 
for educational, research, and non-profit purposes, without fee, and without a 
written agreement is hereby granted, provided that the above copyright notice, 
this paragraph, and the following four paragraphs appear in all copies.

This software program and documentation are copyrighted by the University of North 
Carolina at Chapel Hill. The software program and documentation are supplied "as is," 
without any accompanying services from the University of North Carolina at Chapel 
Hill or the authors. The University of North Carolina at Chapel Hill and the 
authors do not warrant that the operation of the program will be uninterrupted 
or error-free. The end-user understands that the program was developed for research 
purposes and is advised not to rely exclusively on the program for any reason.

IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS 
BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL 
DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS 
DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE 
AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY 
DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY 
OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND 
THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS 
TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu

*/

#ifndef __XFORMMATRIX_H__
#define __XFORMMATRIX_H__

#include "CoreConfig.h"
#include "graphCommon.h"
#include <iostream>

namespace Menge {

    namespace SceneGraph {

        class Transform;

        class MENGE_API XformMatrix {
        public:
            XformMatrix();
            
            void setTranslation( const Vector3 & vec ) { _trans = vec; setDirty( MAT | IMAT ); }
            
            void addTranslation( const Vector3 & vec ) { _trans += vec; setDirty( MAT | IMAT ); }
            
            void setScale( const Vector3 & vec ) { _scale = vec; setDirty( MAT | IMAT ); }
            
            void setRotationDeg( const Vector3 & vec ) { _rot = vec * DEG_TO_RAD; setDirty(); }

            void setRotationRad( const Vector3 & vec ) { _rot = vec; setDirty(); }

            void addRotationDeg( const Vector3 & vec ) { _rot.SumScale( DEG_TO_RAD, vec ); setDirty(); }
            
            void addRotationRad( const Vector3 & vec ) { _rot += vec; setDirty(); }
            
            void setRotAxisDeg( const Vector3 & vec );
            
            void setRotAxisRad( const Vector3 & vec );

            //void rotatePivotMatrix( Matrix4x4 & mat );
            void translationMatrix( Matrix4x4 & mat );
            
            void translationInverseMatrix( Matrix4x4 & mat );
            
            void scaleMatrix( Matrix4x4 & mat );
            
            void scaleInverseMatrix( Matrix4x4 & mat );
            
            void rotationMatrix( Matrix4x4 & mat );
            
            void rotationInverseMatrix( Matrix4x4 & mat );

            void getMatrix( Matrix4x4 & mat );
            
            void getInverseMatrix( Matrix4x4 & mat );

            friend class Transform; 

            friend Logger & operator << ( Logger & out, const XformMatrix & xformMat );

        protected:

            Vector3 _trans; 
            
            Vector3 _scale; 
            
            Vector3 _rot;   
            
            Vector3 _rotAxis;   

            Matrix4x4   _rotAxisMat;
            
            Matrix4x4   _rotAxisIMat;

            enum MatrixBit {
                ROT_MAT = 1,    // rotation matrix
                MAT = 2,        // full matrix
                IMAT = 4        // inverse matrix
            };

            int     _clean;

            Matrix4x4   _rotMat;
            
            Matrix4x4   _mat;
            
            Matrix4x4   _iMat;

            void updateRotAxisMat();

            inline void setDirty() { _clean = 0; }
            
            inline void setDirty( int bit ) { _clean &= ~bit; }
            
            inline void setDirty( MatrixBit bit ) { _clean &= (int)(~bit); }
            
            inline bool isClean( MatrixBit bit ) { return ( _clean & (int)bit ) != 0x0; }
            
            inline void setClean( MatrixBit bit ) { _clean |= (int)bit; }
            
            inline void setClean( int bit ) { _clean |= bit; }
        };
    }   // namespace SceneGraph
}   // namespace Menge
#endif  // __XFORMMATRIX_H__