gzTransform.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzTransform.h
// Module       : 
// Description  : Class definition of the gzTransform class
// Author       : Anders Modén      
// Product      : Gizmo3D 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden
//          
// NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
//          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
//          usage in Game or VisSim development.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981122  Created file    
// LJH  041019  Added online comments
//
//******************************************************************************
#ifndef __GZ_TRANSFORM_H__
#define __GZ_TRANSFORM_H__

#include "gzGroup.h"

//******************************************************************************
// Class    : gzTransform
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981209  Created 
//                                  
//******************************************************************************
class gzTransform : public gzGroup 
{
public:

    GZ_GRAPH_EXPORT gzTransform(const gzString & name=GZ_EMPTY_STRING);
    GZ_GRAPH_EXPORT virtual ~gzTransform(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface


    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    // ---------- Common Transform functions ----------------------------


    GZ_GRAPH_EXPORT virtual gzVoid updateNode();


    GZ_GRAPH_EXPORT gzVoid  reset(gzBool resetTransform=TRUE,gzBool resetAxis=FALSE);   

    

    GZ_GRAPH_EXPORT gzBool  isActive();


    GZ_GRAPH_EXPORT gzVoid  useAccumulatedTransform(gzBool on);

    GZ_GRAPH_EXPORT gzBool  useAccumulatedTransform() const;

    GZ_GRAPH_EXPORT gzVoid  setBaseID(gzULong id=0);
    GZ_GRAPH_EXPORT gzULong getBaseID();

    // ---------- additive commands -------------------------------------

    // Note that additive commands are reset by absolute commands

    //* Rotation about the vector specified in degrees
    GZ_GRAPH_EXPORT gzVoid  rotate(const gzVec3 &vector , gzReal rotation); 

    GZ_GRAPH_EXPORT gzVoid  rotateHPR(gzReal heading , gzReal pitch , gzReal roll);

    GZ_GRAPH_EXPORT gzVoid  translate( gzReal dx , gzReal dy , gzReal dz ); 
    GZ_GRAPH_EXPORT gzVoid  scale( gzReal sx , gzReal sy , gzReal sz ); 
    GZ_GRAPH_EXPORT gzVoid  scale( gzReal s); 
    /*
    Scale the transform to the unit 1. The bounding sphere gets a radius of size SQRT(2).
    */
    GZ_GRAPH_EXPORT gzVoid  unitScale();

    // ---------- absolute commands -------------------------------------
    

    GZ_GRAPH_EXPORT gzVoid  setDirection(const gzVec3 &targetvector, gzReal roll , const gzVec3 &up=gzVec3(0,1,0));

    GZ_GRAPH_EXPORT gzVoid  setRotation(const gzVec3 &targetvector, gzReal rotation);


    GZ_GRAPH_EXPORT gzVoid  setHPR( gzReal heading , gzReal pitch , gzReal roll);


    GZ_GRAPH_EXPORT gzVoid  setTranslation( gzReal dx , gzReal dy , gzReal dz );

    GZ_GRAPH_EXPORT gzVoid  setScale( gzReal sx , gzReal sy , gzReal sz );

    GZ_GRAPH_EXPORT gzVoid  setScale( gzReal s );


    GZ_GRAPH_EXPORT gzVoid  setOrigin( gzReal ox , gzReal oy , gzReal oz , gzBool updateAbsolute=TRUE);


    GZ_GRAPH_EXPORT gzVoid  setBaseAxis( const gzVec3 &x_axis , const gzVec3 &y_axis , const gzVec3 &z_axis , gzBool updateAbsolute=TRUE);

    
    // ---------- vector variants ---------------------------------------
    

    GZ_GRAPH_EXPORT gzVoid  setTranslation( const gzVec3 &xyz_trans );

    GZ_GRAPH_EXPORT gzVoid  setScale(       const gzVec3 &xyz_scale );


    GZ_GRAPH_EXPORT gzVoid  setOrigin(      const gzVec3 &xyz_origin , gzBool updateAbsolute=TRUE);


    GZ_GRAPH_EXPORT gzVoid  setHPR(         const gzVec3 &xyz_hpr );

    // ---------- get data commands -------------------------------------

    GZ_GRAPH_EXPORT gzBool  getScale( gzReal &sx , gzReal &sy , gzReal &sz );
    GZ_GRAPH_EXPORT gzBool  hasScale();

    GZ_GRAPH_EXPORT gzBool  getHPR(gzReal &heading , gzReal &pitch , gzReal &roll);
    
    GZ_GRAPH_EXPORT gzBool  hasHPR();

    GZ_GRAPH_EXPORT gzBool  getTranslation( gzReal &dx , gzReal &dy , gzReal &dz );
    GZ_GRAPH_EXPORT gzBool  hasTranslation();

    GZ_GRAPH_EXPORT gzBool  getOrigin( gzReal &ox , gzReal &oy , gzReal &oz );
    GZ_GRAPH_EXPORT gzBool  hasOrigin();

    GZ_GRAPH_EXPORT gzBool  getBaseAxis( gzVec3 &x_axis , gzVec3 &y_axis , gzVec3 &z_axis );
    GZ_GRAPH_EXPORT gzBool  hasBaseAxis();

    // ---------- vector variants ---------------------------------------

    GZ_GRAPH_EXPORT gzBool  getTranslation( gzVec3 &translation );

    // ---------- direct transform manipulation ------------------------

    GZ_GRAPH_EXPORT gzMatrix4 & getTransform();

    GZ_GRAPH_EXPORT gzVoid      setTransform(const gzMatrix4 &transform);

    GZ_GRAPH_EXPORT gzVoid      accumulate(const gzMatrix4 &mulTransform);


    // ----------- tweak the scale radius for bounding spheres

    GZ_GRAPH_EXPORT gzVoid      setMaxScale(const gzReal &maxScale);
    
    GZ_GRAPH_EXPORT gzReal      getMaxScale();


    GZ_GRAPH_EXPORT static gzVoid   setCurrentMaxScale( gzContext *context , gzReal scale );


    GZ_GRAPH_EXPORT static gzMatrix4 & getCurrentInvertedTransform(gzContext *context);
    

    GZ_GRAPH_EXPORT static gzVoid   resetIndex(gzContext *context);


    GZ_GRAPH_EXPORT static gzVoid   resetPostIndex( gzContext *context );


    GZ_GRAPH_EXPORT static gzVoid   activateIndex(gzContext *context , gzULong index);


    GZ_GRAPH_EXPORT static gzVoid   activateCompiledIndex(gzContext *context , gzULong index);


    // ---------- Action Interface --------------------------------------
    
    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);
    
    GZ_GRAPH_EXPORT virtual gzVoid postTraverseAction( gzTraverseAction *actionclass , gzContext *context);

        // ---------- Serializing -------------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid write(gzSerializeAdapter *adapter);
    
    GZ_GRAPH_EXPORT virtual gzVoid read(gzSerializeAdapter *adapter);
    

    GZ_GRAPH_EXPORT virtual gzULong getDataSize(gzSerializeAdapter *adapter) const;

    // ---------- Debug function ----------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid  debugOutput(gzString base , gzString anchor , gzDebugFlags features);

    // --------- Utilties -----------------------------------------------

    GZ_GRAPH_EXPORT static gzTransform * getClosestTransform(gzNode *node);
    

    GZ_GRAPH_EXPORT static gzMatrix4 getAccumTransform(gzNode *node);


protected:

    GZ_GRAPH_EXPORT gzVoid calculateTransform();
    GZ_GRAPH_EXPORT gzVoid calculateMaxScale();

    gzMatrix4               m_transformMatrix;
    gzReal                  m_maxScale;

    gzLateBindData<gzVec3>      m_orientation;
    gzLateBindData<gzVec3>      m_scale;
    gzLateBindData<gzVec3>      m_translation;
    gzLateBindData<gzVec3>      m_origo;
    gzLateBindData<gzMatrix3>   m_base;

    gzULong                     m_baseID;

    gzUByte                 m_accum:1;
    gzUByte                 m_isActive:1;

};

// Declare smart pointer type
GZ_DECLARE_REFPTR(gzTransform);

//******************************************************************************
// Class    : gzFrameTransformKeyTranslation
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981209  Created 
//                                  
//******************************************************************************
class gzFrameTransformKeyTranslation : public gzReference
{
public:
    GZ_GRAPH_EXPORT gzFrameTransformKeyTranslation();

    GZ_GRAPH_EXPORT virtual ~gzFrameTransformKeyTranslation();
    
    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

private:
    friend class gzFrameTransform;

    gzULong m_frame;
    gzVec3  m_position;
};

//******************************************************************************
// Class    : gzFrameTransformKeyScale
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981209  Created 
//                                  
//******************************************************************************
class gzFrameTransformKeyScale : public gzReference
{
public:

    GZ_GRAPH_EXPORT gzFrameTransformKeyScale();

    GZ_GRAPH_EXPORT virtual ~gzFrameTransformKeyScale();

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

private:
    friend class gzFrameTransform;

    gzULong m_frame;
    gzVec3  m_scale;
};

//******************************************************************************
// Class    : gzFrameTransformKeyRotation
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981209  Created 
//                                  
//******************************************************************************
class gzFrameTransformKeyRotation : public gzReference
{
public:
    GZ_GRAPH_EXPORT gzFrameTransformKeyRotation();

    GZ_GRAPH_EXPORT virtual ~gzFrameTransformKeyRotation();

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

private:
    friend class gzFrameTransform;

    gzULong m_frame;
    
    gzMatrix4 m_accumRot;


    gzVec3  m_rotVector;
    gzReal  m_angle;
};

//******************************************************************************
// Class    : gzFrameTransform
//                                  
// Purpose  : Frame programmable transforms
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981209  Created 
//                                  
//******************************************************************************

class gzFrameTransform : public gzTransform
{
public:

    GZ_GRAPH_EXPORT gzFrameTransform(const gzString & name=GZ_EMPTY_STRING);
    GZ_GRAPH_EXPORT virtual ~gzFrameTransform(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT gzFrameTransform(const gzFrameTransform &copy);
    
    GZ_GRAPH_EXPORT gzFrameTransform & operator=(const gzFrameTransform &copy);

    // ---------- Common graph functions --------------------------------


    GZ_GRAPH_EXPORT virtual gzVoid updateNode();

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    // ---------- Action Interface --------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    // ---------- gzFrameTransform Interface ----------------------------
    
    GZ_GRAPH_EXPORT gzULong getStartFrame();
    GZ_GRAPH_EXPORT gzULong getLastFrame();
    GZ_GRAPH_EXPORT gzBool  hasFrames();


    GZ_GRAPH_EXPORT gzMatrix4 getFrameTransform(gzULong frame );

    GZ_GRAPH_EXPORT gzVoid setFrameTranslation(gzULong frame , gzReal x , gzReal y , gzReal z ); 
    
    GZ_GRAPH_EXPORT gzVoid setFrameScale(gzULong frame , gzReal sx , gzReal sy , gzReal sz ); 
    
    GZ_GRAPH_EXPORT gzVoid setFrameRotation(gzULong frame , const gzVec3 &vector , gzReal angle); 


    GZ_GRAPH_EXPORT gzVoid setFrameHPR(gzULong frame , gzReal heading , gzReal pitch , gzReal roll , const gzVec3 &base=GZ_ONE_VEC3);
    

    GZ_GRAPH_EXPORT gzVoid setFrameRotateTransform(gzULong frame , const gzMatrix4 & transform);

    GZ_GRAPH_EXPORT gzBool getFrameTranslation(gzULong frame , gzReal &x , gzReal &y , gzReal &z ); 
    
    GZ_GRAPH_EXPORT gzBool getFrameScale(gzULong frame , gzReal &x , gzReal &y , gzReal &z ); 
    
    GZ_GRAPH_EXPORT gzBool getFrameRotation(gzULong frame , gzVec3 &vector , gzReal &angle); 

    GZ_GRAPH_EXPORT gzULong getStartTranslationFrame();
    
    GZ_GRAPH_EXPORT gzULong getLastTranslationFrame();
    
    GZ_GRAPH_EXPORT gzBool  hasTranslationFrames();


    GZ_GRAPH_EXPORT gzULong getStartScaleFrame();
    
    GZ_GRAPH_EXPORT gzULong getLastScaleFrame();
    
    GZ_GRAPH_EXPORT gzBool  hasScaleFrames();


    GZ_GRAPH_EXPORT gzULong getStartRotationFrame();
    
    GZ_GRAPH_EXPORT gzULong getLastRotationFrame();
    
    GZ_GRAPH_EXPORT gzBool  hasRotationFrames();
    

    GZ_GRAPH_EXPORT gzVoid calculateRotations();


    GZ_GRAPH_EXPORT gzVoid setAccumulativeRotations(gzBool on=TRUE);

    GZ_GRAPH_EXPORT gzVoid enableFrameUpdates(gzBool on=TRUE);

private:

    gzBoundary getFrameBoundary(gzULong frame);

    gzRefDList<gzFrameTransformKeyTranslation>  m_keyListTranslation;
    gzRefDList<gzFrameTransformKeyScale>        m_keyListScale;
    gzRefDList<gzFrameTransformKeyRotation>     m_keyListRotation;

    gzDListIterator<gzFrameTransformKeyTranslation> m_currentKeyTranslation;
    gzDListIterator<gzFrameTransformKeyScale>       m_currentKeyScale;
    gzDListIterator<gzFrameTransformKeyRotation>    m_currentKeyRotation;

    gzDListIterator<gzFrameTransformKeyTranslation> m_currentNextKeyTranslation;
    gzDListIterator<gzFrameTransformKeyScale>       m_currentNextKeyScale;
    gzDListIterator<gzFrameTransformKeyRotation>    m_currentNextKeyRotation;


    gzFrameTransformKeyTranslation  *getKeyTranslation(gzULong frame);
    gzFrameTransformKeyScale        *getKeyScale(gzULong frame);
    gzFrameTransformKeyRotation     *getKeyRotation(gzULong frame);

    gzFrameTransformKeyTranslation  *getNextKeyTranslation(gzULong frame);
    gzFrameTransformKeyScale        *getNextKeyScale(gzULong frame);
    gzFrameTransformKeyRotation     *getNextKeyRotation(gzULong frame);

    gzBool  m_accumRotations;
    gzBool  m_isFrameUpdateEnabled;
};


//******************************************************************************
// Class    : gzTransformBase
//                                  
// Purpose  : reset the base id and the base id count for transforms
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  040803  Created 
//                                  
//******************************************************************************

class gzTransformBase : public gzGroup
{
public:

    GZ_GRAPH_EXPORT gzTransformBase(const gzString & name=GZ_EMPTY_STRING);
    GZ_GRAPH_EXPORT virtual ~gzTransformBase(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    // ---------- Action Interface --------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    GZ_GRAPH_EXPORT virtual gzVoid postTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    // ---------- Render control -----------------------------------------------

    GZ_GRAPH_EXPORT static gzVoid activateIndex( gzContext *context , gzULong index);


    GZ_GRAPH_EXPORT static gzVoid resetIndex( gzContext *context );


    // ---------- Interface ----------------------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setNumberOfBases(gzULong count=0);

    GZ_GRAPH_EXPORT gzULong getNumberOfBases();

private:

    gzULong     m_numberOfBases;
};


//******************************************************************************
// Class    : gzTransformID
//                                  
// Purpose  : Used by the gzBaseTransform to keep track of transform IDs
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  040803  Created 
//                                  
//******************************************************************************
class gzTransformID
{
public:

    gzTransformID():currentTransformIndex(0),
                    numberOfBases(0),
                    accumTransformChecksum(0),
                    transformChecksum(0),
                    currentTransformChecksum(0),
                    changedMatrix(TRUE),
                    hasNormal(FALSE){};
    
    gzULong     currentTransformIndex;
    gzULong     numberOfBases;
    gzULong     accumTransformChecksum;
    gzULong     transformChecksum;
    gzULong     currentTransformChecksum;

    gzBool      changedMatrix;
    gzBool      hasNormal;
    

    gzMatrix4   mat;
    gzMatrix4   norm;
};

#endif

---