iRenderPresets.h

Go to the documentation of this file.

//
//
//  Render Preset Interface
//
//  Created 5/14/2003   Tom Burke
//

#pragma once

#include "maxheap.h"
#include "bitarray.h"
#include "tab.h"
#include "strbasic.h"

#define RENDER_PRESETS_CATEGORY_COUNT               64
#define RENDER_PRESETS_CUSTOM_CATEGORY_INDEX_BEGIN  32


// return values
//
#define RENDER_PRESETS_SUCCESS              0
#define RP_ERROR_OBSOLETE_FILE              1
#define RP_ERROR_INCOMPATABLE_FILE          2
#define RP_ERROR_CATEGORY_NOT_COMPATABLE    3
#define RP_ERROR_SAVING_FILE                4
#define RP_ERROR_LOADING_FILE               5
#define RP_ERROR_CANCEL                     6
#define RP_ERROR_FILE_NOT_FOUND             7


class RenderPresetsContext: public MaxHeapOperators {
public:
    RenderPresetsContext( int version, BitArray categories ) { mVersion = version; mCategories = categories; }
    BitArray GetCategories() { return mCategories; }
    int       GetVersion() { return mVersion; }

private:
    int      mVersion;
    BitArray mCategories;
};

class IRenderPresetsManager: public MaxHeapOperators {
public:
    enum RendererSpecifier
    {
        kProduction = 0,
        kMaterial,
        kActiveShade
    };

    enum NodeRefAction
    {
        kUnspecified = -1,
        kLoadAll = 0,
        kLoadNonNodeRefMakers = 1,
        kLoadNone = 2,
    };

    virtual ~IRenderPresetsManager() {;}
  
    virtual int      Save( RendererSpecifier rendSpecifier ) = 0;
    virtual int      Save( RendererSpecifier rendSpecifier, const MCHAR * fileName ) = 0;
    virtual int      Save( RendererSpecifier rendSpecifier, const MCHAR * fileName, BitArray saveCategories ) = 0;

    virtual int      Load( RendererSpecifier rendSpecifier ) = 0;
    virtual int      Load( RendererSpecifier rendSpecifier, const MCHAR * fileName ) = 0;
    virtual int      Load( RendererSpecifier rendSpecifier, const MCHAR * fileName, BitArray loadCategories, NodeRefAction nodeRefAction = kUnspecified ) = 0;

    virtual int      IsFileCompatible( RendererSpecifier rendSpecifier, const MCHAR * fileName ) = 0;  

    // Convert between category index and category name for render preset files

    virtual MCHAR *  MapIndexToCategory( const MCHAR * fileName, int catIndex  ) = 0;
    virtual int      MapCategoryToIndex( const MCHAR * fileName, const MCHAR* category ) = 0;

    virtual MCHAR *  MapIndexToCategory( RendererSpecifier rendSpecifier, int catIndex  ) = 0;
    virtual int      MapCategoryToIndex( RendererSpecifier rendSpecifier, const MCHAR* category ) = 0;

    virtual BitArray LoadCategories( const MCHAR * fileName ) = 0; // list of categories saved in the file
    virtual Tab<MCHAR *> LoadCategoryNames( const MCHAR * fileName ) = 0;

    virtual BitArray SaveCategories( RendererSpecifier rendSpecifier ) = 0;
    virtual Tab<MCHAR *> SaveCategoryNames( RendererSpecifier rendSpecifier ) = 0;

    virtual RenderPresetsContext * GetContext() = 0;
};