iparamb2.h

Go to the documentation of this file.

/**********************************************************************
 *<
    FILE: iparamb2.h

    DESCRIPTION: Interface to Parameter blocks, 2nd edition

    CREATED BY: Rolf Berteig,
                John Wainwright, 2nd Ed.

    HISTORY: created 1/25/95
             2nd Ed. 9/2/98

 *> Copyright (c) 1994, All Rights Reserved.
 **********************************************************************/

#pragma once
#include "PB2Export.h"
#include "maxheap.h"
#include "iparamb.h"
#include "iparamm.h"
#include "assetmanagement\AssetType.h"
#include "assetmanagement\AssetId.h"
#include "strbasic.h"         // MCHAR
#include "iparamb2Typedefs.h"
#include "TabTypes.h"
// forward declarations
class Matrix3;
namespace MaxSDK
{
    namespace AssetManagement
    {
        class AssetUser;
    }
}


// per descriptor flags
#define P_CLASS_PARAMS      0x0001      //!< this block holds class-level parameters, attached to ClassDesc
#define P_AUTO_CONSTRUCT    0x0002      //!< instructs ClassDesc2 to autoconstuct this block & wire it in, requires pblock refno
#define P_AUTO_UI           0x0004      //!< this block support automatic UI rollout managements, requires rollout template res ID, etc.
#define P_USE_PARAMS        0x0008      //!< this block shares (exactly) the paramdefs from another descriptor, requires address of source descriptor
#define P_INCLUDE_PARAMS    0x0010      //!< this block loads in a copy the paramdefs from another descriptor, requires address of source descriptor
#define P_MULTIMAP          0x0020      //!< indicates this block as mulitple parameter maps   ### move me
#define P_CALLSETS_ON_LOAD  0x0040      //!< causes CallSets() to be called during load PLCB for this block
#define P_HASCATEGORY       0x0080      //!< indicates, that category field is defined for rollup (after rollupproc)
#define P_TEMPLATE_UI       0x0100      //!< indicates that dialog templates will be provided or constructed


#define P_VERSION           0x0200      //!< indicates a version number is specified (integer value, before pblock refno)

// per descriptor internal flags
#define P_SCRIPTED_CLASS    0x1000      //!< belongs to a scripted plug-in class
#define P_TEMPORARY         0x2000      //!< temporary descriptor built during scene load to support schema migration

// per param constructor-specifiable flags (flag value 1)
#define P_ANIMATABLE        0x00000001  //!< animatable param
#define P_TRANSIENT         0x00000002  //!< do not store actual value, PBAccessor-derived
#define P_NO_INIT           0x00000004  //!< do not initialize
#define P_COMPUTED_NAME     0x00000008  //!< call compute name fn to get name
#define P_INVISIBLE         0x00000010  //!< not visible in track view (if an animatable)
#define P_RESET_DEFAULT     0x00000020  //!< do not make create params sticky, reset to defaults always
#define P_SUBANIM           0x00000040  //!< non-animatable reference param is still a subanim (makes it visible in TV)
#define P_TV_SHOW_ALL       0x00000080  //!< for Tab<> animatables, show all entries even if no controller assigned
#define P_NO_REF            0x00000100  //!< for reftarg params do not maintain Reference automatically
#define P_OWNERS_REF        0x00000200  //!< reference param maintained by owner, specify owner's reference number via the p_refno tag
#define P_CAN_CONVERT       0x00000400  //!< indicates the p_classid validator is is in a CanConvertoTo() call, rather than as exact class
#define P_SUBTEX            0x00000800  //!< indicates texmap param is kept by owner using MtlBase::xSubTexmap protocol, give subtex # in p_subtexno
#define P_VARIABLE_SIZE     0x00001000  //!< Tab<> param is variable size allowing scripted changes
#define P_NO_AUTO_LABELS    0x00002000  //!< don't auto-set map & mtl names for associated button UI controls
#define P_SHORT_LABELS      0x00004000  //!< use short auto names for associated button UI controls
#define P_READ_ONLY         0x00008000  //!< this parameter is not assignable through MAXScript (allows try-and-buy 3rd-party plugins)

/* When used as a ParamBlockDesc2 param flag, the param will not be saved to disk or maintain references or animation keys.
When loading older files, the parameter will be reset after the load is completed, but will be valid during a post-load callback */
#define P_OBSOLETE          0x40000000  // obsolete param, don't maintain refs, a controller or a tab, and don't save to file

/* If this flag is set on the first per param constructor-specifiable flag value, a second DWORD size per param constructor-specifiable 
   flag value follows the first. The value will be read in, shifted left DWORD places and combined with the first flag value to form the 
   ParamDef flag value.*/
#define P_READ_SECOND_FLAG_VALUE 0x80000000  

/* If this flag is set the paramblock2 will only go through the accessor when getting or setting a value, or when determining if a key 
exists at a certain time. If this flag isn't set, the normal operation on a SetValue is to send the value through the accessor first, 
and then set the controller's value; on a GetValue to get the value from the controller and then send it through the accessor.
This flag is specified in the second per param constructor-specifiable flag value*/
#define P_USE_ACCESSOR_ONLY 0x00000001


// per param internal flags
#define P_IS_REF            0x0000000000010000 //!< is a reftarget param
#define P_HAS_DEFAULT       0x0000000000020000 //!< has accessor function => a virtual param
#define P_HAS_CUR_DEFAULT   0x0000000000040000 //!< has a snapshotted current default value
#define P_HAS_MS_DEFAULT    0x0000000000080000 //!< has a MAXScript default
#define P_HAS_RANGE         0x0000000000100000 //!< has a range specified
#define P_HAS_CLASS_ID      0x0000000000200000 //!< a classID validator was given
#define P_HAS_SCLASS_ID     0x0000000000400000 //!< an SClassID validator was given
#define P_UI_ENABLED        0x0000000000800000 //!< indicates whether UI controls are initially enabled or diabled
#define P_HAS_PROMPT        0x0000000001000000 //!< has status line prompt string res ID for various picker buttons
#define P_HAS_CAPTION       0x0000000002000000 //!< has caption string res ID for open/save file dlgs
#define P_HAS_FILETYPES     0x0000000004000000 //!< has file types string res ID for open/save file dlgs (in MAXScript type: form)
#define P_HAS_REFNO         0x0000000008000000 //!< has refno supplied
#define P_HAS_SUBTEXNO      0x0000000010000000 //!< has subtexno supplied


#define P_INCLUDED          0x0000000020000000
#define P_HAS_TOOLTIP       0x0001000000000000 //!< has ToolTip string
#define P_HAS_ASSETTYPE     0x0002000000000000 //!< has asset type
#define P_HAS_ASSETTYPENAME 0x0004000000000000 //!< has asset type name

// Parameter types
#include "paramtype.h"  // parameter type codes

#define base_type(t)    ((ParamType2)((t) & ~(TYPE_TAB)))   //!< get base type ignoring Tab flag
#define root_type(t)    ((ParamType2)((t) & ~(TYPE_TAB | TYPE_BY_VAL | TYPE_BY_REF | TYPE_BY_PTR))) //!< get base type ignoring all flags
#define is_tab(t)       ((t) & TYPE_TAB)                    //!< is this param a table?
#define is_by_val(t)    ((t) & TYPE_BY_VAL)                 //!< is this param passed by value?  (only for FnPub)
#define is_by_ref(t)    ((t) & TYPE_BY_REF)                 //!< is this param passed by reference?  (only for FnPub)
#define is_by_ptr(t)    ((t) & TYPE_BY_PTR)                 //!< is this param passed by pointer?  (only for FnPub)
#define is_ref(d)       (((d).flags & (P_IS_REF | P_NO_REF | P_OWNERS_REF)) == P_IS_REF) //!< is this param a true local refmaker?
#define has_ui(d)       ((d).ctrl_count > 0)                //!< this param has UI info defined
#define reftarg_type(t) (base_type(t) == TYPE_MTL || base_type(t) == TYPE_TEXMAP || base_type(t) == TYPE_INODE || \
                         base_type(t) == TYPE_REFTARG || base_type(t) == TYPE_PBLOCK2 || base_type(t) == TYPE_OBJECT || base_type(t) == TYPE_CONTROL)

class ParamBlockDesc2;
class ClassDesc;
class PBBitmap;
class ParamMap2UserDlgProc;
class MSPluginClass;
class Value;
class Rollout;
class FPInterface;

// parameter value
#pragma pack(push,parameter_entry)
//#pragma pack(1)   // this messes up Win64 builds & the GreatCircle memory debugger

class Texmap;
class Mtl;
class INode;
class IAutoMParamDlg;
class IAutoSParamDlg;
class IAutoEParamDlg;
struct ParamDef;

struct PB2Value: public MaxHeapOperators {
    union
    {
        int                 i;
        float               f;
        Point3*             p;
        Point4*             p4;
        TimeValue           t;
        MCHAR*              s;
        PBBitmap*           bm;
        ReferenceTarget*    r;
        // new for R4
        Matrix3*            m;
        Control*            control;  // replaces i,f,p or t values if animated
        Point2*             p2;
    };
    BYTE flags;

    PB2Export BOOL is_constant();
    PB2Export void Free(ParamType2 type);
};

#pragma pack(pop,parameter_entry)

// defines a parameter alias
struct ParamAlias: public MaxHeapOperators {
    MCHAR*  alias;
    ParamID ID;
    int     tabIndex;
};

// the interface to a ParamBlock2
#pragma warning(push)
#pragma warning(disable:4100)
class IParamBlock2 : public ReferenceTarget 
{
    public:
        virtual DWORD       GetVersion()=0;
        virtual int         NumParams()=0;
        virtual MCHAR*      GetLocalName()=0;
        // acquire & release the descriptor for this paramblock, get individual paramdefs
        virtual ParamBlockDesc2* GetDesc()=0;
        virtual void        ReleaseDesc()=0;
        virtual void        SetDesc(ParamBlockDesc2* desc)=0;
        virtual ParamDef&   GetParamDef(ParamID id)=0;
        // access block ID
        virtual BlockID     ID()=0;
        // index-to/from-ID conversion
        virtual int         IDtoIndex(ParamID id)=0;
        virtual ParamID     IndextoID(int i)=0;
        // get object that owns this block
        virtual ReferenceMaker* GetOwner()=0;

        // Get's the super class of a parameters controller
        virtual SClass_ID GetAnimParamControlType(int anim)=0;
        virtual SClass_ID GetParamControlType(ParamID id)=0;
        // Get the param type & name
        virtual ParamType2 GetParameterType(ParamID id)=0;
        virtual MSTR GetLocalName(ParamID id, int tabIndex = -1)=0; 

        // parameter accessors, one for each known type
        virtual BOOL SetValue(ParamID id, TimeValue t, float v, int tabIndex=0)=0;
        virtual BOOL SetValue(ParamID id, TimeValue t, int v, int tabIndex=0)=0;        
        virtual BOOL SetValue(ParamID id, TimeValue t, Point3& v, int tabIndex=0)=0;        
        virtual BOOL SetValue(ParamID id, TimeValue t, Point4& v, int tabIndex=0)=0;        
        virtual BOOL SetValue(ParamID id, TimeValue t, Color& v, int tabIndex=0)=0;  // uses Point3 controller
        virtual BOOL SetValue(ParamID id, TimeValue t, AColor& v, int tabIndex=0)=0;  // uses Point4 controller
        virtual BOOL SetValue(ParamID id, TimeValue t, const MCHAR* v, int tabIndex=0)=0;
        virtual BOOL SetValue(ParamID id, TimeValue t, Mtl* v, int tabIndex=0)=0;
        virtual BOOL SetValue(ParamID id, TimeValue t, Texmap* v, int tabIndex=0)=0;
        virtual BOOL SetValue(ParamID id, TimeValue t, PBBitmap* v, int tabIndex=0)=0;
        virtual BOOL SetValue(ParamID id, TimeValue t, INode* v, int tabIndex=0)=0;
        virtual BOOL SetValue(ParamID id, TimeValue t, ReferenceTarget* v, int tabIndex=0)=0;
        virtual BOOL SetValue(ParamID id, TimeValue t, IParamBlock2* v, int tabIndex=0)=0;
        virtual BOOL SetValue(ParamID id, TimeValue t, Matrix3& v, int tabIndex=0)=0;       

        virtual BOOL SetValue(ParamID id, TimeValue t, const MaxSDK::AssetManagement::AssetUser& v, int tabIndex=0)=0;      


        virtual BOOL GetValue(ParamID id, TimeValue t, float& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, int& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, Point3& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, Point4& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, Color& v, Interval &ivalid, int tabIndex=0)=0; // uses Point3 controller
        virtual BOOL GetValue(ParamID id, TimeValue t, AColor& v, Interval &ivalid, int tabIndex=0)=0; // uses Point4 controller
        virtual BOOL GetValue(ParamID id, TimeValue t, const MCHAR*& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, Mtl*& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, Texmap*& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, PBBitmap*& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, INode*& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, ReferenceTarget*& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, IParamBlock2*& v, Interval &ivalid, int tabIndex=0)=0;
        virtual BOOL GetValue(ParamID id, TimeValue t, Matrix3& v, Interval &ivalid, int tabIndex=0)=0;

        virtual BOOL GetValue(ParamID id, TimeValue t, MaxSDK::AssetManagement::AssetUser& v, Interval &ivalid, int tabIndex=0)=0;

        // short cut getters for each type
        virtual Color       GetColor(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual AColor      GetAColor(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual Point3      GetPoint3(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual Point4      GetPoint4(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual int         GetInt(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual float       GetFloat(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual TimeValue   GetTimeValue(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual const MCHAR*        GetStr(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual Mtl*        GetMtl(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual Texmap*     GetTexmap(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual PBBitmap*   GetBitmap(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual INode*      GetINode(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual ReferenceTarget* GetReferenceTarget(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual IParamBlock2* GetParamBlock2(ParamID id, TimeValue t=0, int tabIndex=0)=0;
        virtual Matrix3     GetMatrix3(ParamID id, TimeValue t=0, int tabIndex=0)=0;

        virtual MaxSDK::AssetManagement::AssetUser  GetAssetUser(ParamID id, TimeValue t=0, int tabIndex=0)=0;

        // and one to get the value in a PB2Value 
        virtual PB2Value& GetPB2Value(ParamID id, int tabIndex=0)=0;


        // parameter Tab management
        virtual int     Count(ParamID id)=0;
        virtual void    ZeroCount(ParamID id)=0;
        virtual void    SetCount(ParamID id, int n)=0;
        virtual int     Delete(ParamID id, int start,int num)=0; 
        virtual int     Resize(ParamID id, int num)=0;
        virtual void    Shrink(ParamID id)=0;
        virtual void    Sort(ParamID id, CompareFnc cmp)=0;
        // Tab Insert for each type
        virtual int     Insert(ParamID id, int at, int num, float* el)=0;
        virtual int     Insert(ParamID id, int at, int num, Point3** el)=0;
        virtual int     Insert(ParamID id, int at, int num, Point4** el)=0;
        virtual int     Insert(ParamID id, int at, int num, Color** el)=0;
        virtual int     Insert(ParamID id, int at, int num, AColor** el)=0;
        virtual int     Insert(ParamID id, int at, int num, TimeValue* el)=0;
        virtual int     Insert(ParamID id, int at, int num, MCHAR** vel)=0;
        virtual int     Insert(ParamID id, int at, int num, const MCHAR** vel)=0;
        virtual int     Insert(ParamID id, int at, int num, Mtl** el)=0;
        virtual int     Insert(ParamID id, int at, int num, Texmap** el)=0;
        virtual int     Insert(ParamID id, int at, int num, PBBitmap** el)=0;
        virtual int     Insert(ParamID id, int at, int num, INode** v)=0;
        virtual int     Insert(ParamID id, int at, int num, ReferenceTarget** el)=0;
        virtual int     Insert(ParamID id, int at, int num, IParamBlock2** el)=0;
        virtual int     Insert(ParamID id, int at, int num, Matrix3** el)=0;
        // Tab Insert for each type
        virtual int     Append(ParamID id, int num, float* el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, Point3** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, Point4** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, Color** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, AColor** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, TimeValue* el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, MCHAR** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, const MCHAR** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, Mtl** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, Texmap** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, PBBitmap** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, INode** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, ReferenceTarget** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, IParamBlock2** el, int allocExtra=0)=0;
        virtual int     Append(ParamID id, int num, Matrix3** el, int allocExtra=0)=0;

        virtual BOOL KeyFrameAtTimeByIndex(int i,      TimeValue t, int tabIndex=0) { return FALSE; }
        MAX_DEPRECATED BOOL KeyFrameAtTime(int i,      TimeValue t, int tabIndex=0);
        virtual BOOL KeyFrameAtTimeByID(ParamID id, TimeValue t, int tabIndex=0) { return KeyFrameAtTimeByIndex(IDtoIndex(id), t, tabIndex); }
        MAX_DEPRECATED BOOL KeyFrameAtTime(ParamID id, TimeValue t, int tabIndex=0);
        virtual void RemoveControllerByIndex(int i, int tabIndex)=0;
        MAX_DEPRECATED void RemoveController(int i, int tabIndex);
        virtual Control*    GetControllerByID(ParamID id, int tabIndex=0)=0;
        MAX_DEPRECATED Control* GetController(ParamID id, int tabIndex=0);
        virtual Control*    GetControllerByIndex(int i, int tabIndex=0)=0;
        MAX_DEPRECATED Control* GetController(int i, int tabIndex=0);
        virtual void        SetControllerByIndex(int i, int tabIndex, Control* c, BOOL preserveFrame0Value=TRUE)=0;
        virtual void        SetControllerByID(ParamID id, int tabIndex, Control* c, BOOL preserveFrame0Value=TRUE) { SetControllerByIndex(IDtoIndex(id), tabIndex, c, preserveFrame0Value); }
        MAX_DEPRECATED void SetController(int i, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE);
        MAX_DEPRECATED void SetController(ParamID id, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE);
        virtual void        SwapControllers(int i1, int tabIndex1, int i2, int tabIndex2)=0;

        // Given the param num & optional Tab<> index, what is the refNum?
        virtual int GetRefNum(int i, int tabIndex=0)=0;
        // Given the param num & optional Tab<> index, what is the animated param controller refnum?
        virtual int GetControllerRefNum(int i, int tabIndex=0)=0;

        // Given the parameter ID what is the animNum?
        virtual int GetAnimNum(ParamID id, int tabIndex=0)=0;

        // Given the animNum what is the parameter index?
        virtual int AnimNumToParamNum(int animNum, int& tabIndex)=0;

        virtual ParamDimension* GetParamDimension(int subAnim)=0;

        // This is only for use in a RescaleWorldUnits() implementation:
        // The param block implementation of RescaleWorldUnits scales only tracks
        // that have dimension type = stdWorldDim. If letting the param block handle 
        // the rescaling is not sufficient, call this on just the parameters you need to rescale.
        virtual void RescaleParam(int paramNum, int tabIndex, float f)=0;

        // When a NotifyRefChanged is received from a param block, you 
        // can call this method to find out which parameter generated the notify.
        virtual ParamID LastNotifyParamID()=0;
        virtual ParamID LastNotifyParamID(int& tabIndex)=0;  // variant also returns changing element index
        
        // control notifications, enable/disable send NotifyRefChanged messages when parameters change (via SetValue(), eg)
        virtual void EnableNotifications(BOOL onOff)=0;

        virtual BOOL IsNotificationEnabled() = 0;

        // allows owner to signal pblock when P_OWNER_REF params are deleted
        virtual void RefDeleted(ParamID id, int tabIndex=0)=0;

        // ParamMap2 access, 
        virtual void SetMap(IParamMap2* m, MapID map_id = 0)=0;
        virtual IParamMap2* GetMap(MapID map_id = 0)=0;
        // rollout state, normally used by ParamMap2 to automatically save & restore state 
        virtual void SetRolloutOpen(BOOL open, MapID map_id = 0)=0;
        virtual BOOL GetRolloutOpen(MapID map_id = 0)=0;
        virtual void SetRolloutScrollPos(int pos, MapID map_id = 0)=0;
        virtual int GetRolloutScrollPos(MapID map_id = 0)=0;

        // ParamDlg access, 
        virtual IAutoMParamDlg* GetMParamDlg()=0;
        virtual IAutoEParamDlg* GetEParamDlg()=0;

        // init parameters with MAXScript defaults
        virtual void InitMSParameters()=0;

        // alias maintenance
        virtual void DefineParamAlias(MCHAR* alias_name, ParamID id, int tabIndex=-1)=0;
        virtual ParamAlias* FindParamAlias(MCHAR* alias_name)=0;
        virtual MCHAR* FindParamAlias(ParamID id, int tabIndex=-1)=0;
        virtual void ClearParamAliases()=0;
        virtual int ParamAliasCount()=0;
        virtual ParamAlias* GetParamAlias(int i)=0;

        // set subanim number for given param
        virtual void SetSubAnimNum(ParamID id, int subAnimNum, int tabIndex=0)=0;
        virtual void ClearSubAnimMap()=0;

        // parameter value copying, copy src_id param from src block to id param in this block
        virtual void Assign(ParamID id, IParamBlock2* src, ParamID src_id)=0;

        // find the param ID & tabIndex for given ReferenceTarget(either as a subanim or reftarg parameter)
        virtual ParamID FindRefParam(ReferenceTarget* ref, int& tabIndex)=0;

        // reset params to default values
        virtual void ResetAll(BOOL updateUI = TRUE, BOOL callSetHandlers = TRUE)=0;
        virtual void Reset(ParamID id, int tabIndex=-1, BOOL updateUI = TRUE, BOOL callSetHandlers = TRUE)=0;
        // force a call to the PBAccessor Get()/Set() functions for a param or all params
        virtual void CallSet(ParamID id, int tabIndex=-1)=0;
        virtual void CallGet(ParamID id, int tabIndex=-1)=0;
        virtual void CallSets()=0;
        virtual void CallGets()=0;
        // get validity of all params in all paramblock
        virtual void GetValidity(TimeValue t, Interval &valid)=0;
};

// specialize this class to provide a custom SetValue() validator
// the Validate() function should return falsi if the given PB2Value is
// not valid
class PBValidator : public InterfaceServer
{
public:
    virtual BOOL Validate(PB2Value& v) = 0;
    virtual BOOL Validate(PB2Value& v, ReferenceMaker* owner, ParamID id, int tabIndex) { return this->Validate(v); }
    virtual void DeleteThis() { };
};

// specialize this class to provide 'virtual' parameter value accessor functions
class PBAccessor : public InterfaceServer
{
public:
    // get into v
    virtual void Get(PB2Value& v, ReferenceMaker* owner, ParamID id, int tabIndex, TimeValue t, Interval &valid) { }    
    // set from v
    virtual void Set(PB2Value& v, ReferenceMaker* owner, ParamID id, int tabIndex, TimeValue t) { }                      
    // computed keyframe presence
    virtual BOOL KeyFrameAtTime(ReferenceMaker* owner, ParamID id, int tabIndex, TimeValue t) { return FALSE; }
    // computed parameter localized (subanim) name, only called if P_COMPUTED_NAME is flagged
    virtual MSTR GetLocalName(ReferenceMaker* owner, ParamID id, int tabIndex) { return _M(""); }
    // called when a Tab<> parameter has a change made to its table structure
    enum tab_changes { tab_insert, tab_append, tab_delete, tab_ref_deleted, tab_setcount, tab_sort };
    virtual void TabChanged(tab_changes changeCode, Tab<PB2Value>* tab, ReferenceMaker* owner, ParamID id, int tabIndex, int count) { }
    // implement this if your PBAccessors are dynamically allocated
    virtual void DeleteThis() { };
};

#pragma warning(pop)
// Parameter Block Descriptors
//    in PB2s, there is one ParamBlockDesc2 per entire PB, containing
//    the metadata for all the parameters in the PB.  All the PBs
//    mapped by this structure contain pointers back to it and the 
//    owning class's ClassDesc contains all the PB2Descs for PBs in
//    its objects

// HEY!  for the moment, all the possible optional parameters are in extensis.  If
//       this proves a big memory hog, we can institute some kind of streaming
//       scheme that packs used optionals into a single mem buffer.  The GetDesc() 
//       function should be used to access the PBD in all cases to allow this caching.
//       sizeof(ParmDef) ~ 70 bytes, so for 2500 params =~ 175K bytes
 
#pragma pack(push, parameter_def)
// #pragma pack(1)   // this messes up Win64 builds & the GreatCircle memory debugger

struct ParamDef: public MaxHeapOperators
{
    DWORD size;
    //public:
    ParamID     ID;             // pos independent ID
    MCHAR*      int_name;       // fixed internal name
    ParamType2  type;           // parameter type
    ULONGLONG   flags;          // status flags
    // optional
    StringResID local_name;     // localized (subabim) name (string res id)
    ParamDimension* dim;        // parameter dimension
    PB2Value    def;            // default value
    PB2Value    ms_def;         // default value for MAXScript & MacroRecorder
    PB2Value    cur_def;        // current 'sticky' default value, used to maintain creation defaults within a session
    int         description;    // one sentence description (string res id)
    PB2Value    range_low;      // range values
    PB2Value    range_high;
    PBValidator* validator;     // validator object
    PBAccessor* accessor;       // virtual param accessor object
    short       tab_size;       // initial table size
    short       ref_no;         // block-owner's refno for non-hosted ReferenceTargets
    short       subobj_no;      // block-owner's SubTex/SubMtl index for Texmap/Mtl parameters in Mtl owners
    Class_ID    class_ID;       // validator for reftargs
    SClass_ID   sclass_ID;      //    "       "     "
    // UI optional
    ControlType2 ctrl_type;     // type of UI control
    EditSpinnerType spin_type;  // spinner type if spinner
    int*        ctrl_IDs;       // array of control IDs for this control  (or ui element names if for scripted plugin)
    short       ctrl_count;     // number of controls
    union { // radiobutton vals or bit numbers for int bits controlled by multiple checkboxes
        int* val_bits;
        float* val_bits_float;
        };

    float       scale;          // display scale
// begin - mjm 12.19.98
    int     numSegs;        // slider segments
// end - mjm 12.19.98
    ParamID*    enable_ctrls;   // array of which other params ahave their UI ctrls automatically enabled by this param
    short       enable_count;   // count of enable control params
    int     prompt;         // status line prompt string res ID for various picker buttons
    int     caption;        // caption string res ID for open/save file dlgs
    int toolTip;
    MCHAR*      init_file;      // initial filename for open/save file dlgs
    int     file_types;     // file types string res ID for open/save file dlgs (in MAXScript type: form)
    // new for R4
    Tab<MapID>  maps;

    MCHAR *     dyn_file_types; 

    MaxSDK::AssetManagement::AssetType asset_type_id;

    PB2Export void DeleteThis();
    ParamDef() { size = sizeof(ParamDef);}
};
        
#pragma pack(pop, parameter_def)

/* ----------------------- ClassDesc2 ------------------------------------*/

class MtlBase;
class SpecialFX; // mjm - 07.06.00

// 2nd Edition of ClassDesc with necessary extra stuff for ParamBlock2 support
class ClassDesc2 : public ClassDesc 
{
    private:
        Tab<ParamBlockDesc2*>   pbDescs;        // parameter block descriptors
        Tab<IParamMap2*>        paramMaps;      // any current param maps
        IAutoMParamDlg*         masterMDlg;     // master material/mapParamDlg if any
        IAutoEParamDlg*         masterEDlg;     // master EffectParamDlg if any

    protected:
        

        void SetMParamDlg(IAutoMParamDlg* dlg) { masterMDlg = dlg; }