icolorman.h

Go to the documentation of this file.

 /**********************************************************************
 *<
    FILE: iColorMan.h

    DESCRIPTION: Color Manager

    CREATED BY: Scott Morrison

    HISTORY: Created 19 April, 2000,

 *> Copyright (c) 2000, All Rights Reserved.
 **********************************************************************/
#pragma once

#ifdef CUSTDLG_IMP
#define CustDlgExport __declspec(dllexport)
#else
#define CustDlgExport __declspec(dllimport)
#endif

#include "iFnPub.h"

typedef DWORD ColorId;

const ColorId kBackground    = 0;  
const ColorId kText          = 1;  
const ColorId kActiveCommand = 4;  
const ColorId kHilight       = 5;  
const ColorId kShadow        = 6;  
const ColorId kWindow        = 7;  
const ColorId kActiveCaption = 8;  
const ColorId kToolTipBackground = 9; 
const ColorId kToolTipText   = 10; 
const ColorId kHilightText   = 11; 
const ColorId kWindowText    = 12; 
const ColorId kItemHilight   = 13; 
const ColorId kSubObjectColor= 14; 
const ColorId k3dDarkShadow  = 15; 
const ColorId k3dLight       = 16; 
const ColorId kAppWorkspace  = 17; 
const ColorId kTrackbarBg    = 18; 
const ColorId kTrackbarBgSel = 19; 
const ColorId kTrackbarText  = 20; 
const ColorId kTrackbarTicks = 21; 
const ColorId kTrackbarKeys  = 22; 
const ColorId kTrackbarSelKeys = 23; 
const ColorId kTrackbarCursor  = 24; 
const ColorId kPressedButton   = 25; 
const ColorId kTimeSliderBg    = 26; 
const ColorId kViewportBorder  = 27; 
const ColorId kActiveViewportBorder = 28; 
const ColorId kRollupTitleFace      = 29; 
const ColorId kRollupTitleText      = 30; 
const ColorId kRollupTitleHilight   = 31; 
const ColorId kRollupTitleShadow    = 32; 
const ColorId kSelectionRubberBand  = 33; 
const ColorId kStackViewSelection = 34; 
const ColorId kImageViewerBackground = 35; 
const ColorId kIRenderProgressHoriz = 36; 
const ColorId kIRenderProgressVert  = 37; 
const ColorId kPressedHierarchyButton  = 38; 
const ColorId kTrackViewBackground  = 39; 
const ColorId kTrackViewInactiveBackground  = 40; 
const ColorId kManipulatorsActive  = 41; 
const ColorId kManipulatorsSelected  = 42; 
const ColorId kManipulatorsInactive  = 43; 
const ColorId kFunctionCurveX = 44; 
const ColorId kFunctionCurveY = 45; 
const ColorId kFunctionCurveZ = 46; 
const ColorId kFunctionCurveW = 47;  
const ColorId kFunctionCurveFloat = 48;  
const ColorId kFunctionCurveSelected = 49;  
const ColorId kTrackViewTrackText = 50; 
const ColorId kTrackViewSelInstantTime = 51; 
const ColorId kTrackViewKeyCursor = 52; 
const ColorId kTrackViewSelectedBackground = 53; 
const ColorId kTrackViewDisabledTrack1 = 54; 
const ColorId kTrackViewDisabledTrack2 = 55; 
const ColorId kTrackViewEnabledTrack1 = 56; 
const ColorId kTrackViewEnabledTrack2 = 57; 
const ColorId kTrackViewTimeCursor = 58; 
const ColorId kTrackViewGrid = 59; 
const ColorId kTrackViewUnSelectedKeys = 60; 
const ColorId kTrackViewSelectedKeys = 61; 
const ColorId kTrackViewKeyOutline = 62; 
const ColorId kTrackViewKeyOutlineOnTop = 63; 
const ColorId kViewportShowDependencies = 64; 
const ColorId kTrackViewSoundTrackRight = 65; 
const ColorId kTrackViewSoundTrackLeft = 66; 
const ColorId kAssemblyOutline  = 67; 
const ColorId kTrackViewKeyPosition = 68; 
const ColorId kTrackViewKeyRotation = 69; 
const ColorId kTrackViewKeyScale = 70; 
const ColorId kTrackViewKeyTransform = 71; 
const ColorId kTrackViewKeyObject = 72; 
const ColorId kTrackViewKeyMaterial = 73; 
const ColorId kTrackViewTangentHandle = 74; 
const ColorId kTrackViewAutoTangentHandle = 75; 
const ColorId kTrackViewKeyMixed = 76; 
const ColorId kTrackViewKeyFake = 77; 

const ColorId kTrackbarKeyPosition  = 79; 
const ColorId kTrackbarKeyRotation  = 80; 
const ColorId kTrackbarKeyScale = 81; 
const ColorId kTrackbarKeyTransform = 82; 
const ColorId kTrackbarKeyObject = 83; 
const ColorId kTrackbarKeyMaterial = 84; 
const ColorId kTrackbarKeyMixed = 85; 
const ColorId kTrackViewScaleOriginLine = 86; 
const ColorId kTrackViewKeyFCurveSelected = 87; 
const ColorId kTrackViewKeyFCurveUnSelected = 88; 

const ColorId kOutOfRangeLow = 89; 
const ColorId kOutOfRangeHigh = 90; 

const ColorId kTrackViewRangeIgnored = 91; 
const ColorId kTrackViewRangeIgnoredSel = 92; 

const ColorId kAdaptiveDegActive = 93; 

const ColorId kTrackViewControllerWindowToggle  = 94; 
const ColorId kTrackViewRegionSelectBorder  = 95; 
const ColorId kTrackViewRegionSelectGrip  = 96; 
const ColorId kTrackViewRegionSelectRegion = 97; 
const ColorId kTrackViewRegionSelectOuterRegion = 98; 


#define COLOR_MGR_INTERFACE  Interface_ID(0x1bf46c90, 0x18bf6199)

class IColorManager: public FPStaticInterface {

public:

    enum ColorSchemeType
    {
        CST_CUSTOM = 0,
        CST_STANDARDWINDOWS,
        CST_WINDOWSTHEME
    };

    enum AppFrameColorTheme {
        kDarkTheme  = 0,
        kLightTheme = 1
    };

    virtual ColorSchemeType GetColorSchemeType() = 0;

    virtual void SetColorSchemeType(ColorSchemeType type) = 0;

    // Register a new color with the system.
    // Return false if the color is already registered.
    virtual bool RegisterColor(ColorId id, const MCHAR* pName, const MCHAR* pCategory, COLORREF defaultValue) = 0;

    virtual BOOL LoadColorFile(const MCHAR* pFileName) = 0;
    virtual BOOL SaveColorFile(const MCHAR* pFileName) = 0;
    virtual const MCHAR* GetColorFile() = 0;

    // Access to the customized colors
    virtual bool     SetColor(ColorId id, COLORREF color) = 0;
    virtual COLORREF GetColor(ColorId id) = 0;
    virtual Point3   GetColorAsPoint3(ColorId id) = 0;
    virtual HBRUSH   GetBrush(ColorId id) = 0;
    virtual const MCHAR*   GetName(ColorId id) = 0;
    virtual const MCHAR*   GetCategory(ColorId id) = 0;


    virtual COLORREF CustSysColor(int which) = 0;
    virtual HBRUSH   CustSysColorBrush(int which) = 0;

    // Interface for old "GetUIColor" call from gfx.
    // The colors are defined in gfx.h
    virtual Point3 GetOldUIColor(int which) = 0;
    virtual void   SetOldUIColor(int which, Point3 *clr) = 0;
    virtual Point3 GetOldDefaultUIColor(int which) = 0;

    // Icon Image processing
    // The following values are used to do image processing on the icons
    // at start-up time.
    enum IconType {
        kDisabledIcon,
        kEnabledIcon
    };

    enum IconColorScale {
        kSaturationScale,
        kValueScale,
        kAlphaScale,
        kContrastScale,
        kGradientMapScale
    };

    virtual float GetIconColorScale(IconType type, IconColorScale which) = 0;
    virtual void  SetIconColorScale(IconType type, IconColorScale which, float value) = 0;

    virtual bool GetIconColorInvert(IconType type) = 0;
    virtual void SetIconColorInvert(IconType type, bool value) = 0;

    virtual AppFrameColorTheme GetAppFrameColorTheme() const = 0;
    virtual void SetAppFrameColorTheme(AppFrameColorTheme value) = 0;

    virtual const MCHAR* GetFileName() = 0;

    virtual COLORREF GetDefaultColor(ColorId id) = 0;

    // Get an old UI color as a COLORREF
    virtual COLORREF GetOldUIColorCOLORREF(int which) = 0;

    enum RepaintType {
        kRepaintAll,
        kRepaintTrackBar,
        kRepaintTimeBar,
    };

    virtual void RepaintUI(RepaintType type) = 0;

    // Set the folder that is searched for UI icon files.
    // This must be a folder that lives under the "UI" folder.
    virtual BOOL SetIconFolder(const MCHAR* pFolder) = 0;

    // returns the full path to the icon folder.
    virtual const MCHAR* GetIconFolder() = 0;

    // reinitializes the display icons using the UI icon files.
    virtual void ReInitIcons() = 0;

    // given an icon file name (no path), locate the icon file in the various
    // icon folders and return the fully resolved file name with path. If file
    // is found return TRUE and fill in path, otherwise return FALSE;
    virtual BOOL ResolveIconFolder(const MCHAR* pFilename, MSTR &path) = 0;

#ifdef USE_NEW_CUI_IO_METHODS // russom - 02/16/02
    // save and load icon folder file
    virtual BOOL SaveIconFile( const MCHAR *szFilename, const MCHAR *szIconPath ) = 0;
    virtual BOOL LoadIconFile( const MCHAR *szFilename ) = 0;
    virtual const MCHAR* ReadIconFile() = 0;
#endif

    //Function-published interface
    enum {
#ifndef NO_CUI  // russom - 02/12/02
        registerColor,
        loadColorFile,
        saveColorFile,
        getColorFile,
        setColor,
#endif // NO_CUI
        getColor,
        getName,
        getCategory,
        getIconColorScale,
#ifndef NO_CUI  // russom - 02/20/02
        setIconColorScale,
#endif
        getIconColorInvert,
#ifndef NO_CUI  // russom - 02/20/02
        setIconColorInvert,
#endif
        getFileName,
        getDefaultColor,
        getOldUIColorCOLORREF,
        repaintUI,
#ifndef NO_CUI  // russom - 02/20/02
        setIconFolder,
        reInitIcons,
#endif
        getIconFolder,
#ifdef USE_NEW_CUI_IO_METHODS
        saveIconFile,
 #ifndef NO_CUI // russom - 02/25/02
        loadIconFile,
        readIconFile,
 #endif // NO_CUI
#endif // USE_NEW_CUI_IO_METHODS
        resolveIconFolder,
        getColorSchemeType,
        setColorSchemeType
    };

    // Function-published enums
    enum {
        iconType,
        iconColorScale,
        repaintType,
        colorSchemeType,
    };
};

// defined in CustomizationDialgos/CustColorDlg.cpp
CustDlgExport void SaveColors();

#ifdef CoreExport
CoreExport void DeleteColorManager(IColorManager* pColorMan);

CoreExport IColorManager* GetColorManager();
#endif

// Easy access macros for the system's color manager
#define ColorMan() (GetColorManager())
#define GetCustSysColor(which) (ColorMan()->CustSysColor(which))
#define GetCustSysColorBrush(which) (ColorMan()->CustSysColorBrush(which))