ILimitCtrl.h

Go to the documentation of this file.

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

    FILE: ILimitCtrl.h

    DESCRIPTION: Describes all interfaces and constants about the limit 
    controllers that the outside world should need to know.

    CREATED BY: Nicolas Leonard

    HISTORY:    November 3rd, 2004  Creation

    Copyright (c) 2004, All Rights Reserved.
 *****************************************************************************/

#pragma once

#include "iFnPub.h"
#include "Animatable.h"

/***************************************************************
Function Publishing System   
****************************************************************/

#define IID_LIMIT_CONTROL Interface_ID(0xa85724f, 0x75325d35)



class ILimitControl: public FPMixinInterface
{
public:

    // Function Publishing System
    enum {
        is_enabled,
        set_enabled,
        get_limited_control,
        set_limited_control,
        set_upper_limit,
        set_lower_limit
    };

    // Function Map For Mixin Interface
    BEGIN_FUNCTION_MAP
        FN_0(is_enabled, TYPE_bool, IsEnabled);
        VFN_1(set_enabled, SetEnabled, TYPE_bool);
        FN_0(get_limited_control, TYPE_CONTROL, GetLimitedControl);
        VFN_1(set_limited_control, SetLimitedControl, TYPE_CONTROL);
    END_FUNCTION_MAP

    FPInterfaceDesc* GetDesc(); 


    virtual bool IsEnabled() const = 0;
    virtual void SetEnabled(bool in_enabled) = 0;


    virtual Control* GetLimitedControl() const = 0;
    virtual void SetLimitedControl(Control *in_limitedCtrl) = 0;

    virtual void SetUpperLimit(const TimeValue& in_t, void *in_val) = 0;

    virtual void SetLowerLimit(const TimeValue& in_t, void *in_val) = 0;

    static inline ILimitControl* GetBaseLimitInterface(Animatable* anim) { 
        return anim? static_cast<ILimitControl*>(anim->GetInterface(IID_LIMIT_CONTROL)): NULL;}
};