IPFActionList.h

Go to the documentation of this file.

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

    HISTORY: created 10-15-01

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

#pragma once

#include "PFExport.h"
#include "IPFAction.h"

PFExport Object* GetPFObject(Object* obj);
// interface ID
#define PFACTIONLIST_INTERFACE Interface_ID(0x74f93d04, 0x1eb34500) 
#define GetPFActionListInterface(obj) ((IPFActionList*)((GetPFObject(obj))->GetInterface(PFACTIONLIST_INTERFACE))) 

class IPFActionList : public FPMixinInterface
{
public:
    // function IDs
    enum {  kGetNumActions,     kGetAction,         kAppendAction,
            kInsertAction,      kRemoveAction,      kHasAction,
            kIsAction,          kIsOperator,        kIsTest,
            kIsActivated,       kActivate,          kIsActionActive,    
            kActivateAction,    kGetPViewLocation,  kSetPViewLocation,
            kGetPViewZOrder,    kSetPViewZOrder,    kGetListWidth,      
            kSetListWidth,      kGetPViewRightBoundary,
            kIsCollapsed,       kCollapse,          kExpand,
            kHasUpStream,       kGetSelected,       kSetSelected,       
            kAcceptFertile
    }; 

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

    FN_0(   kGetNumActions,     TYPE_INT,   NumActions  );
    FN_1(   kGetAction,         TYPE_INODE, GetAction,      TYPE_INDEX);
    FN_1(   kAppendAction,      TYPE_bool,  AppendAction,   TYPE_INODE);
    FN_2(   kInsertAction,      TYPE_bool,  InsertAction,   TYPE_INODE, TYPE_INDEX);
    FN_1(   kRemoveAction,      TYPE_bool,  RemoveAction,   TYPE_INDEX);
    FN_2(   kHasAction,         TYPE_bool,  HasAction,      TYPE_INODE, TYPE_INDEX_BR);
    FN_1(   kIsAction,          TYPE_bool,  IsAction,       TYPE_INODE);
    FN_1(   kIsOperator,        TYPE_bool,  IsOperator,     TYPE_INODE);
    FN_1(   kIsTest,            TYPE_bool,  IsTest,         TYPE_INODE);
    FN_0(   kIsActivated,       TYPE_bool,  IsActivated     );
    VFN_1(  kActivate,                      Activate,       TYPE_bool);
    FN_1(   kIsActionActive,    TYPE_INT,   IsActionActive, TYPE_INDEX);
    VFN_2(  kActivateAction,                ActivateAction, TYPE_INDEX, TYPE_INT);
    VFN_2(  kGetPViewLocation,              GetPViewLocation, TYPE_INT_BR, TYPE_INT_BR);
    VFN_2(  kSetPViewLocation,              SetPViewLocation, TYPE_INT, TYPE_INT);
    FN_0(   kGetPViewZOrder,    TYPE_INT,   GetPViewZOrder );
    VFN_1(  kSetPViewZOrder,                SetPViewZOrder, TYPE_INT);
    FN_0(   kGetListWidth,      TYPE_INT,   GetListWidth );
    VFN_1(  kSetListWidth,                  SetListWidth,   TYPE_INT);
    FN_0(   kGetPViewRightBoundary, TYPE_INT, GetPViewRightBoundary );
    FN_0(   kIsCollapsed,       TYPE_bool,  IsCollapsed );
    VFN_0(  kCollapse,                      Collapse );
    VFN_0(  kExpand,                        Expand );
    FN_0(   kHasUpStream,       TYPE_bool,  HasUpStream );
    FN_0(   kGetSelected,       TYPE_INT,   GetSelected );
    VFN_1(  kSetSelected,                   SetSelected, TYPE_INT);
    FN_0(   kAcceptFertile,     TYPE_bool,  AcceptFertile );

    END_FUNCTION_MAP

    FPInterfaceDesc* GetDesc() { return GetDescByID(PFACTIONLIST_INTERFACE); }
    //End of Function Publishing system code 
    //***********************************

    virtual int     NumActions() const = 0;

    virtual INode*  GetAction(int index) const = 0;

    virtual bool    AppendAction(INode* action) = 0;

    virtual bool    InsertAction(INode* action, int indexAt) = 0;

    virtual bool    RemoveAction(int index) = 0;

    virtual bool    HasAction(INode* action, int& index) const = 0;

    PFExport static bool IsAction(INode* action);

    PFExport static bool IsOperator(INode* action);

    PFExport static bool IsTest(INode* action);

    virtual bool    IsActivated() const = 0;

    virtual void    Activate(bool active) = 0;

    virtual int     IsActionActive(int index) const = 0;

    virtual void    ActivateAction(int index, int active=1) = 0;

    // default spacing and location on Particle View
    enum {  kListWidth=180 }; // default actionList width

    virtual void    GetPViewLocation(int& x, int& y) = 0;
#pragma warning(push)
#pragma warning(disable:4100)

    virtual void    SetPViewLocation(int x, int y) { ; }

    virtual int     GetPViewZOrder() { return 0; }

    virtual void    SetPViewZOrder(int z) { ; }

    virtual int     GetListWidth() { return kListWidth; }

    virtual void    SetListWidth(int w) { ; }

    PFExport int    GetPViewRightBoundary();

    virtual bool    IsCollapsed() { return false; }

    virtual void    Collapse() { ; }

    virtual void    Expand() { ; }

    virtual bool    HasUpStream() { return false; }

    virtual int     GetSelected() const { return 0; }

    virtual void    SetSelected(int onOff) { ; }
#pragma warning(pop)

    virtual bool    AcceptFertile() { return false; }

    virtual void    UpdateMaterial() { ; }
};

PFExport IPFActionList* GetParentPFActionList(INode* actionNode);

inline IPFActionList* PFActionListInterface(Object* obj) {
    return ((obj == NULL) ? NULL : GetPFActionListInterface(obj));
};

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