IParticleChannel.h

Go to the documentation of this file.

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

    HISTORY: created 10-09-01

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

#pragma once

#include "PFExport.h"
#include "..\ifnpub.h"
// forward declarations
class IMergeManager;

// interface ID
#define PARTICLECHANNEL_INTERFACE Interface_ID(0x74f93b00, 0x1eb34400)

#define GetParticleChannelInterface(obj) ((IParticleChannel*)obj->GetInterface(PARTICLECHANNEL_INTERFACE))

class IParticleChannel : public FPMixinInterface
{
public:

    // function IDs
    enum {  kClone,
            kIsSimilarChannel,
            kIsTransferable,
            kSetTransferable,
            kIsPrivateChannel,
            kGetPrivateOwner,
            kSetPrivateOwner,
            kGetCreatorAction,
            kSetCreatorAction,
            kGetReadID_PartA,
            kGetReadID_PartB,
            kGetWriteID_PartA,
            kGetWriteID_PartB,
            kSetReadID,
            kSetWriteID
    };

    // chunk IDs for saving and loading
    // developer: you may have your own chunk IDs
    // they are factored here for convenience
    enum {  kChunkCount         = 1000,
            kChunkData          = 1010,
            kChunkGlobalCount   = 1020,
            kChunkSharedCount   = 1021,
            kChunkGlobalValue   = 1030,
            kChunkSharedValue   = 1031,
            kChunkReadID        = 1040,
            kChunkWriteID       = 1050,
            kChunkTransferable  = 1055,
            kChunkPrivate       = 1056,
            kChunkActionHandle  = 1057,
            kChunkValue1        = 1061,
            kChunkValue2        = 1062,
            kChunkValue3        = 1063,
            kChunkValue4        = 1064,
            kChunkValue5        = 1065,
            kChunkValue6        = 1066,
            kChunkValue7        = 1067
    };

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

    FN_0(kClone, TYPE_IOBJECT, Clone);
    FN_1(kIsSimilarChannel, TYPE_bool, IsSimilarChannel, TYPE_IOBJECT);
    FN_0(kIsTransferable, TYPE_bool, IsTransferable);
    VFN_1(kSetTransferable, SetTransferable, TYPE_bool);
    FN_0(kIsPrivateChannel, TYPE_bool, IsPrivateChannel);
    FN_0(kGetPrivateOwner, TYPE_OBJECT, GetPrivateOwner);
    VFN_1(kSetPrivateOwner, SetPrivateOwner, TYPE_OBJECT);
    FN_0(kGetCreatorAction, TYPE_INODE, GetCreatorAction);
    VFN_1(kSetCreatorAction, SetCreatorAction, TYPE_INODE);
    FN_0(kGetReadID_PartA, TYPE_DWORD, GetReadID_PartA);
    FN_0(kGetReadID_PartB, TYPE_DWORD, GetReadID_PartB);
    FN_0(kGetWriteID_PartA, TYPE_DWORD, GetWriteID_PartA);
    FN_0(kGetWriteID_PartB, TYPE_DWORD, GetWriteID_PartB);
    VFN_2(kSetReadID, SetReadID, TYPE_DWORD, TYPE_DWORD);
    VFN_2(kSetWriteID, SetWriteID, TYPE_DWORD, TYPE_DWORD);

    END_FUNCTION_MAP

    PFExport IParticleChannel();

    PFExport IParticleChannel(const Interface_ID& readID, const Interface_ID& writeID);

    virtual Class_ID GetClassID() const = 0;

    virtual IObject*        Clone() const = 0; 

    virtual IOResult Save(ISave* isave) const = 0;

    virtual IOResult Load(ILoad* iload) = 0;

    PFExport bool IsSimilarChannel(IObject* channel) const;

    PFExport bool IsTransferable() const;

    PFExport void SetTransferable(bool status);

    PFExport bool IsPrivateChannel() const;

    PFExport Object* GetPrivateOwner() const;

    PFExport void SetPrivateOwner(Object* action);

    PFExport INode* GetCreatorAction() const;

    PFExport void SetCreatorAction(INode* actionNode);

    PFExport DWORD GetReadID_PartA() const;

    PFExport DWORD GetReadID_PartB() const;

    PFExport DWORD GetWriteID_PartA() const;

    PFExport DWORD GetWriteID_PartB() const;

    PFExport void SetReadID(DWORD interfaceID_PartA, DWORD interfaceID_PartB);

    PFExport void SetWriteID(DWORD interfaceID_PartA, DWORD interfaceID_PartB);

    PFExport const Interface_ID& GetReadID() const;

    PFExport const Interface_ID& GetWriteID() const;

    PFExport void SetReadID(const Interface_ID& id);

    PFExport void SetWriteID(const Interface_ID& id);

    PFExport void CloneChannelCore(IParticleChannel* getFrom);

    PFExport void UpdateCreatorHandle(IMergeManager* pMM);

    virtual int MemoryUsed() const = 0;

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

protected:
    bool m_isTransferable;
    bool m_isPrivate;
    mutable Object* m_privateOwner; // could be derived from creatorAction
    mutable INode* m_creatorAction; // could be derived from creatorHandle
    ULONG m_creatorHandle;
    // wrapper ids
    Interface_ID m_readID, m_writeID;

    int     numRefs()   const   { return m_numRefs; }
    int&    _numRefs()          { return m_numRefs; }
private:
    int m_numRefs;
};