IPFSystem.h

Go to the documentation of this file.

/**********************************************************************
 *<

    CREATED BY: Oleg Bayborodin

    HISTORY: created 10-22-01

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

#pragma once

#include "PFExport.h"
#include "IPViewManager.h"
#include "..\object.h"

// interface ID
#define PFSYSTEM_INTERFACE Interface_ID(0x74f93d00, 0x1eb34700) 
#define GetPFSystemInterface(obj) ((IPFSystem*)((GetPFObject(obj))->GetInterface(PFSYSTEM_INTERFACE))) 


class IPFSystem : public FPMixinInterface
{
public:

    // function IDs
    enum {  kGetMultiplier,
            kGetBornAllowance,
            kHasEmitter,
            kGetEmitterType,
            kGetEmitterDimensions,
            kGetEmitterGeometry,
            kIsEmitterGeometryAnimated,
            kSetRenderState,
            kIsRenderState,
            kGetIntegrationStep,
            kGetUpdateType,
            kNumParticlesSelected,
            kGetSelectedParticleID,
            kIsParticleSelected,
            kNumActionListsSelected,
            kGetSelectedActionList,
            kIsActionListSelected,
            kIsRunningScript,
    }; 

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

    FN_1(kGetMultiplier, TYPE_FLOAT, GetMultiplier, TYPE_TIMEVALUE );
    FN_0(kGetBornAllowance, TYPE_INT, GetBornAllowance );
    FN_0(kHasEmitter, TYPE_bool, HasEmitter);
    FN_1(kGetEmitterType, TYPE_INT, GetEmitterType, TYPE_TIMEVALUE );
    VFN_2(kGetEmitterDimensions, GetEmitterDimensions, TYPE_TIMEVALUE, TYPE_FLOAT_TAB_BR );
    FN_1(kGetEmitterGeometry, TYPE_MESH, GetEmitterGeometry, TYPE_TIMEVALUE);
    FN_0(kIsEmitterGeometryAnimated, TYPE_bool, IsEmitterGeometryAnimated);
    VFN_1(kSetRenderState, SetRenderState, TYPE_bool);
    FN_0(kIsRenderState, TYPE_bool, IsRenderState);
    FN_0(kGetIntegrationStep, TYPE_TIMEVALUE, GetIntegrationStep);
    FN_0(kGetUpdateType, TYPE_INT, GetUpdateType);
    FN_0(kNumParticlesSelected, TYPE_INT, NumParticlesSelected);
    FN_1(kGetSelectedParticleID, TYPE_INDEX, GetSelectedParticleID, TYPE_INDEX);
    FN_1(kIsParticleSelected, TYPE_bool, IsParticleSelected, TYPE_INDEX);
    FN_0(kNumActionListsSelected, TYPE_INT, NumActionListsSelected);
    FN_1(kGetSelectedActionList, TYPE_INODE, GetSelectedActionList, TYPE_INDEX);
    FN_1(kIsActionListSelected, TYPE_bool, IsActionListSelected, TYPE_INODE);
    FN_0(kIsRunningScript, TYPE_bool, IsRunningScript);

    END_FUNCTION_MAP


    virtual float GetMultiplier(TimeValue time) = 0;

    virtual int GetBornAllowance() = 0;

    virtual bool HasEmitter() { return false; }
    // emitter types
    enum {  kEmitterType_none = -1,
            kEmitterType_rectangle = 0,
            kEmitterType_circle,
            kEmitterType_box,
            kEmitterType_sphere,
            kEmitterType_mesh
    };
#pragma warning(push)
#pragma warning(disable:4100)

    virtual int GetEmitterType(TimeValue time) { return kEmitterType_none; }

    virtual void GetEmitterDimensions(TimeValue time, Tab<float>& dimensions) { }

        virtual Mesh* GetEmitterGeometry(TimeValue time) { return NULL; }

        virtual bool IsEmitterGeometryAnimated() { return false; }

    virtual void SetRenderState(bool renderState=true) = 0;

    virtual bool IsRenderState() const = 0;

    virtual TimeValue GetIntegrationStep() const = 0;

    enum { kPFUpdateType_complete, kPFUpdateType_forward };
    virtual int GetUpdateType() const { return GetPFUpdateType(); } // uses global UpdateType method from IPViewManager

    virtual int NumParticlesSelected() const { return 0; }

    virtual int GetSelectedParticleID(int i) const { return 0; }

    virtual bool IsParticleSelected(int id) const { return false; }

    virtual int NumActionListsSelected() const { return 0; }

    virtual INode* GetSelectedActionList(int i) const { return NULL; }

    virtual bool IsActionListSelected(INode* inode) const { return false; }
#pragma warning(pop)

    virtual bool IsRunningScript() const { return false; }

    virtual bool IsCopyClone() const { return true; }

    virtual void ResetCopyClone() { ; }

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

};

inline IPFSystem* PFSystemInterface(Object* obj) {
    return ((obj == NULL) ? NULL : GetPFSystemInterface(obj));
};

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