NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
gl2d_palette_interface.h
Go to the documentation of this file.
1 #ifndef SDK_GL2D_PALETTE_INTERFACE_H_
11 #define SDK_GL2D_PALETTE_INTERFACE_H_
12 #pragma once
13 
14 #include <base/inc/platform.h>
15 #include <base/inc/base_types.h>
16 #include <base/inc/sdk_component_base.h>
18 #include <visualizationlayer/inc/vis_const.h>
19 
20 SDK_GL2D_BEGIN_NAMESPACE
21 
24 
28 {
29 };
30 
34 {
35  // Unknown palette type
36  kGL2DPaletteType_Unknown = 0,
37 
38  // 256 colors palette, SDKUint8 color index points to appropriate palette color
39  kGL2DPaletteType_256 = 1,
40 };
41 
44 class IGL2DPalette : public ISDKProperties
45 {
46 public:
48  virtual void SDK_CALLTYPE Dump() const throw() = 0;
49 
51  virtual IGL2DCanvasSP SDK_CALLTYPE GetParent() const throw() = 0;
52 
54  virtual GL2DPaletteType SDK_CALLTYPE GetType() const throw() = 0;
55 
57  virtual SDKUInt32 SDK_CALLTYPE GetColorsCount() const throw() = 0;
59  inline SDKUInt32 SDK_CALLTYPE GetMaxColorIndex() const
60  { return GetColorsCount() - 1UL; }
62  virtual SDKResult SDK_CALLTYPE GetColor(
63  const SDKUInt32& clr_idx, SDKColorF& clr) const throw() = 0;
64 
66  virtual SDKUInt32 SDK_CALLTYPE GetMemSize() const throw() = 0;
67 
68  SDK_IMPLEMENT_IID(IGL2DPalette)
69  SDK_END_INTERFACE(IGL2DPalette)
70 };
71 SDK_DECLARE_IID(IGL2DPalette)
72 
73 SDK_GL2D_END_NAMESPACE
74 
75 #endif // SDK_GL2D_PALETTE_INTERFACE_H_
GL2DPaletteType
GL2DPaletteType
Available palette type.
Definition: gl2d_palette_interface.h:33
SDKColorF
A RGBA color.
Definition: color_base_types.h:15
IGL2DPalette::GetParent
virtual IGL2DCanvasSP SDK_CALLTYPE GetParent() const =0
Returns parent canvas object.
IGL2DPalette::GetMemSize
virtual SDKUInt32 SDK_CALLTYPE GetMemSize() const =0
Returns palette GL memory size.
base_types.h
SDK base types.
properties_interface.h
Object generic properties interface.
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
GL2DPalettePropertyIDs
GL2DPalettePropertyIDs
Generic GL2D Palette properties.
Definition: gl2d_palette_interface.h:27
platform.h
Describes the platform constants.
IGL2DPalette::GetColor
virtual SDKResult SDK_CALLTYPE GetColor(const SDKUInt32 &clr_idx, SDKColorF &clr) const =0
Returns appropriate color by it's index.
IGL2DPalette::Dump
virtual void SDK_CALLTYPE Dump() const =0
Dumps given object.
IGL2DCanvas
GL2D Canvas to use to drawing NOTE! Create/Draw functionality was moved to appropriate GL2D Canvas Fu...
Definition: gl2d_canvas_interface.h:435
IGL2DPalette::GetType
virtual GL2DPaletteType SDK_CALLTYPE GetType() const =0
Returns palette type.
IGL2DPalette::GetMaxColorIndex
SDKUInt32 SDK_CALLTYPE GetMaxColorIndex() const
Returns max color index.
Definition: gl2d_palette_interface.h:59
IGL2DPalette
GL2D Palette object.
Definition: gl2d_palette_interface.h:44
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
IGL2DPalette::GetColorsCount
virtual SDKUInt32 SDK_CALLTYPE GetColorsCount() const =0
Returns number of colors in palette.