iXrefCtrl.h

Go to the documentation of this file.

/*****************************************************************************

    FILE: iXrefCtrl.h

    DESCRIPTION: Public interface for the XRef controller.

    CREATED BY: Richard Laperriere

    HISTORY: April 5th, 2005    Creation

    Copyright (c) 2005, All Rights Reserved.

*****************************************************************************/

#pragma once

#include "..\ifnpub.h"
#include "..\control.h"

#define IID_XREF_CTRL Interface_ID(0x501064f, 0x4026738f)

//==============================================================================
// Class IXRefCtrl
//

class IXRefCtrl : public Control, public FPMixinInterface
{
public:


    static bool Is_IXRefCtrl(Animatable& animatable);

    using FPMixinInterface::GetInterface;

    static IXRefCtrl* GetInterface(InterfaceServer& is);


    virtual Control* GetSourceCtrl(bool resolveNestedXRef = false) const = 0;


    virtual FPInterfaceDesc* GetIXRefCtrlDesc() = 0;

    virtual void ResetOffsetTM() = 0;

    // -- from FPMixinInterface
    virtual Interface_ID GetID()            {return IID_XREF_CTRL;}
    virtual FPInterfaceDesc* GetDesc()      {return GetIXRefCtrlDesc();}

    // --- Function publishing
    enum {
        kfpGetSourceCtrl,
        kfpResetOffsetTM,
    };

    BEGIN_FUNCTION_MAP
        FN_1(kfpGetSourceCtrl, TYPE_CONTROL, GetSourceCtrl, TYPE_bool);
        VFN_0(kfpResetOffsetTM, ResetOffsetTM);
    END_FUNCTION_MAP
};

//==============================================================================
// Class IXRefCtrl inlined methods
//==============================================================================

inline bool IXRefCtrl::Is_IXRefCtrl(Animatable& animatable)
{
    return ((animatable.SuperClassID() == CTRL_MATRIX3_CLASS_ID) &&
            (animatable.ClassID() == XREFCTRL_CLASS_ID));
}

inline IXRefCtrl* IXRefCtrl::GetInterface(InterfaceServer& is)
{
    return static_cast<IXRefCtrl*>(is.GetInterface(IID_XREF_CTRL));
}