IPFTest.h

Go to the documentation of this file.

/**********************************************************************
 *<
    CREATED BY: Oleg Bayborodin

    HISTORY: created 10-12-01

 *> Copyright (c) 2001, All Rights Reserved.
 **********************************************************************/

#pragma once

#include "PFExport.h"
#include "PreciseTimeValue.h"
#include "..\object.h"
// forward declarations
class IPFIntegrator;

PFExport Object* GetPFObject(Object* obj);
// interface ID
#define PFTEST_INTERFACE Interface_ID(0x74f93d02, 0x1eb34500) 
#define GetPFTestInterface(obj) ((IPFTest*)((GetPFObject(obj))->GetInterface(PFTEST_INTERFACE))) 

class IPFTest : public FPMixinInterface
{
public:

    // function IDs
    enum {  kProceedStep1,
            kProceedStep2,
            kGetNextActionList,
            kSetNextActionList,
            kSetLinkActive,
            kClearNextActionList
    }; 

    // Function Map for Function Publish System 
    //***********************************
    BEGIN_FUNCTION_MAP

    VFN_5(kProceedStep1, ProceedStep1, TYPE_IOBJECT, TYPE_OBJECT, TYPE_INODE, TYPE_INODE, TYPE_INTERFACE);
    FN_6(kProceedStep2, TYPE_bool, ProceedStep2, TYPE_TIMEVALUE, TYPE_FLOAT, TYPE_TIMEVALUE_BR, TYPE_FLOAT_BR, TYPE_BITARRAY_BR, TYPE_FLOAT_TAB_BR);
    FN_2(kGetNextActionList, TYPE_INODE, GetNextActionList, TYPE_INODE, TYPE_bool_BP );
    FN_2(kSetNextActionList, TYPE_bool, SetNextActionListMXS, TYPE_INODE, TYPE_INODE);
    FN_2(kSetLinkActive, TYPE_bool, SetLinkActive, TYPE_bool, TYPE_INODE);
    FN_1(kClearNextActionList, TYPE_bool, ClearNextActionList, TYPE_INODE);

    END_FUNCTION_MAP

    PFExport IPFTest();

    virtual bool    Proceed(IObject* pCont, PreciseTimeValue timeStart, PreciseTimeValue& timeEnd, 
                            Object* pSystem, INode* pNode, INode* actionNode, IPFIntegrator* integrator, 
                            BitArray& testResult, Tab<float>& testTime) = 0;

    virtual void ProceedStep1(IObject* pCont, Object* pSystem, INode* pNode, INode* actionNode, FPInterface* integrator) = 0;

    virtual bool ProceedStep2(TimeValue timeStartTick, float timeStartFraction, 
                            TimeValue& timeEndTick, float& timeEndFraction, 
                            BitArray& testResult, Tab<float>& testTime) = 0;

    PFExport INode* GetNextActionList(INode* test, bool* linkActive=NULL);

    PFExport bool SetNextActionList(INode* nextAL, INode* test);

    PFExport bool SetNextActionListMXS(INode* nextAL, INode* test);

    PFExport bool SetLinkActive(bool active, INode* test);

    PFExport bool ClearNextActionList(INode* test);

    FPInterfaceDesc* GetDesc() { return GetDescByID(PFTEST_INTERFACE); }

    inline void updateNextActionListValue(INode* nextAL) { m_nextActionList = nextAL; }

    inline void updateArrowValue(Object* arrow) { m_arrow = arrow; }

    inline void updateLinkActiveValue(bool linkActive) { m_linkActive = linkActive; }

protected:
    INode*  m_nextActionList; // an actionList node for the next event.
    Object* m_arrow; // an arrow object that controls the gate to the next ActionList
    bool    m_linkActive; // status of the link to the next ActionList
};

inline IPFTest* PFTestInterface(Object* obj) {
    return ((obj == NULL) ? NULL : GetPFTestInterface(obj));
};

inline IPFTest* PFTestInterface(INode* node) {
    return ((node == NULL) ? NULL : PFTestInterface(node->GetObjectRef()));
};