IPFIntegrator.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 "..\ifnpub.h"

// interface ID
#define PFINTEGRATOR_INTERFACE Interface_ID(0x74f93d03, 0x1eb34500) 

#define GetPFIntegratorInterface(obj) ((IPFIntegrator*)obj->GetInterface(PFINTEGRATOR_INTERFACE)) 

// function IDs
enum {  kPFIntegrator_proceedSync,
        kPFIntegrator_proceedASync
}; 

class IPFIntegrator : public FPMixinInterface
{

BEGIN_FUNCTION_MAP
FN_5(kPFIntegrator_proceedSync, TYPE_bool, ProceedSync, TYPE_IOBJECT, TYPE_TIMEVALUE, TYPE_FLOAT, TYPE_bool, TYPE_BITARRAY);
FN_5(kPFIntegrator_proceedASync, TYPE_bool, ProceedASync, TYPE_IOBJECT, TYPE_TIMEVALUE_TAB, TYPE_FLOAT_TAB, TYPE_bool, TYPE_BITARRAY);

END_FUNCTION_MAP

public:

    virtual bool    Proceed(IObject* pCont, PreciseTimeValue time, int index) = 0;

    virtual bool    Proceed(IObject* pCont, PreciseTimeValue time) = 0;

    virtual bool    Proceed(IObject* pCont, Tab<PreciseTimeValue>& times) = 0;

    virtual bool    Proceed(IObject* pCont, PreciseTimeValue time, BitArray& selected) = 0;

    virtual bool    Proceed(IObject* pCont, Tab<PreciseTimeValue>& times, BitArray& selected) = 0;

    PFExport bool ProceedSync(IObject* pCont, TimeValue timeTick, float timeFraction,
                                bool isSelected, BitArray* selected);

    PFExport bool ProceedASync(IObject* pCont, Tab<TimeValue> *timeTicks, Tab<float> *timeFractions,
                                bool isSelected, BitArray* selected);

    virtual IPFIntegrator* GetEncapsulatedIntegrator() { return NULL; }

    PFExport bool HasEncapsulatedIntegrator(IPFIntegrator* integrator);

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

    friend PFExport IPFIntegrator* GetPFIntegrator();

    friend PFExport void ReleasePFIntegrator(IPFIntegrator*);

protected:
    static Tab<IObject*> m_objs;
};
// this method gets a system PF Integrator interface
PFExport IPFIntegrator* GetPFIntegrator();
// when the developer is done with the PFIntegrator interface acquired via GetPFIntegrator() 
// they should call this method to release it.
PFExport void ReleasePFIntegrator(IPFIntegrator* integrator);