ColorUtil.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include "DgnPlatform.h"

BENTLEY_TYPEDEFS (RgbColorDef)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

enum ColorDefConstants
{
    MAX_COLOR_NAME_SIZE     = 30,
    MAX_CMAPENTRIES         = 256,
    MAX_CTBLBYTES           = (MAX_CMAPENTRIES * 3),
    MAX_CTBLNAMESIZE        = 64,
    MAX_ExtendedColorIndex  = 0x0fffff,  // Use 20 bits of high 24.

    // Menu Color Indexes 
    BLACK_MENU_COLOR_INDEX      = 0,
    BLUE_MENU_COLOR_INDEX       = 1,
    GREEN_MENU_COLOR_INDEX      = 2,
    CYAN_MENU_COLOR_INDEX       = 3,
    RED_MENU_COLOR_INDEX        = 4,
    MAGENTA_MENU_COLOR_INDEX    = 5,
    YELLOW_MENU_COLOR_INDEX     = 6,
    WHITE_MENU_COLOR_INDEX      = 7,
    LGREY_MENU_COLOR_INDEX      = 8,
    DGREY_MENU_COLOR_INDEX      = 9,
    MGREY_MENU_COLOR_INDEX      = 10,

    NUM_MENU_COLORS         = 12,  // number of menu colors
    NUM_NEW_FIXED_COLORS    = 6,
    NEW_NUM_MENU_COLORS     = NUM_MENU_COLORS+NUM_NEW_FIXED_COLORS,

    // Method Ids for setting and querying color descriptors
    COLORD_RGB                   = 1,   // S/Q
    COLORD_HSV                   = 2,   // S/Q
    COLORD_XCOLORID              = 3,   // S/Q
    COLORD_XNAMEID               = COLORD_XCOLORID,
    COLORD_XCOLORSTRING          = 4,   // S/Q
    COLORD_XNAMESTR              = COLORD_XCOLORSTRING,
    COLORD_ELEM_COLOR_NUMBER     = 5,   // S/Q
    COLORD_MENUCOLORID           = 6,   // S/Q
    COLORD_ATTRDATA              = 7,   // BSI-only
    COLORD_RGBDITHERED           = 8,   // BSI-only
    COLORD_VPAL_INDEX            = 9,   // Q-only
    COLORD_ELEM_COLOR_REF        = 10,  // S-only
    COLORD_DRAW_VALUE            = 20,  // S/Q
    COLORD_DRAW_INDEX            = COLORD_DRAW_VALUE,

    // Bit flags for "asetFlags" member of palette entry.
    PALFLAG_MATCHLOADEDCOLORS    = 0x0,
    PALFLAG_MATCHDGNCTBL         = 0x1,

    // Palette Status flags
    PALSTATUS_SYNCHABLE          = 0x01,

    // Color matching flags
    COLOR_STRESS_DEFAULT         = 0,
    COLOR_STRESS_HUE             = 0x1,
    COLOR_STRESS_SATURATION      = 0x2,
    COLOR_STRESS_VALUE           = 0x4,

    // Palette Synch flags
    SYNCH_DUE_TO_LOAD_COLORS     = 1,
    SYNCH_DUE_TO_CMAP_CHG        = 2,
};


//=======================================================================================
//=======================================================================================
union IntColorDef
{
    RgbColorDef     m_rgb;
    RgbaColorDef    m_rgba;
    UInt32          m_int;
    
    void SetColors (Byte r, Byte g, Byte b, Byte a) {m_rgba.red = r; m_rgba.green = g; m_rgba.blue = b; m_rgba.alpha = a;}
                
    IntColorDef () {m_int = 0;}
    IntColorDef (RgbColorDef rgb) {m_int = 0; m_rgb = rgb;}
    IntColorDef (UInt32 intval) {m_int=intval;}
    IntColorDef (Byte red, Byte green, Byte blue) {SetColors (red,green,blue,0);}
    IntColorDef (Byte red, Byte green, Byte blue, Byte alpha) {SetColors (red,green,blue,alpha);}
};


END_BENTLEY_DGNPLATFORM_NAMESPACE