igrip.h

Go to the documentation of this file.

/*==============================================================================
Copyright 2010 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: Classes To Create and Manipulate Grips
// AUTHOR: Michael Zyracki created April 2009
//***************************************************************************/

#pragma once

#include "ifnpub.h"


class IBaseGrip :  public BaseInterface
{

public:

    virtual ~IBaseGrip(){};

    enum Type
    {
        eInvalid = -1,
        eInt = 0,
        eFloat,
        eTime,
        eUniverse,
        eCombo,
        eToggle,
        eAction,
        eCommand ,
        eStatus
    }; 


    enum Customization
    {
        eSameRow = 0x1,
        eTurnOffLabel = 0x2,
        eDisableAlt = 0x4
        
    }; 


    struct GripValue : public MaxHeapOperators
    {
        union
        {
            int mInt;
            float mFloat;
            int mCombo;
            bool mbool;
        };
        DWORD mFlag; 
    };

    struct ComboLabel : public MaxHeapOperators
    {
        MSTR mLabel;
        MSTR mIcon;
    };



    virtual bool SupportsOkayApplyCancel() =0;

    virtual void Okay(TimeValue t)=0;

    virtual void Cancel()=0;

    virtual void Apply(TimeValue t)=0;

    virtual void GetGripName(MSTR &string) =0;

    virtual int GetNumGripItems() =0;

    virtual IBaseGrip::Type GetType(int which) =0;

    virtual bool GetText(int which,MSTR &string) =0;

    virtual bool GetResolvedIconName(int which,MSTR &string) =0;

    virtual DWORD GetCustomization(int which) =0;

    virtual bool GetComboOptions(int which, Tab<ComboLabel*> &comboOptions)= 0;

    virtual bool GetCommandIcon(int which, MSTR &string)= 0;
    
    virtual bool GetValue(int which,TimeValue t,IBaseGrip::GripValue &value) =0;
    


    virtual bool SetValue(int which,TimeValue t,IBaseGrip::GripValue &value) =0; 
    
    virtual bool StartSetValue(int which,TimeValue t) =0;
    
    virtual bool EndSetValue(int which,TimeValue t,bool accepted) = 0;

    virtual bool ShowKeyBrackets(int which,TimeValue t) =0;



    virtual bool GetAutoScale(int which)=0;

    virtual bool GetScale(int which, IBaseGrip::GripValue &scaleValue) =0;

    virtual bool GetScaleInViewSpace(int which,float &depth) = 0 ;

    virtual bool GetRange(int which,IBaseGrip::GripValue &minRange, IBaseGrip::GripValue &maxRange)=0;

    virtual bool GetResetValue(int which,IBaseGrip::GripValue &resetValue)=0;

    virtual bool ResetValue(TimeValue t,int which)=0;

};

class GripChangedCallback: public MaxHeapOperators {
    public:
        virtual ~GripChangedCallback() {}
        virtual void GripChanged(IBaseGrip *grip)=0;
    };



#define IGRIPMANAGER_INTERFACE   Interface_ID(0x59cb513c, 0x7a0a5232)

#define GetIGripManager()   static_cast<IGripManager*>(GetCOREInterface(IGRIPMANAGER_INTERFACE))



class IGripManager : public FPStaticInterface {

public:


    virtual void SetGripActive(IBaseGrip *grip) =0;
    
    virtual void SetGripsInactive() = 0;

    virtual IBaseGrip *GetActiveGrip() =0;



    virtual bool ActivateGripItem(int whichItem, bool active) = 0;

    virtual bool IsGripItemActive(int whichItem) = 0;

    virtual bool HideGripItem(int whichItem, bool hide) = 0;

    virtual bool IsGripItemVisible(int whichItem) = 0;




    virtual bool ResetGripUI(int whichItem) =0;

    virtual void ResetAllUI() = 0;



    virtual void SetShow(bool val) =0;
    virtual bool GetShow()const =0;
    



    virtual void GetXYLocation(float &x, float &y)=0;

    virtual void SetLocation(int x, int y) =0;  
        virtual void SetCenterOnSelected(bool val) =0;
    virtual bool GetCenterOnSelected()const =0;
    virtual void SetCenterXYPos(float x,float y ) = 0;
    virtual float GetCenterYPos()const = 0;
    virtual float GetCenterXPos()const = 0;

    virtual void SetSelectedOffsetXY(int offsetPixelX, int offsetPixelY)=0;

    virtual int GetSelectedOffsetX()const=0;
    virtual int GetSelectedOffsetY()const=0;



    virtual void SetTransparency(float val) =0;
    virtual float GetTransparency()const=0;
    virtual void SetHoverTransparency(float val) =0;
    virtual float GetHoverTransparency()const=0;



    virtual void SetWidgetSpacing(float spacing)=0;

    virtual float GetWidgetSpacing()const=0;



    virtual void RegisterGripChangedCallback(GripChangedCallback *cB) =0;

    virtual void UnRegisterGripChangedCallback(GripChangedCallback *cB) =0;

    virtual void RecalcLayout() =0;
};