gzDynUpdateInterface.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzDynUpdateInterface.h
// Module       : gzDynamics
// Description  : Definition of update interface
// Author       : Anders Modén
// Product      : GizmoDynamics 2.5.4
//      
// Copyright © 2004 - Saab Training Systems AB, Sweden
//          
// NOTE:    GizmoDynamics is a toolkit used for dynamic updates (events <-> objects)
//          in GizmoDistribution
//
//
// Revision History...
//
// Who  Date    Description
//
// AMO  060315  Created file
//
//******************************************************************************
#ifndef __GZ_DYN_UPDATE_INTERFACE_H__
#define __GZ_DYN_UPDATE_INTERFACE_H__

#include "gzDynBase.h"

enum gzDynUpdateMode
{
    GZ_DUM_FULL,
    GZ_DUM_PARTIAL,
    GZ_DUM_NONE
};

struct gzDynUpdateInfo 
{
    gzDouble    time;
    gzDouble    eventTime;
    gzGUID      objectID;
    gzDistEvent *event;
};

class GZ_DYN_EXPORT gzDynEventSort
{
public:

    gzDynEventSort(const gzDouble &_time=0.0 , const gzULong &_typeIndex=0 , const gzULong &_eventIndex=0):time(_time),typeIndex(_typeIndex),eventIndex(_eventIndex){}

    gzBool operator !=(const gzDynEventSort &right) const
    {
        if(time!=right.time)
            return TRUE;

        if(typeIndex!=right.typeIndex)
            return TRUE;

        if(eventIndex!=right.eventIndex)
            return TRUE;

        return FALSE;
    }

    gzBool operator ==(const gzDynEventSort &right) const
    {
        return !operator!=(right);
    }

    gzBool operator <(const gzDynEventSort &right) const
    {
        if(time<right.time)
            return TRUE;

        if(time>right.time)
            return FALSE;

        if(typeIndex<right.typeIndex)
            return TRUE;

        if(typeIndex>right.typeIndex)
            return FALSE;

        if(eventIndex<right.eventIndex)
            return TRUE;

        return FALSE;
    }

    gzBool operator >(const gzDynEventSort &right) const
    {
        if(time>right.time)
            return TRUE;

        if(time<right.time)
            return FALSE;

        if(typeIndex>right.typeIndex)
            return TRUE;

        if(typeIndex<right.typeIndex)
            return FALSE;

        if(eventIndex>right.eventIndex)
            return TRUE;

        return FALSE;
    }

    gzDouble    time;
    gzULong     typeIndex;
    gzULong     eventIndex;
};


class gzDynUpdateInterface 
{
public:

    // get event object handle

    GZ_DYN_EXPORT virtual gzDistObject *getObject(const gzGUID &objectID){ return NULL; }

    GZ_DYN_EXPORT virtual gzVoid setUpObject(const gzGUID &objectID,gzDistObject *object){}

    // ---------- process object updates -------------------

    GZ_DYN_EXPORT virtual gzDynUpdateMode processEventAttributes( const gzDynUpdateInfo &info ){ return GZ_DUM_FULL; }

    GZ_DYN_EXPORT virtual gzBool processEventAttribute(const gzDynUpdateInfo &info , const gzDistAttribute &attribute){ return TRUE; }

    GZ_DYN_EXPORT virtual gzDynamicType updateAttribute(const gzDynUpdateInfo &info , const gzString &name , const gzDynamicType &newValue, const gzDynamicType &oldValue , const gzDouble &oldTime ,  gzDouble &updateTime){ updateTime=info.eventTime; return newValue; }

    GZ_DYN_EXPORT virtual gzVoid updateObject(const gzDynUpdateInfo &info , gzDistTransactionPtr &transaction , const gzDistObjectPtr &object)=0;

    GZ_DYN_EXPORT virtual gzDynamicType requestAttributeStartValue(const gzDynUpdateInfo &info , const gzString &name , const gzDynamicType &oldValue , gzDouble & attributeTime){ attributeTime=0.0; return 0.0; }

    // ------------ look ahead ------------------------------
    GZ_DYN_EXPORT virtual gzVoid onNextEvent(const gzDouble &currentEvenTime,const gzDouble &nextEventTime , gzDistEvent *event , gzBool changedEvent , gzGUID &objectID , gzDistObject *object , gzDataSortIterator<gzRefPointer<gzDistEvent>,gzDynEventSort> &iterator ){}

    // ------------ event routing ---------------------------
    GZ_DYN_EXPORT virtual gzVoid processEvent(const gzDistObjectPtr &object , const gzDynUpdateInfo &info ){}
};

#endif //__GZ_DYN_UPDATE_INTERFACE_H__

---