sdl_interface.h

Go to the documentation of this file.

#ifndef SDL_INTERFACE_H_
#define SDL_INTERFACE_H_
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_string_handler.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/interfaces/stream/stream_interface.h>
#include <base/inc/interfaces/enum/enum_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <geometry/inc/geometry/geometry2d/2d_geometry_objects.h>
#include <geometry/inc/geometry/geometry2d/2d_geometry_path_interface.h>
#include <visualizationlayer/inc/graphics/2d_render_target_interface.h>
#include <visualizationlayer/inc/scene/texture_interface.h>
#include <visualizationlayer/inc/scene/graphic_context_interface.h>
#include <visualizationlayer/inc/portrayal/sdl/sdl.h>
 
namespace sdk {
namespace vis {
namespace sdl {
 
// Classes defined in this file
FWD_DECL_INTERFACE(IMatrix3X2Container);
FWD_DECL_INTERFACE(IDrawingContext);
FWD_DECL_INTERFACE(ILayoutInfo);
FWD_DECL_INTERFACE(ISymbolSetCatalogFactory);
FWD_DECL_INTERFACE(ISymbolSetCatalog);
FWD_DECL_INTERFACE(IPaletteManager);
FWD_DECL_INTERFACE(IPalette);
FWD_DECL_INTERFACE(ISymbolCollection);
FWD_DECL_INTERFACE(ISymbolizer);
FWD_DECL_INTERFACE(ISDLScript);
FWD_DECL_INTERFACE(IVisualObject);
FWD_DECL_INTERFACE(ILayoutMember);
FWD_DECL_INTERFACE(ILayoutMembersCollection);
 
typedef SDKUInt16 SDLResourceID; 
const SDKUInt16 k_SDL_InvalidID = 0; 
typedef SDKUInt32 SDLColorID; 
const SDLColorID k_SDL_InvalidColorID = 0; 
 
enum SymbolType {
  SymbolType_Unknown      = 0, 
  SymbolType_Icon         = 1, 
  SymbolType_Text         = 2, 
  SymbolType_Brush        = 3, 
  SymbolType_ComplexBrush = 4, 
  SymbolType_Pen          = 5, 
  SymbolType_ComplexPen   = 6, 
  SymbolType_MultiIcon    = 7, 
  SymbolType_MultiText    = 8, 
};
 
enum SymbolGeometryType {
  SymbolGeometryType_Unknown    = 0, 
  SymbolGeometryType_Point      = 1, 
  SymbolGeometryType_Linear     = 2, 
  SymbolGeometryType_Areal      = 3, 
  SymbolGeometryType_MultiPoint = 4, 
};
 
enum DrawingContextProperty {
  DrawingContextProperty_GeometryFactory = 0,
  DrawingContextPRoperty_ClippingPath,
  DrawingContextPRoperty_ClippingMatrix,   // IMatrixContainer (see below), clipping should be transformed before use (e.g. general/data-view cipping path is used with individually projected/positioned/centered data)
  DrawingContextPRoperty_ViewportOriginX,
  DrawingContextPRoperty_ViewportOriginY,
  DrawingContextPRoperty_ViewportWidth,
  DrawingContextPRoperty_ViewportHeight,
  DrawingContextPRoperty_X_Origin,
  DrawingContextPRoperty_Y_Origin,
  DrawingContextPRoperty_SceneRotationAngle,
  DrawingContextPRoperty_DoNotSkipSprites,
  DrawingContextPRoperty_TextAntiAliasing, // 2d_graphics_consts.h enum AntiAliasingMode
  DrawingContextPRoperty_GraphicContext,   // sdk::vis::scene::IGraphicContext
  DrawingContextPRoperty_NorthUp, 
  DrawingContextProperty_UnitsContext,     // Units context
  DrawingContextPRoperty_DoNotUseAlpha,    // do not use alpha (transparency) channel
};
 
enum DisplaySettingsEnum {
  kDisplay_Contrast = 0,
  kDisplay_Backlight,
  kDisplay_Brightness,
};
 
enum LayoutProperty {
  LayoutProperty_Anchor,
  LayoutProperty_X_offset,
  LayoutProperty_Y_offset,
};
 
enum SymbolSetCatalogProperty {
  kSymbolSetCatalogProperty_FontCacheOn,
};
 
class IMatrix3X2Container : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE IsIdentity() throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMatrixValues(
    float& _11, float& _12, float& _21, float& _22, float& _31, float& _32) throw() = 0;
 
  SDK_IMPLEMENT_IID(IMatrix3X2Container)
  SDK_END_INTERFACE(IMatrix3X2Container)
};
SDK_DECLARE_IID(IMatrix3X2Container)
 
class IDrawingContext : public ISDKProperties {
public:
  SDK_IMPLEMENT_IID(IDrawingContext)
  SDK_END_INTERFACE(IDrawingContext)
};
SDK_DECLARE_IID(IDrawingContext)
 
class ILayoutInfo : public ISDKProperties {
public:
  SDK_IMPLEMENT_IID(ILayoutInfo)
  SDK_END_INTERFACE(ILayoutInfo)
};
SDK_DECLARE_IID(ILayoutInfo)
 
class ISymbolSetCatalogFactory : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE CreateCatalog(
    ISymbolSetCatalogSP& new_catalog) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetCurrentCatalog(
    ISymbolSetCatalogSP& catalog) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE ReleaseCurrentCatalogIfLast() throw() = 0;
 
  SDK_IMPLEMENT_IID(ISymbolSetCatalogFactory)
  SDK_END_INTERFACE(ISymbolSetCatalogFactory)
};
SDK_DECLARE_IID(ISymbolSetCatalogFactory)
 
class ISymbolSetCatalog : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE RegisterSymbolSet(
    const SDKString& dir_path,
    const sdk::base::SDKStreamSP& in_xsdl, 
    SDKString& symbol_set_name) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Clear() throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetVersion(
    const SDKString& symbol_set_name, 
    SDKUInt16& ver_major, SDKUInt16& ver_minor) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolCollection(
    ISymbolCollectionSP& symbols) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetPaletteManager(
    IPaletteManagerSP& palette_manager) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolSetId(
    const SDKString& symbol_set_name,
    SDLResourceID& id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolGeometryType(
    const SDLResourceID id,
    SymbolGeometryType& geom_type) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolType(
    const SDLResourceID id,
    SymbolType& type) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetColorId(
    const SDLResourceID symbol_set_id,
    const SDKString& color_name, 
    SDLColorID& id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolId(
    const SDLResourceID symbol_set_id,
    const SDKString& symbol_name,
    SDLResourceID& id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolName(
    const SDLResourceID symbol_set_id,
    const SDLResourceID id,
    SDKString& symbol_name) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolParameterId(
    const SDLResourceID symbol_set_id,
    const SDLResourceID symbol_id,
    const SDKString& parameter_name,
    SDLResourceID& id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CreateScript(
    ISDLScriptSP& script) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RegisterSymbol(
    SDLResourceID& id,
    const SDKString& symbol_set_name,
    const SDKString& script_name,
    const sdk::base::SDKStreamSP& p_code) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbol(
    const SDLResourceID& symbol_id,
    sdk::base::SDKStreamSP& p_code) throw() = 0;
 
 
  virtual SDKResult SDK_CALLTYPE ParseCommand(
    const SDLResourceID symbol_set_id,
    const SDKString& command,
    SDLResourceID& id,
    sdk::base::SDKStreamSP& params_stream) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CreateSymbolizer(
    ISymbolizerSP& symbolizer) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetID(
    SDKUInt32& id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolInfo(
    const SDLResourceID symbol_set_id,
    const SDLResourceID id,
    SDKString& symbol_info) throw() = 0;
 
 
  virtual SDKResult SDK_CALLTYPE CreateScriptFromXSDL(
          SDLResourceID& id,
          const SDKString& symbol_set_name,
          const sdk::base::SDKStreamSP& xsdl) throw() = 0;
 
  SDK_IMPLEMENT_IID(ISymbolSetCatalog)
  SDK_END_INTERFACE(ISymbolSetCatalog)
};
SDK_DECLARE_IID(ISymbolSetCatalog)
 
class IPaletteManager : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE EnumPaletteNames(
    IEnumSDKStringSP& palette_names) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetPalette(
    const SDKString& palette_name,
    IPaletteSP& palette) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetColor(
    const SDKString& palette_name,
    const SDKString& symbol_set_name,
    const SDKString& color_name, 
    SDKUInt32& argb) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetColor(
    const SDKString& palette_name,
    const SDKString& symbol_set_name,
    const SDKString& color_name, 
    SDKUInt32 argb) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RegisterPalette(
    const SDKString& palette_name, 
    //float gamma, 
    SDLResourceID& id) throw() = 0;
 
 
  virtual SDKResult SDK_CALLTYPE GetDisplaySettingValue(
    const SDKString& symbol_set_name,
    const SDKString& palette_name,
    DisplaySettingsEnum value_id,
    SDKAny& value) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDisplaySettingValue(
    const SDKString& symbol_set_name,
    const SDKString& palette_name,
    DisplaySettingsEnum value_id,
    const SDKAny& value) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetColorProperty(
    const SDKString& symbol_set_name,
    const SDKString& color_name, 
    const SDKPropertyID& id, 
    SDKAny& value) throw() = 0;
 
  SDK_IMPLEMENT_IID(IPaletteManager)
  SDK_END_INTERFACE(IPaletteManager)
};
SDK_DECLARE_IID(IPaletteManager)
 
class IPalette : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE EnumColorNames(
    IEnumSDKStringSP& color_names) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetColor(
    const SDKString& color_name, 
    SDKUInt32& argb) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetColor(
    const SDKString& color_name, 
    SDKUInt32 argb) throw() = 0;
 
  SDK_IMPLEMENT_IID(IPalette)
  SDK_END_INTERFACE(IPalette)
};
SDK_DECLARE_IID(IPalette)
 
class ISymbolCollection : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE EnumSymbolParameterNames(
    const SDKString& symbol_set_name, 
    const SDKString& symbol_name, 
    EnumSDKStringSP& parameter_names) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE EnumSymbolNames(
    const SDKString* symbol_set_name,
    EnumSDKStringSP& symbol_set_names) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE EnumSymbolSetNames(
    EnumSDKStringSP& symbol_set_names) throw() = 0;
  
  SDK_IMPLEMENT_IID(ISymbolCollection)
  SDK_END_INTERFACE(ISymbolCollection)
};
SDK_DECLARE_IID(ISymbolCollection)
 
class ISymbolizer : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE CreateVisualObject(
    IVisualObjectSP& vo,
    SDKUInt16 symbol_id, 
    const sdk::gfx::RenderTargetSP& target,
    float symbol_scale,
    const sdk::base::SDKStreamSP& params) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CombineVisualObjects(
    IVisualObjectSP& parent_vo,
    IVisualObjectSP& child_vo,
    AnchorType anchor, 
    float x_offset, float y_offset) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE DrawVisualObject(
    const IVisualObjectSP& vo,
    const sdk::gfx::RenderTargetSP& target,
    const ISDKComponentSP& geometry,
    const SDKMatrix3X2& transformation_matrix,
    const IDrawingContextSP& context) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Interpret(
    const sdk::base::SDKStreamSP& p_code_stream,
    const sdk::gfx::RenderTargetSP& target,
    float symbol_scale,
    const sdk::base::SDKStreamSP& params,
    const ISDKComponentSP& geometry,
    const SDKMatrix3X2& transformation_matrix,
    const IDrawingContextSP& context) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetCurrentPalette(
    const SDKString& palette_name) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE DisplaySymbol(
    SDKUInt16 symbol_id, 
    const ISDKComponentSP& geometry,
    const sdk::gfx::RenderTargetSP& target,
    const SDKMatrix3X2& transformation_matrix,
    float scale,
    const sdk::base::SDKStreamSP& params) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolMetrics(
    SDKSizeF& size, 
    SDKPointF2D& origin, 
    SDKUInt16 symbol_id, 
    const sdk::gfx::RenderTargetSP& target,
    float scale,
    const sdk::base::SDKStreamSP& params) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CreateSprite(
    SDKUInt16 symbol_id, 
    sdk::vis::scene::ITextureSP& texture,
    SDKPointF2D& org,
    const sdk::vis::scene::IGraphicContextSP& scene_context,
    float scale,
    const sdk::base::SDKStreamSP& params) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CreateLayout(
    const IVisualObjectSP& vo,
    const float scale_factor,
    ILayoutMemberSP& layout_owner) throw() = 0;
 
  SDK_IMPLEMENT_IID(ISymbolizer)
  SDK_END_INTERFACE(ISymbolizer)
};
SDK_DECLARE_IID(ISymbolizer)
 
class ILayoutMember : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE Relayout(
    const sdk::gfx::RenderTargetSP& target) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMetrics(
    SDKSizeF& size, 
    SDKPointF2D& origin) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AttachMember(
    IVisualObjectSP& vo,
    AnchorType anchor, 
    float x_offset, float y_offset,
    ILayoutMemberSP& member) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetVisualObject(
    IVisualObjectSP& vo) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetLayoutInfo(
    ILayoutInfoSP& info) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetOwner(
    IVisualObjectSP& owner) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMembers(
    ILayoutMembersCollectionSP& members) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILayoutMember)
  SDK_END_INTERFACE(ILayoutMember)
};
SDK_DECLARE_IID(ILayoutMember)
 
class ILayoutMembersCollection : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE Count(SDKUInt32& count) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMember(
    SDKUInt32 index, 
    ILayoutMemberSP& memeber) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILayoutMembersCollection)
  SDK_END_INTERFACE(ILayoutMembersCollection)
}; 
SDK_DECLARE_IID(ILayoutMembersCollection)
 
 
} // namespace sdl
} // namespace vis
} // namespace sdk 
 
#endif // SDL_INTERFACE_H_