MTMatrixTransform.h

Go to the documentation of this file.

#ifndef MTMATRIXTRANSFORM_H
#define MTMATRIXTRANSFORM_H


// MTMatrixTransform = Multi-threaded Matrix Transform
// This ability stores a copy of the transformation matrix that is present
// in every EnvironmentObject. The copy of matrix present in the ability
// is possible to update from any thread and as often as necessary (hundreds/thousands
// timer per frame).
// The changes are automatically transferred to the main matrix once per frame.


#include <vrecko/Ability.h>
#include <vrecko/MTLock.h>
#include <vrecko/IOPins.h>
#include <osg/Group>


using namespace vrecko;


namespace base
{

#ifdef AP_BASE_EXPORTS
    #define MTMATRIXTRANSFORM_IMP_EXP __declspec(dllexport)
#else
    #define MTMATRIXTRANSFORM_IMP_EXP __declspec(dllimport)
#endif


    class MTMATRIXTRANSFORM_IMP_EXP MTMatrixTransform: public Ability
    {
    public:
        MTMatrixTransform();
        virtual ~MTMatrixTransform();

        virtual void preInitialize();
        virtual void update();
            // Runs once per frame (LATE in the frame) and synchronizes main object transformation
            // with the local matrix copy.
        
        bool getMatrix(osg::Matrix *pMatrix);
        void setMatrix(osg::Matrix *newMatrix);

        bool getWorldTransformation(osg::Matrix *pMatrix);
            // calculates the world transformation using the stored matrix (instead of the object main transformation)

    protected:
        EnvironmentObject *owner;
        osg::Matrix matrix;
        bool bRetrieved; // matrix already retrieved from the owner object?
        bool bUpdated;  // a call to local setMatrix() occured, so we should update
                        // the main object transformation at the end of the frame?

        MTReadWriteLockEx generalLock;

        DECLARE_REQUEST_INPUT(SetMatrix, MessageMatrix, MessageVoid);
        DECLARE_REQUEST_INPUT(GetMatrix, MessageVoid, MessageMatrix);
    };
}

#endif