IPViewItem.h

Go to the documentation of this file.

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

    HISTORY: created 02-21-02

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

#pragma once

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

PFExport Object* GetPFObject(Object* obj);
// interface ID
#define PVIEWITEM_INTERFACE Interface_ID(0x74f93d08, 0x1eb34500) 
#define GetPViewItemInterface(obj) ((IPViewItem*)((GetPFObject(obj))->GetInterface(PVIEWITEM_INTERFACE))) 

// operator/test icon size in particle view
enum {  kActionImageWidth=22, kActionImageHeight=22 }; // in pixels

class IPViewItem : public FPMixinInterface
{
public:

    // function IDs
    enum {  kNumPViewParamBlocks,
            kGetPViewParamBlock,
            kHasComments,
            kGetComments,
            kSetComments,
            kGetWireExtension,
            kSetWireExtension
    }; 

    BEGIN_FUNCTION_MAP
    FN_0(kNumPViewParamBlocks, TYPE_INT, NumPViewParamBlocks );
    FN_1(kGetPViewParamBlock, TYPE_REFTARG, GetPViewParamBlock, TYPE_INDEX );
    FN_1(kHasComments, TYPE_bool, HasComments, TYPE_INODE );
    FN_1(kGetComments, TYPE_STRING, GetComments, TYPE_INODE );
    VFN_2(kSetComments, SetComments, TYPE_INODE, TYPE_STRING );
    FN_2(kGetWireExtension, TYPE_INT, GetWireExtension, TYPE_INODE, TYPE_INT );
    VFN_3(kSetWireExtension, SetWireExtension, TYPE_INODE, TYPE_INT, TYPE_INT );
    END_FUNCTION_MAP

    // constructor: inherited as a base class constructor
    IPViewItem() { m_numInstances = 1; }

    virtual int NumPViewParamBlocks() const = 0;

    virtual IParamBlock2* GetPViewParamBlock(int i) const = 0;

    PFExport int NumPViewParamMaps() const;

    PFExport IParamMap2* GetPViewParamMap(int i) const;

    PFExport void AddPViewParamMap(IParamMap2* map);

    PFExport void RemovePViewParamMap(IParamMap2* map);

    virtual bool HasCustomPViewIcons() { return false; }

    virtual HBITMAP GetActivePViewIcon() { return NULL; }  

    virtual HBITMAP GetInactivePViewIcon() { return NULL; }

    virtual HBITMAP GetTruePViewIcon() { return NULL; } 

    virtual HBITMAP GetFalsePViewIcon() { return NULL; } 

    PFExport int GetNumInstances() const;

    PFExport void SetNumInstances(int num);

    PFExport void IncNumInstances();

    PFExport bool HasComments(INode* itemNode) const;

    PFExport MSTR GetComments(INode* itemNode) const;

    PFExport void SetComments(INode* itemNode, MSTR comments);

    PFExport void EditComments(INode* itemNode, HWND parentWnd, long x, long y);

    PFExport LRESULT CALLBACK commentsProc( HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam );

    virtual bool HasDynamicName(MSTR& nameSuffix) { UNUSED_PARAM(nameSuffix); return false; }
    
    PFExport static int GetWireExtension(INode* node, int& wireHeight);

    PFExport static void SetWireExtension(INode* node, int wireLen, int wireHight);

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

private:
    void add(INode* itemNode, HWND hWnd);
    INode* node(HWND hWnd);
    HWND hWnd(INode* itemNode);
    void erase(HWND hWnd);

protected:
    Tab<IParamMap2*> m_paramMaps;
    int m_numInstances;
    Tab<INode*> m_nodes;
    Tab<HWND> m_hWnds;
};

inline IPViewItem* PViewItemInterface(Object* obj) {
    return ((obj == NULL) ? NULL : GetPViewItemInterface(obj));
};

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