gl2d_line_interface.h

Go to the documentation of this file.

#ifndef SDK_GL2D_LINE_INTERFACE_H_
#define SDK_GL2D_LINE_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_base.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <visualizationlayer/inc/vis_const.h>
 
SDK_GL2D_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IGL2DCanvas);
FWD_DECL_INTERFACE(IGL2DLine);
 
enum GL2DLinePropertyIDs
{
  // In case line supports Miter Join style, given parameter defines 
  // miter limit to use
  kGL2DLinePropertyID_MiterLimit = 0, // kSDKAnyType_Float
 
  // In case line has pattern (dash/texture), smooth angle criteria
  // can be specified, in case line joins angle is less than defined
  // value, pattern will be used instead of any specific connection lines
  // In degrees, 0 - 180
  kGL2DLinePropertyID_SmoothAngle = 1, // kSDKAnyType_Float
 
  // Round angle for textured lines
  // In case join angle between two line segments <= given angle - 
  // round join will be used, if join angle > given angle - butt join will be used
  // In degrees, 0 - 180
  kGL2DLinePropertyID_RoundAngle  = 2, // kSDKAnyType_Float
};
 
enum GL2DLineType
{
  // Unknown line type
  kGL2DLineType_Unknown                                  = 0, 
 
  // Simple solid only line, mostly for debugging purposes, 
  // uses native OpenGL GL_LINE_STRIP primitive
  kGL2DLineType_Simple                                   = 1, 
 
  // Solid line without caps/join styles, but with anti-aliasing and
  // very fast GPU based drawing algorithm, thick lines are ugly,
  // but hair lines are pretty good
  // Based on https://www.mapbox.com/blog/drawing-antialiased-lines/
  kGL2DLineType_Fast_Solid                               = 2,
 
  // Same as kGL2DLineType_Fast_Solid, but can be
  // projected via any perspective projection during rendering
  kGL2DLineType_Fast_Solid_ForPerspProj                  = 3,
 
  // Same as kGL2DLineType_Fast_Solid, but in addition line vertex data contains
  // information about color and width. Width and color, specified for
  // IGL2DCanvas::DrawLine will be ignored, data from line will be used instead
  kGL2DLineType_Fast_Solid_ColoredWithWidth              = 4,
 
  // Same as kGL2DLineType_Fast_Solid_ColoredWithWidth, but can be
  // projected via any perspective projection during rendering
  kGL2DLineType_Fast_Solid_ColoredWithWidth_ForPerspProj = 5,
 
  // Dash line without caps/join styles, but with anti-aliasing and
  // very fast GPU based drawing algorithm, thick lines are ugly,
  // but hair lines are pretty good
  // Based on https://www.mapbox.com/blog/drawing-antialiased-lines/
  kGL2DLineType_Fast_Dash                                = 6,
 
  // Same as kGL2DLineType_Fast_Dash, but in addition line vertex data contains
  // information about color/width/dash pattern. Width and color, specified for
  // IGL2DCanvas::DrawLine will be ignored, data from line will be used instead
  kGL2DLineType_Fast_Dash_ColoredWithWidthAndDash        = 7,
 
  // Solid line, supports caps/join styles, anti-aliasing,
  // gives better quality but performance reduced
  // Based on http://jcgt.org/published/0002/02/08/paper.pdf
  kGL2DLineType_Rougier_Solid                            = 8, 
 
  // Same as kGL2DLineType_Rougier_Solid, but in addition line vertex data contains
  // information about color/width/caps style for each of sublines in 
  // given multiline. Width and color, specified for IGL2DCanvas::DrawLine 
  // will be ignored, data from multiline will be used instead
  kGL2DLineType_Rougier_Solid_MultiLine                  = 9,
 
  // Dash line, supports caps/join styles, anti-aliasing.
  // Based on http://jcgt.org/published/0002/02/08/paper.pdf
  kGL2DLineType_Rougier_Dash                             = 10,
 
  // Same as kGL2DLineType_Rougier_Dash, but in addition line vertex data contains
  // information about color/width/caps style for each of sublines in 
  // given multiline. Width and color, specified for IGL2DCanvas::DrawLine 
  // will be ignored, data from multiline will be used instead
  kGL2DLineType_Rougier_Dash_MultiLine                   = 11,
 
  // Textured line, mostly for S-52 elements presentation (complex lines), 
  // no width/color/caps/join styles, only textures along the line
  kGL2DLineType_Textured                                 = 12,
 
  // Solid line with geometry based on pivot point, means line length is always
  // same, even if scaling matrix is applied.
  // Depending of parameters, each multiline vertex can have information
  // about colors and widths, in case they are different for each of lines
  // in given multiline
  // Drawing algorithm mostly based on Fast Solid line, means given line does
  // not supports caps/join styles, but with anti-aliasing and
  // very fast GPU based drawing algorithm, thick lines are ugly,
  // but hair lines are pretty good
  kGL2DLineType_Thin_Solid_PivotPoint_MultiLine          = 13,
 
  // Scalebar - vertical fast solid line, each of segments colored with color
  // 1 or color 2
  kGL2DLineType_Scalebar                                 = 14, 
};
 
enum GL2DLineCapStyle
{
  // Unknown line cap style
  kGL2DLineCapStyle_Unknown = 0,
 
  // Default line cap style
  kGL2DLineCapStyle_Default = 1,
 
  // Butt line cap style
  // Empty cap, line/dash is not extended, no additional cap will be drawn
  // Each dash will start/end at same position, no matter which line width 
  // is specified
  kGL2DLineCapStyle_Butt    = 2, 
 
  // Square line cap style
  // Line/dash is extended by (Line Width / 2.0f) in start/end direction
  kGL2DLineCapStyle_Square  = 3,
 
  // Square line cap style
  // Line/dash is extended by half of circle with radius (Line Width / 2.0f) 
  // in start/end direction
  kGL2DLineCapStyle_Round   = 4,
};
 
enum GL2DLineJoinStyle
{
  kGL2DLineJoinStyle_Unknown = 0, // Unknown line join style
  kGL2DLineJoinStyle_Default = 1, // Default line join style
  kGL2DLineJoinStyle_None    = 2, // None line join style
  kGL2DLineJoinStyle_Miter   = 3, // Miter line join style
  kGL2DLineJoinStyle_Bevel   = 4, // Bevel line join style
  kGL2DLineJoinStyle_Round   = 5, // Round line join style
};
 
class IGL2DLine : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetParent() const throw() = 0;
 
  virtual GL2DLineType SDK_CALLTYPE GetType() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetVertexCount() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetMemSize() const throw() = 0;
 
  virtual float SDK_CALLTYPE GetAntiAliasingWidth() const throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetAntiAliasingWidth(
    const float& aa_width) throw() = 0;
 
  virtual GL2DLineCapStyle SDK_CALLTYPE GetStartCapStyle() const throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetStartCapStyle(
    const GL2DLineCapStyle& style) throw() = 0;
 
  virtual GL2DLineCapStyle SDK_CALLTYPE GetEndCapStyle() const throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetEndCapStyle(
    const GL2DLineCapStyle& style) throw() = 0;
 
  virtual GL2DLineJoinStyle SDK_CALLTYPE GetJoinStyle() const throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetJoinStyle(
    const GL2DLineJoinStyle& style) throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DLine)
  SDK_END_INTERFACE(IGL2DLine)
};
SDK_DECLARE_IID(IGL2DLine)
 
SDK_GL2D_END_NAMESPACE
 
#endif // SDK_GL2D_LINE_INTERFACE_H_