IBrushPresets.h

Go to the documentation of this file.

//*****************************************************************************/
// Copyright (c) 1998-2005 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//*****************************************************************************/

/**********************************************************************
 *<
    FILE: BrushPresets.h

    DESCRIPTION:    Brush Preset functionality for the PainterInterface

    CREATED BY:     Michaelson Britt

    HISTORY:        Created December 2004
 *>
 **********************************************************************/
#pragma once
#include "maxheap.h"
#include "maxtypes.h"
#include "ifnpub.h"
#include "GetCOREInterface.h"

// forward declarations
class IBrushPreset;
class IBrushPresetParams;
class IBrushPresetContext;
class IBrushPresetMgr;

//-----------------------------------------------------------------------------
// class IBrushPreset


class IBrushPreset: public MaxHeapOperators {
    public:
        virtual ~IBrushPreset() {;}


        virtual int         PresetID() = 0;


        virtual void        Apply() = 0;    // Calls ApplyParams() on every param set

        virtual void        Fetch() = 0;    // Calls FetchParams() on every param set


        virtual IBrushPresetParams* GetParams( Class_ID contextID ) = 0;
        virtual int         GetNumContexts() = 0;

        virtual Class_ID    GetContextID( int contextIndex ) = 0;

        virtual int         GetContextIndex( Class_ID contextID ) = 0;
};


//-----------------------------------------------------------------------------
// class IBrushPresetParams


class IBrushPresetParams: public MaxHeapOperators  {
    public:
        virtual ~IBrushPresetParams() {;}

        virtual Class_ID    ContextID()=0; // The ID of the param set is equal to the ID of its context

        // The presets param object is expected to have access to its associated context.
        // These methods apply the params into the context, or fetch the param values from the context


        virtual void        ApplyParams() = 0;

        virtual void        FetchParams() = 0;

        // Use methods in the BrushPresetContext for metadata about the parameters.
        // Parameter values are stored here.

        virtual int         GetNumParams() = 0;

        virtual int         GetParamID( int paramIndex ) = 0;

        virtual int         GetParamIndex( int paramID ) = 0;

        virtual FPValue     GetParamValue( int paramID ) = 0;

        virtual void        SetParamValue( int paramID, FPValue val ) = 0;

        virtual FPValue     GetDisplayParamValue( int paramID )     {return GetParamValue(paramID);}


        virtual void        SetParent( IBrushPreset* parent ) = 0;
};


//-----------------------------------------------------------------------------
// class IBrushPresetContext


#define STDBRUSHPRESETCONTEXT_ID    Class_ID(0,0x5fb1707c)


class IBrushPresetContext: public MaxHeapOperators {
    public:
        virtual ~IBrushPresetContext() {;}

        virtual Class_ID    ContextID() = 0;
        virtual MCHAR*      GetContextName() = 0;

        virtual IBrushPresetParams* CreateParams() = 0;

        virtual void        DeleteParams( IBrushPresetParams* params ) = 0;

        virtual int         GetNumParams() = 0;

        virtual int         GetParamID( int paramIndex ) = 0;

        virtual int         GetParamIndex( int paramID ) = 0;

        virtual MCHAR*      GetParamName( int paramID ) = 0;

        virtual ParamType2  GetParamType( int paramID ) = 0;

        virtual int         GetNumDisplayParams()                   {return GetNumParams();}

        virtual int         GetDisplayParamID( int displayIndex )   {return GetParamID(displayIndex);}

        virtual int         GetDisplayParamIndex( int paramID )     {return GetParamIndex(paramID);}

        virtual MCHAR*      GetDisplayParamName( int paramID )      {return GetParamName(paramID);}


        virtual BOOL        IsDisplayParam( int paramID )           { UNUSED_PARAM(paramID); return TRUE;}

        virtual BOOL        IsTransientParam( int paramID )         { UNUSED_PARAM(paramID); return FALSE; }

        // Support for deferred plug-in loading


        virtual Class_ID    PluginClassID()=0; // Class ID of the plug-in containing the context

        virtual SClass_ID   PluginSuperClassID()=0; // Superclass ID of the plug-in containing the context
};


//-----------------------------------------------------------------------------
// class BrushPresetMgr


class IBrushPresetMgr : public FPStaticInterface {
    public:
        DECLARE_DESCRIPTOR( IBrushPresetMgr );


        virtual void        RegisterContext( IBrushPresetContext* context ) = 0;

        virtual void        UnRegisterContext( IBrushPresetContext* context ) = 0;


        virtual IBrushPresetContext* GetContext( Class_ID contextID ) = 0;

        virtual int         GetNumContexts() = 0;

        virtual Class_ID    GetContextID( int contextIndex ) = 0; // ID numbers are always > 0

        virtual int         GetContextIndex( Class_ID contextID ) = 0;

        virtual int         BeginContext( Class_ID contextID ) = 0;

        virtual int         EndContext( Class_ID contextID ) = 0;

        virtual BOOL        IsContextActive( Class_ID contextID ) = 0;


        virtual IBrushPreset* GetPreset( int presetID ) = 0;
        virtual IBrushPreset* CreatePreset() = 0;
        virtual void        DeletePreset( IBrushPreset* preset ) = 0;
        virtual int         GetNumPresets() = 0;

        virtual int         GetPresetID( int presetIndex ) = 0;

        virtual int         GetPresetIndex( int presetID ) = 0;


        virtual int         GetActivePreset() = 0;

        virtual void        SetActivePreset( int presetID ) = 0; // Pass zero to deactivate


        virtual void        OnContextUpdated( Class_ID contextID ) = 0;


        virtual int         ReadConfig(MCHAR *cfg=NULL) = 0;

        virtual int         WriteConfig(MCHAR *cfg=NULL) = 0;
};

#define IBRUSHPRESETMGR_INTERFACE_ID Interface_ID(0x586b1d59, 0x454d0ae9)

inline IBrushPresetMgr* GetIBrushPresetMgr()
{ return (IBrushPresetMgr*)GetCOREInterface(IBRUSHPRESETMGR_INTERFACE_ID); }