ILayerControl.h

Go to the documentation of this file.

/*==============================================================================
// Copyright (c) 1998-2006 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//**************************************************************************/
// DESCRIPTION: Interface to Animation Layer Interfaces
// AUTHOR: Michael Zyracki created 2006
//***************************************************************************/

#pragma once

#include "ifnpub.h"
#include "iparamb2.h"
#include "XMLAnimTreeEntry.h"


#define ANIMLAYERMGR_COMBOBOX_ID   50612
#define ANIMLAYERMGR_EDIT_ID   50613
#define ANIMLAYERMGR_SPINNER_ID   50614

#define MASTERLAYERCONTROLMANAGER_CLASS_ID  Class_ID(0xf4871a5, 0x781f1430)

#define IANIMLAYERCONTROLMANAGER_INTERFACE Interface_ID(0xe343ef5, 0x62944bc2)



class IAnimLayerControlManager  : public FPStaticInterface {

public:



    
    enum Filter{ePos= 0x1, eRot = 0x2, eScale = 0x4,eIK = 0x8, eObject = 0x10,
    eCA = 0x20, eMod = 0x40, eMat = 0x80, eOther = 0x100};


    enum ControllerType {eBezier=0x0, eLinear, eDefault};



    
    virtual void ShowAnimLayersManagerToolbar(bool show) =0;

    virtual void RefreshAnimLayersManagerToolbar() =0;


    virtual int  EnableAnimLayersDlg(Tab<INode *> &nodeTab) =0;






    virtual int  EnableAnimLayers(Tab<INode *> &nodeTab,DWORD filter) =0;
    

    virtual BOOL CanEnableAnimLayer(ReferenceTarget *anim, ReferenceTarget *client,int subNum) =0;

    virtual BOOL EnableAnimLayer(ReferenceTarget *anim, ReferenceTarget *client, int subnum) =0;

    virtual int  GetLayerCount()=0;

    virtual void GetNodesLayers(Tab<INode *> &nodeTab,Tab<int> &layers)=0;

    virtual void SetLayerActive(int index)=0;

    virtual void SetLayerActiveNodes(int index,Tab<INode *> &nodeTab)=0;

    virtual void AddLayer(MSTR &name, Tab<INode *> &nodeTab, bool useActiveControllerType)=0;

    virtual void AddLayerDlg(Tab<INode *> &nodeTab)=0;


    virtual void     GetActiveLayersNodes(Tab<INode *> &nodeTab,Tab<int> &layers)=0;


    virtual void     GetNodesActiveLayer(Tab<INode *> &nodeTab)=0;

    virtual void DeleteLayer(int index)=0;

    virtual void DeleteLayerNodes(int index,Tab<INode *> &nodeTab)=0;

    virtual void CopyLayerNodes(int index,Tab<INode *> &nodeTab)=0;

    virtual void PasteLayerNodes(int index,Tab<INode *> &nodeTab)=0;

    virtual void SetLayerName(int index, MSTR name)=0;

    virtual MSTR GetLayerName(int index)=0;

    virtual float GetLayerWeight(int index,TimeValue t)=0;

    virtual void SetLayerWeight(int index, TimeValue t, float weight)=0;

    virtual Control * GetLayerWeightControl(int index)=0;

    virtual bool SetLayerWeightControl(int index, Control *c)=0;


    virtual bool GetLayerMute(int index)=0;

    virtual void SetLayerMute(int index, bool mute)=0;

    virtual bool GetLayerOutputMute(int index)=0;

    virtual void SetLayerOutputMute(int index, bool mute)=0;

    virtual bool GetLayerLocked(int index)=0;

    virtual void SetLayerLocked(int index, bool locked)=0;


    virtual void CollapseLayerNodes(int index,Tab<INode*> &nodeTab)=0;


    virtual void DisableLayerNodes(Tab<INode*> &nodeTab)=0;


    virtual void AnimLayerPropertiesDlg() = 0;

    virtual void SetFilterActiveOnlyTrackView(bool val)=0;

        
    virtual bool GetFilterActiveOnlyTrackView()=0;

    virtual void SetJustUpToActive(bool v)=0;

    virtual  bool GetJustUpToActive()=0;

    virtual  void SetCollapseControllerType(IAnimLayerControlManager::ControllerType type)=0;

    virtual IAnimLayerControlManager::ControllerType GetCollapseControllerType() = 0;

    virtual void SetCollapsePerFrame(bool v) =0;

    virtual bool GetCollapsePerFrame() =0;

    virtual void SetCollapsePerFrameActiveRange(bool v) =0;

    virtual bool GetCollapsePerFrameActiveRange() =0;

    virtual void SetCollapseRange(Interval range) =0;

    virtual Interval GetCollapseRange() =0;

    virtual void SetUpCustUI(ICustToolbar *toolbar,int id,HWND hWnd, HWND hParent)=0;

    virtual MCHAR *GetComboToolTip() =0;

};


#define FLOATLAYER_CONTROL_CLASS_ID     Class_ID(0xba900de, 0x64230ed4)
#define POINT3LAYER_CONTROL_CLASS_ID    Class_ID(0x602b0ddf, 0x455b1b11)
#define POSLAYER_CONTROL_CLASS_ID       Class_ID(0x29b938ee, 0x7fe83f9c)
#define ROTLAYER_CONTROL_CLASS_ID       Class_ID(0x6d7f1859, 0x3f3f0f5e)
#define SCALELAYER_CONTROL_CLASS_ID     Class_ID(0x300e6319, 0x194e7d61)
#define POINT4LAYER_CONTROL_CLASS_ID    Class_ID(0x753822fd, 0xedf52d8)
#define LAYEROUTPUT_CONTROL_CLASS_ID    Class_ID(0x5b6e7ba7, 0x692e4477)




#define LAYER_CONTROLLER_INTERFACE Interface_ID(0x434d7627, 0xa25e6e26)

#define GetILayerControlInterface(cd) \
        static_cast<ILayerControl*> ((cd)->GetInterface(LAYER_CONTROLLER_INTERFACE))



class ILayerControl :  public FPMixinInterface {
    public:
        
        enum{ getNumLayers, setLayerActive, getLayerActive,  copyLayer,pasteLayer,
              deleteLayer, count, setLayerActive_prop, getLayerActive_prop,getLayerName, setLayerName,
              getSubCtrl, getLayerWeight,setLayerWeight,getLayerMute, setLayerMute,collapseLayer,
              disableLayer, getLayerLocked, setLayerLocked};
        // FUNCTION_PUBLISHING      
        // Function Map for Function Publish System 
        //***********************************
#pragma warning(push)
#pragma warning(disable:4238)
        BEGIN_FUNCTION_MAP
            FN_0        (getNumLayers,  TYPE_INT,   GetLayerCount               );
            VFN_1       (setLayerActive,                SetLayerActive,     TYPE_INDEX  );
            FN_0        (getLayerActive,    TYPE_INDEX, GetLayerActive                  );
            VFN_1       (copyLayer,                 CopyLayer,      TYPE_INDEX  );
            VFN_1       (pasteLayer,                PasteLayer,     TYPE_INDEX  );
            VFN_1       (deleteLayer,               DeleteLayer,        TYPE_INDEX  );
            FN_1        (getLayerName,    TYPE_TSTR_BV, GetLayerName,       TYPE_INDEX  );
            VFN_2       (setLayerName,                  SetLayerName,       TYPE_INDEX, TYPE_STRING );
            RO_PROP_FN  (count,                 GetLayerCount,  TYPE_INT    ); 
            PROP_FNS    (getLayerActive_prop, GetLayerActive, setLayerActive_prop, SetLayerActive, TYPE_INDEX   ); 
            FN_1        (getSubCtrl,    TYPE_CONTROL,   GetSubCtrl, TYPE_INDEX  );
            FN_2        (getLayerWeight,TYPE_FLOAT, GetLayerWeight,TYPE_INDEX,TYPE_TIMEVALUE );
            VFN_3       (setLayerWeight,SetLayerWeight, TYPE_INDEX,TYPE_TIMEVALUE,TYPE_FLOAT );
            FN_1        (getLayerMute,TYPE_bool, GetLayerMute,TYPE_INDEX );
            VFN_2       (setLayerMute,SetLayerMute, TYPE_INDEX,TYPE_bool );
            VFN_1       (collapseLayer,             CollapseLayer,      TYPE_INDEX  );
            VFN_0       (disableLayer, DisableLayer);
            FN_1        (getLayerLocked,TYPE_bool, GetLayerLocked,TYPE_INDEX );
            VFN_2       (setLayerLocked,SetLayerLocked, TYPE_INDEX,TYPE_bool );
    END_FUNCTION_MAP
#pragma warning(pop)
        FPInterfaceDesc* GetDesc();    // <-- must implement 
        //End of Function Publishing system code 
        //***********************************

        virtual int  GetLayerCount()=0;

        virtual void SetLayerActive(int index)=0;

        virtual int  GetLayerActive()=0;

        virtual void DeleteLayer(int index)=0;

        virtual void CopyLayer(int index)=0;
            
        virtual void PasteLayer(int index)=0;

        virtual void SetLayerName(int index, MSTR name)=0;

        virtual MSTR GetLayerName(int index)=0;
    

        virtual float GetLayerWeight(int index,TimeValue t)=0;

        virtual void SetLayerWeight(int index, TimeValue t, float weight)=0;

        virtual bool GetLayerMute(int index)=0;

        virtual void SetLayerMute(int index, bool mute)=0;

        virtual Control*    GetSubCtrl(int in_index) const =0;

        virtual void CollapseLayer(int index)=0;

        virtual void DisableLayer()=0;

        virtual bool GetLayerLocked(int index)=0;

        virtual void SetLayerLocked(int index,bool locked)=0;


};