DgnColorMap.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 "ColorUtil.h"

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

typedef RefCountedPtr<DgnColorMap> DgnColorMapPtr;

//=======================================================================================
//=======================================================================================
struct DgnColorMap : public RefCountedBase
{
public:

// NOTE: INDEX_Count is padded beyond INDEX_ByLevel so the color entries and be used as a "light-weight" BSIColorDescr...
enum Entries
    {
    INDEX_ColorCount = 256, 
    INDEX_Background = 255, 
    INDEX_Invalid    = -1,  
    };

private:
    virtual void MakeClassAbstract() = 0;
public:
public:

DGNPLATFORM_EXPORT UInt32* GetTbgrColorsP ();

DGNPLATFORM_EXPORT void GetRgbColors (RgbColorDef* colors); // Background color is index 0

DGNPLATFORM_EXPORT void GetHsvColors (HsvColorDef* colors); // Background color is index 0

DGNPLATFORM_EXPORT IntColorDef const& GetColor (int index);

DGNPLATFORM_EXPORT UInt32 FindClosestMatch (IntColorDef const& colorDef, HsvColorDef* preComputedHSVTable = NULL);

DGNPLATFORM_EXPORT StatusInt SetForFile (DgnFileP dgnFile, WCharCP name);

static DGNPLATFORM_EXPORT DgnColorMapPtr CreateFromRgbColors (RgbColorDef const* colors);

static DGNPLATFORM_EXPORT DgnColorMapPtr CreateFromTbgrColors (UInt32 const* colors);

static DGNPLATFORM_EXPORT DgnColorMapPtr CreateDefaultForFileType (DgnFileFormatType format);

static DGNPLATFORM_EXPORT DgnColorMapP GetForDisplay (DgnModelRefP modelRef);

static DGNPLATFORM_EXPORT DgnColorMapP GetForFile (DgnFileP dgnFile);

static DGNPLATFORM_EXPORT StatusInt GetColorTableDescription (WCharP name, int bufferSize, DgnFileP dgnFile);

static DGNPLATFORM_EXPORT StatusInt ExtractElementColorInfo (IntColorDef* colorDef, UInt32* colorIndex, bool* isTrueColor, WStringP bookName, WStringP colorName, UInt32 elementColor, DgnFileR dgnFile);

static DGNPLATFORM_EXPORT UInt32 CreateElementColor (IntColorDef const& colorDef, WCharCP bookName, WCharCP colorName, DgnFileR dgnFile);
}; 

END_BENTLEY_DGNPLATFORM_NAMESPACE