gzFrame.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzFrame.h
// Module       : 
// Description  : Class definition of the gzFrame 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  990519  Created file 
// AMO  000516  Updated with CYCLE and SWING modes  
//
//******************************************************************************
#ifndef __GZ_FRAME_H__
#define __GZ_FRAME_H__

#include "gzGroup.h"

typedef enum    { 
                    GZ_FRAME_CYCLE , 
                    GZ_FRAME_SWING 

                } gzFrameType;

//******************************************************************************
// Class    : gzFrame
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990519  Created 
//                                  
//******************************************************************************
class gzFrame : public gzGroup
{
public:
    GZ_GRAPH_EXPORT gzFrame(const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzFrame(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface


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

    // ---------- gzFrame commands --------------------------------------

    GZ_GRAPH_EXPORT gzVoid  startFrameCounter(const gzDouble &startTime=0);
    GZ_GRAPH_EXPORT gzVoid  stopFrameCounter();

    GZ_GRAPH_EXPORT gzBool  isRunning();    

    // ---------- Equal Frame Duration ----------------------------------
    GZ_GRAPH_EXPORT gzVoid      setFrameDuration(gzDouble length);
    GZ_GRAPH_EXPORT gzDouble    getFrameDuration();

    // ---------- Non Equal frame Duration ------------------------------
    GZ_GRAPH_EXPORT gzVoid      setFrameDuration(gzULong frame , gzDouble length);
    GZ_GRAPH_EXPORT gzDouble    getFrameDuration(gzULong frame);

    // ---------- Common settings ---------------------------------------
    GZ_GRAPH_EXPORT gzVoid      setFrameType(gzFrameType type);
    GZ_GRAPH_EXPORT gzFrameType getFrameType();

    GZ_GRAPH_EXPORT gzVoid      selectChildPerFrame(gzBool flag);
    GZ_GRAPH_EXPORT gzBool      selectChildPerFrame();

    GZ_GRAPH_EXPORT gzVoid      setNumberOfFrames( gzULong count);
    GZ_GRAPH_EXPORT gzULong     getNumberOfFrames();

    GZ_GRAPH_EXPORT gzVoid      setStartFrameOffset( gzULong count);
    GZ_GRAPH_EXPORT gzULong     getStartFrameOffset();

    GZ_GRAPH_EXPORT gzVoid      setFrameIndex( gzULong index);
    GZ_GRAPH_EXPORT gzULong     getFrameIndex();

    GZ_GRAPH_EXPORT gzVoid      setNextFrameIndex( gzULong index);
    GZ_GRAPH_EXPORT gzULong     getNextFrameIndex();

    GZ_GRAPH_EXPORT gzVoid      setFrameFraction(gzDouble fraction);
    GZ_GRAPH_EXPORT gzDouble    getFrameFraction();

    GZ_GRAPH_EXPORT gzVoid      setRepeatCount(gzULong repeatCount);
    GZ_GRAPH_EXPORT gzVoid      setSpeedFactor(gzDouble factor);

    // ----------- gzGroup interface ------------------------------------

    GZ_GRAPH_EXPORT virtual gzBool  isChildOrderDependant();

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

    GZ_GRAPH_EXPORT virtual gzBool isTraversable( gzTraverseAction *action , gzNode *node , gzULong index, gzContext *context);
    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);
    GZ_GRAPH_EXPORT virtual gzVoid postTraverseAction( gzTraverseAction *actionclass , gzContext *context);

private:
        
    gzULong                     m_frameIndex;
    gzULong                     m_nextFrameIndex;
    gzULong                     m_startFrameOffset; 
    gzULong                     m_frames;
    gzULong                     m_repeatCount;

    gzBool                      m_running:1;
    gzBool                      m_uniformFrames:1;
    gzBool                      m_selectChildPerFrame:1;
    gzBool                      m_calculatedSweepTime:1;

    gzDynamicArray<gzDouble>    m_frameLength;

    gzDouble                    m_frameFraction;
    gzDouble                    m_sweepTime;
    gzDouble                    m_startTime;
    gzDouble                    m_speedFactor;
    gzFrameType                 m_frameType;
};

//******************************************************************************
// Class    : gzActiveFrame
//                                  
// Purpose  : Hold frame activation
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990607  Created 
//                                  
//******************************************************************************
class gzActiveFrame
{
public:
    gzActiveFrame():isActive(FALSE){};
    gzBool  isActive;
};

//******************************************************************************
// Class    : gzFrameKey
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990607  Created 
//                                  
//******************************************************************************
class gzFrameKey : public gzGroup
{
public:
    GZ_GRAPH_EXPORT gzFrameKey(const gzString & name=GZ_EMPTY_STRING);

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface


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

    // ---------- gzFrame commands -------------------------------------

    GZ_GRAPH_EXPORT gzVoid  activateFrame( gzULong count);
    GZ_GRAPH_EXPORT gzVoid  deactivateFrame( gzULong count);


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

    GZ_GRAPH_EXPORT virtual gzBool isTraversable( gzTraverseAction *action , gzNode *node , gzULong index, gzContext *context);

private:
    gzDynamicArray<gzActiveFrame>   m_activeFrames;
};

#endif

---