ILockedTracks.h

Go to the documentation of this file.

/*==============================================================================
Copyright 2008 Autodesk, Inc.  All rights reserved.
Use of this software is subject to the terms of the Autodesk license agreement provided at the time of installation or download,
or which otherwise accompanies this software in either electronic or hard copy form.   
*****************************/
// DESCRIPTION: Interface to Locked Tracks
// AUTHOR: Michael Zyracki created 2008
//***************************************************************************/
#pragma once

#include "ifnpub.h"
#include "control.h"
#include "AnimatableInterfaceIDs.h"

#define ILOCKEDTRACKSMAN_INTERFACE Interface_ID(0x30384fe4, 0x3d657ac6)

class ILockedTracksMan: public FPStaticInterface
{
public:

    virtual bool IsLockable(ReferenceTarget *anim,ReferenceTarget *client, int subNum) =0;

    virtual bool GetLocked(ReferenceTarget *anim, ReferenceTarget *client, int subNum,bool checkOverride=true) =0;











    virtual void SetLocks(bool val,Tab<ReferenceTarget*> &anims, Tab<ReferenceTarget*> &clients,Tab<int> &subNums,
                            bool lockSubAnims)=0;

    virtual void ToggleLocks(Tab<ReferenceTarget*> &anims, Tab<ReferenceTarget*> &clients,Tab<int> &subNums,
                            bool lockSubAnims)=0;
    






    virtual void SetUnLockOverride(bool val) =0;

    virtual bool GetUnLockOverride() const =0;
    

    virtual void PushUberUnLockOverride()=0;
    virtual void PopUberUnLockOverride()=0;
    virtual int GetUberUnLockOverride()const =0;











    virtual void FindLockedAnims(bool locked,bool checkOverride, ReferenceTarget *refTarget, Tab<ReferenceTarget*> &anims, Tab<ReferenceTarget*> &clients, Tab<int> &subnums) =0;

    virtual bool IsAnimOverrideUnlocked(ReferenceTarget *anim) =0;

};

class ILockedTrack: public MaxHeapOperators 
{
public:
    virtual ~ILockedTrack(){};
    virtual void SetLocked(bool val, bool lockSubanims,ReferenceTarget* anim,ReferenceTarget* client, int subNum)=0;
    virtual bool GetLocked(bool checkOverride = true)const =0;

    virtual bool IsComponent(){return false;}

};


class ILockedTrackImpRestore;

//*! \sa  Class ILockedTrack\n\n
class ILockedTrackImp: public ILockedTrack
{
    friend class ILockedTrackImpRestore;
public:
    CoreExport ILockedTrackImp();
    CoreExport void SetLocked(bool val, bool effectChildren,ReferenceTarget* anim,ReferenceTarget* client, int SubNum);
    CoreExport bool GetLocked(bool checkOverride = true)const; 

protected:
    bool mLocked;
};

class ILockedTrackClient: public MaxHeapOperators 
{
public:
    virtual ~ILockedTrackClient(){};
    virtual void SetLocked(bool val, bool lockSubanims, ReferenceTarget* anim, ReferenceTarget* client, int subNum)=0;
    virtual bool GetLocked(int subNum, bool checkOverride = true)const =0;

    virtual bool IsLockable(int subNum)const =0;
};

class LockableStdControl: public StdControl, public ILockedTrackImp
{
public:

    void* GetInterface(ULONG id)
    {
        switch (id) {
            case I_LOCKED:
                    return (ILockedTrackImp*) this;
            }
        return StdControl::GetInterface(id);
    }
    BOOL IsReplaceable() {return !GetLocked();}  

    BOOL CanApplyEaseMultCurves(){return !GetLocked();}
};

class LockableControl : public Control, public ILockedTrackImp
{
public:
    

    void* GetInterface(ULONG id)
    {
        switch (id) {
            case I_LOCKED:
                    return (ILockedTrackImp*) this;
            }
        return Control::GetInterface(id);
    }
    BOOL IsReplaceable() {return !GetLocked();} 

    BOOL CanApplyEaseMultCurves(){return !GetLocked();}
};