IPViewManager.h

Go to the documentation of this file.

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

    HISTORY: created 01-11-02

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

#pragma once

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

// interface ID
#define PVIEWMANAGER_INTERFACE Interface_ID(0x74f93d07, 0x1eb34500) 

#define GetPViewManagerInterface(obj) ((IPViewManager*)obj->GetInterface(PVIEWMANAGER_INTERFACE)) 

class IPViewManager : public FPMixinInterface
{
public:

    // function IDs
    enum {  kOpenParticleView,
            kUpdateParticleViews,
            kPreUpdateParticleViews,
            kPostUpdateParticleViews,
            kUpdateOnHold,
            kNumActionClasses,
            kActionClass,
            kActionName,
            kNumPViewItemClasses,
            kPViewItemClass,
            kPViewItemName,
            kParticleViewOpenCloseToggle,
            kParticleFlowActivationToggle
    }; 

    BEGIN_FUNCTION_MAP
    FN_1(kOpenParticleView, TYPE_bool, OpenParticleView, TYPE_OBJECT);
    FN_1(kUpdateParticleViews, TYPE_bool, UpdateParticleViews, TYPE_bool);
    FN_1(kPreUpdateParticleViews, TYPE_bool, PreUpdateParticleViews, TYPE_bool);
    FN_1(kPostUpdateParticleViews, TYPE_bool, PostUpdateParticleViews, TYPE_bool);
    FN_0(kUpdateOnHold, TYPE_bool, UpdateOnHold);
    FN_0(kNumActionClasses, TYPE_INT, NumActionClasses );
    FN_1(kActionClass, TYPE_CLASS, ActionClass, TYPE_INT);
    FN_1(kActionName, TYPE_STRING, ActionName, TYPE_INT);
    FN_0(kNumPViewItemClasses, TYPE_INT, NumPViewItemClasses );
    FN_1(kPViewItemClass, TYPE_CLASS, PViewItemClass, TYPE_INT);
    FN_1(kPViewItemName, TYPE_STRING, PViewItemName, TYPE_INT);
    FN_0(kParticleViewOpenCloseToggle, TYPE_bool, ParticleViewOpenCloseToggle);
    FN_1(kParticleFlowActivationToggle, TYPE_bool, ParticleFlowActivationToggle, TYPE_bool);
    END_FUNCTION_MAP

    virtual bool    OpenParticleView(Object* engine) = 0;

    virtual bool    UpdateParticleViews(bool additionsOnly=false) = 0;

    virtual bool    PreUpdateParticleViews(bool additionsOnly=false) = 0;

    virtual bool    PostUpdateParticleViews(bool additionsOnly=false) = 0;

    virtual bool    CancelUpdateParticleViews() = 0;

    virtual bool    UpdateOnHold() = 0;

    virtual void    UpdateParticleAmountShown() { ; }

    #pragma warning(push)
    #pragma warning(disable:4100)
    virtual void    ActionProceedBegin(INode* actionNode) { ; }

    virtual void    ActionProceedEnd(INode* actionNode) { ; } 
    #pragma warning(pop)

    virtual bool    IsParticleViewInForeground() { return false; }

    PFExport static int NumActionClasses(); // public classes only

    PFExport static ClassDesc* ActionClass(int index);

    PFExport static MCHAR* ActionName(int index);

    PFExport static int NumPViewItemClasses(); 

    PFExport static ClassDesc* PViewItemClass(int index);

    PFExport static MCHAR* PViewItemName(int index);

    virtual bool ParticleViewOpenCloseToggle() = 0;

    virtual bool ParticleFlowActivationToggle(bool selectedOnly=false) = 0;

    virtual int GetVacantSpace() = 0;

    virtual void KeepMaterial(Mtl* mtl) = 0;

    PFExport static void RegisterModule(Class_ID moduleID);

    PFExport static bool IsModuleRegistered(Class_ID moduleID);

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

    friend PFExport IPViewManager* GetPViewManager();
    friend PFExport void ReleasePViewManager();
    
protected:
    PFExport IPViewManager();
    PFExport virtual ~IPViewManager();

    virtual void releaseManager() = 0;

    static IPViewManager* m_manager; // the one and only PViewManager in the scene
    static Tab<ClassEntry*> m_actionClasses;
    static Tab<ClassEntry*> m_pViewItemClasses;
    static Tab<Class_ID> m_registeredModules;
};

#define PFTOOLSBOX1_MODULE_CLASSID          Class_ID(0x13410824, 0x88cd3e26)
#define PFTOOLSBOX1CHANNELS_MODULE_CLASSID  Class_ID(0x00358976, 0xf7f26da4)


PFExport IPViewManager* GetPViewManager();

PFExport   INode *CreatePFNode( Object *obj);

PFExport   void DeletePFNode(INode* node);

PFExport bool AppendPFAction(INode* actionList, INode* action);

PFExport bool InsertPFAction(INode* actionList, INode* action, int indexAt);

PFExport bool RemovePFAction(INode* actionList, int index);

PFExport bool RemovePFAction(INode* actionList, INode* action);

PFExport int GetPViewVacantSpace(INode* excludeNode=NULL);

PFExport int GetPViewMaximumZOrderIndex(INode* excludeNode=NULL);

PFExport bool CompactPViewZOrder();

PFExport void RegisterParticleFlowNotification();

PFExport void SuspendParticleFlowNotification();

PFExport void ResumeParticleFlowNotification();

PFExport bool IsParticleFlowNotificationSuspended();

PFExport void ReleasePViewManager();

PFExport int GetPFInt(IParamBlock2* pblock, ParamID id, TimeValue t=0, int tabIndex=0);

PFExport float GetPFFloat(IParamBlock2* pblock, ParamID id, TimeValue t=0, int tabIndex=0);

PFExport TimeValue GetPFTimeValue(IParamBlock2* pblock, ParamID id, TimeValue t=0, int tabIndex=0);

PFExport bool ValidateParticleFlows();

enum { kPFDefaultDisplay_global, kPFDefaultDisplay_local };

PFExport int GetPFDefaultDisplay();

PFExport void SetPFDefaultDisplay(int type);

PFExport void InitPFDefaultDisplay(int type);

enum { kPFActionOrder_globalsFirst, kPFActionOrder_localsFirst };

PFExport int GetPFActionOrder();

PFExport void SetPFActionOrder(int order);

PFExport void InitPFActionOrder(int order);

// PF particle system has different modes for update. 
// Forward mode: particles aren't updated right away. At playback time the particle history is
// not recalculated. Only new events that will happen with the particles have new settings
// Complete mode: the whole particle animation is recalculated. 
enum { kPFUpdateType_complete, kPFUpdateType_forward };

PFExport int GetPFUpdateType();

PFExport void SetPFUpdateType(int type);

PFExport void InitPFUpdateType(int type);

// names of actions in PView may have a dynamic suffix to reflect the most important settings of the action
enum { kPFDynamicNames_no, kPFDynamicNames_yes };

PFExport int GetPFDynamicNames();

PFExport void SetPFDynamicNames(int type);

PFExport void InitPFDynamicNames(int type);

PFExport void DisableParticleInvalidation();

PFExport void EnableParticleInvalidation();

PFExport bool IsAbleInvalidateParticles();

PFExport void SetIgnoreEmitterTMChange();

PFExport void ClearIgnoreEmitterTMChange();

PFExport bool IsIgnoringEmitterTMChange();

PFExport void SetIgnoreEmitterPropChange();

PFExport void ClearIgnoreEmitterPropChange();

PFExport bool IsIgnoringEmitterPropChange();

PFExport void SetIgnoreRefNodeChange();

PFExport void ClearIgnoreRefNodeChange();

PFExport bool IsIgnoringRefNodeChange();

PFExport void SetPFProceedStatus();

PFExport void ClearPFProceedStatus();

PFExport bool IsPFProceeding(); 

PFExport Object* GetPFObject(Object* obj);

// constants for particle view spacement and location
enum { kPViewActionListHorSpace=20 };