 |
NAVTOR SDK
v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
|
|
Go to the documentation of this file. 1 #ifndef SDL_SCRIPT_INTERFACE_H_
11 #define SDL_SCRIPT_INTERFACE_H_
88 bitmap_brush_node = 103
152 pattern_opacity_attr,
247 public sdk::ISDKComponent
272 ISDLElementSP& root_element)
throw() = 0;
290 ISDLElementSP& element)
throw() = 0;
299 ISDLElementSP& element)
throw() = 0;
307 ISDLParametersCollectionSP& parameters)
throw() = 0;
326 public sdk::ISDKComponent
341 ISDLElementSP& ancestor)
throw() = 0;
350 ISDLElementCollectionSP& descendants)
throw() = 0;
355 const SDKAny& value)
throw() = 0;
370 const SDKAny& value)
throw() = 0;
375 SDKAny& value)
const throw() = 0;
380 const SDKAny& value)
throw() = 0;
384 ISDLElementSP& child,
389 ISDLElementSP& child,
392 float x_offset,
float y_offset)
throw() = 0;
396 ISDLElementSP& child,
402 ISDLElementSP& child,
406 float x_offset,
float y_offset)
throw() = 0;
410 ISDLElementSP& child,
411 const SDKString& symbol_name,
416 ISDLElementSP& child,
417 const SDKString& symbol_name,
420 float x_offset,
float y_offset)
throw() = 0;
434 SDK_DECLARE_IID(ISDLElement)
436 class ISDLElementCollection :
439 public sdk::ISDKComponent
443 virtual SDKResult SDK_CALLTYPE
Count(SDKUInt32& count)
const throw() = 0;
448 ISDLElementSP& element)
throw() = 0;
450 SDK_IMPLEMENT_IID(ISDLElementCollection)
451 SDK_END_INTERFACE(ISDLElementCollection)
453 SDK_DECLARE_IID(ISDLElementCollection)
455 class ISDLParametersCollection :
458 public sdk::ISDKComponent
462 virtual SDKResult SDK_CALLTYPE
Count(SDKUInt32& count)
const throw() = 0;
466 const SDLResourceID
id,
467 const SDKAny& value)
throw() = 0;
471 const SDLResourceID
id,
476 const SDLResourceID
id,
481 const SDLResourceID
id,
482 float x,
float y)
throw() = 0;
486 const SDLResourceID
id,
487 float scale_x,
float scale_y)
throw() = 0;
491 const SDLResourceID
id,
492 float rotate)
throw() = 0;
496 const SDKString& symbol_name,
497 const SDKString& param_name,
498 const SDKAny& value)
throw() = 0;
504 SDKAny& value)
const throw() = 0;
508 const SDLResourceID
id,
509 const SDKAny& value)
throw() = 0;
519 SDK_IMPLEMENT_IID(ISDLParametersCollection)
520 SDK_END_INTERFACE(ISDLParametersCollection)
522 SDK_DECLARE_IID(ISDLParametersCollection)
527 #endif // SDL_SCRIPT_INTERFACE_H_
virtual SDKResult SDK_CALLTYPE AddScaleParameter(const SDLResourceID id, float scale_x, float scale_y)=0
Adds scale parameter.
@ units_attr
Units attribute.
Definition: sdl_script_interface.h:194
@ frame_change_color_attr
True (default) if frame changes color to the parent one.
Definition: sdl_script_interface.h:109
virtual SDKResult SDK_CALLTYPE Read(const sdk::base::SDKStreamSP &stream)=0
Reads...
@ import_node
Component node.
Definition: sdl_script_interface.h:86
@ miter_limit_attr
Miter limit attribute.
Definition: sdl_script_interface.h:171
@ skewY_node
SkewY node.
Definition: sdl_script_interface.h:45
@ pen_node
Pen node.
Definition: sdl_script_interface.h:76
@ translate_node
Translate node.
Definition: sdl_script_interface.h:41
virtual SDKResult SDK_CALLTYPE GetElement(SDKUInt32 index, ISDLElementSP &element)=0
Returns element.
@ raster_attr
Raster attribute.
Definition: sdl_script_interface.h:193
@ brush_node
Brush node.
Definition: sdl_script_interface.h:70
virtual SDKResult SDK_CALLTYPE GetSymbolType(SymbolType &type)=0
Returns the symbol type.
SymbolGeometryType
Defines the symbol geometry type.
Definition: sdl_interface.h:71
SymbolType
Defines the symbol type.
Definition: sdl_interface.h:57
SDL element.
Definition: sdl_script_interface.h:325
virtual SDKResult SDK_CALLTYPE Read(const sdk::base::SDKStreamSP &stream)=0
Reads...
@ file_type_attr
File type attribute.
Definition: sdl_script_interface.h:102
@ frame_list_attr
Frame list attribute.
Definition: sdl_script_interface.h:111
@ skewX_node
SkewX node.
Definition: sdl_script_interface.h:44
@ brush_pattern_attr
Brush pattern attribute.
Definition: sdl_script_interface.h:154
@ arc_node
Arc node.
Definition: sdl_script_interface.h:66
@ offset_attr
Offset attribute.
Definition: sdl_script_interface.h:133
@ symbol_node
Symbol node.
Definition: sdl_script_interface.h:32
@ geom_org_attr
geometry AABB origin
Definition: sdl_script_interface.h:209
@ start_layout_atr
start new layout
Definition: sdl_script_interface.h:212
virtual SDKResult SDK_CALLTYPE AddElement(ISDLElementSP &child, NodeType type)=0
Adds element.
virtual SDKResult SDK_CALLTYPE GetAttribute(AttributeType type, SDKAny &value) const =0
Returns attribute.
AttributeType
Attribute types.
Definition: sdl_script_interface.h:93
@ unknown_attr
Unknown attribute.
Definition: sdl_script_interface.h:94
virtual SDKResult SDK_CALLTYPE AddPointParameter(const SDLResourceID id, const SDKPointF2D &value)=0
Adds point parameter.
@ font_ref_attr
Font reference attribute.
Definition: sdl_script_interface.h:182
@ fill_rule_attr
Fill rule attribute.
Definition: sdl_script_interface.h:150
@ font_vert_align_attr
Font vertical allignment attribute.
Definition: sdl_script_interface.h:189
@ line_orient_attr
Line orientation attribute.
Definition: sdl_script_interface.h:174
Interfaces wrapper with reference count control.
SDKUInt16 SDLResourceID
Definition of the resource identifier type.
Definition: sdl_interface.h:49
@ dash_offset_attr
Dash offset attribute.
Definition: sdl_script_interface.h:119
@ place_attr
Place attribute.
Definition: sdl_script_interface.h:173
virtual SDKResult SDK_CALLTYPE AddTranslateParameter(const SDLResourceID id, float x, float y)=0
Adds translate parameter.
@ file_ref_node
File reference node.
Definition: sdl_script_interface.h:34
@ hatch_brush_node
Hatch brush node.
Definition: sdl_script_interface.h:72
virtual SDKResult SDK_CALLTYPE AddParameter(const SDLResourceID id, const SDKAny &value)=0
Adds parameter.
@ frame_ref_list_attr
Frame reference list attribute.
Definition: sdl_script_interface.h:112
virtual SDKResult SDK_CALLTYPE Compile(sdk::base::SDKStreamSP &p_code)=0
Compiles XSDL source to byte-code.
@ compound_pen_node
Compuond pen node.
Definition: sdl_script_interface.h:78
@ clip_attr
Clip attribute.
Definition: sdl_script_interface.h:155
virtual SDKResult SDK_CALLTYPE SetParameter(const SDLResourceID id, const SDKAny &value)=0
Sets parameter.
@ stride_attr
Stride attribute.
Definition: sdl_script_interface.h:164
@ symbol_info_attr
S52 symbol info.
Definition: sdl_script_interface.h:217
@ svg_end_
SVG end attribute.
Definition: sdl_script_interface.h:200
@ length_attr
Length attribute.
Definition: sdl_script_interface.h:162
@ comp_type_attr
Component (of complex pen or brush) attribute.
Definition: sdl_script_interface.h:163
@ use_bitmap_attr
boolean, use bitmap as brush
Definition: sdl_script_interface.h:219
@ effect_node
Effect node.
Definition: sdl_script_interface.h:37
@ gradient_brush_node
Gradient bruch node.
Definition: sdl_script_interface.h:73
@ rect_node
Rectangle node.
Definition: sdl_script_interface.h:64
@ symbol_ref_node
Symbol reference node.
Definition: sdl_script_interface.h:33
@ symbol_ref_attr
Symbol reference attribute.
Definition: sdl_script_interface.h:98
@ color_list_attr
Color list attribute.
Definition: sdl_script_interface.h:125
@ color_name_attr
S52 color table color row.
Definition: sdl_script_interface.h:215
@ skip_first_attr
Skip first attribute.
Definition: sdl_script_interface.h:178
@ fill_opacity_attr
Fill opacity attribute.
Definition: sdl_script_interface.h:151
@ frame_node
Frame node.
Definition: sdl_script_interface.h:36
virtual SDKResult SDK_CALLTYPE AddSizeParameter(const SDLResourceID id, const SDKSizeF &value)=0
Adds size parameter.
@ text_stream_attr
Text stream attribute.
Definition: sdl_script_interface.h:122
@ rotate_node
Rotate node.
Definition: sdl_script_interface.h:43
@ frame_type_attr
Frame type attribute.
Definition: sdl_script_interface.h:108
@ circle_node
Circle node.
Definition: sdl_script_interface.h:62
@ ref_name_attr
Reference name attribute.
Definition: sdl_script_interface.h:97
@ solid_brush_node
Solide brush node.
Definition: sdl_script_interface.h:71
@ aa_attr
anti-aliasing on\off
Definition: sdl_script_interface.h:210
@ name_attr
Name attribute.
Definition: sdl_script_interface.h:96
@ complex_pen_node
Complex pen node.
Definition: sdl_script_interface.h:80
@ color_use_attr
S52 color table use row.
Definition: sdl_script_interface.h:216
@ color_attr
Color attribute.
Definition: sdl_script_interface.h:124
@ end_cap_attr
End cap attribute.
Definition: sdl_script_interface.h:168
virtual SDKResult SDK_CALLTYPE AddSymbol(ISDLElementSP &child, SDLResourceID symbol_id, const sdk::base::SDKStreamSP ¶ms)=0
Adds symbol.
virtual SDKResult SDK_CALLTYPE Serialize(sdk::base::SDKStreamSP ¶m_stream)=0
Serializes.
virtual SDKResult SDK_CALLTYPE GetAncestor(ISDLElementSP &ancestor)=0
Returns the nearest ancestor element.
@ path_list_attr
list of file pathname
Definition: sdl_script_interface.h:222
@ matrix_node
Matrix node.
Definition: sdl_script_interface.h:40
virtual SDKResult SDK_CALLTYPE AddSymbolByName(ISDLElementSP &child, const SDKString &symbol_name, const sdk::base::SDKStreamSP ¶ms)=0
Adds symbol by name.
@ org_attr
Origin attribute.
Definition: sdl_script_interface.h:130
@ image_node
Image node.
Definition: sdl_script_interface.h:53
@ anchors_attr
Anchors attribute.
Definition: sdl_script_interface.h:104
@ geom_type_attr
Geometry type attribute.
Definition: sdl_script_interface.h:147
Wrappers and helper functions for SDKString.
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
@ geom_size_attr
geometry AABB size
Definition: sdl_script_interface.h:208
@ font_size_attr
Font size attribute.
Definition: sdl_script_interface.h:188
@ path_attr
Path attribute.
Definition: sdl_script_interface.h:101
@ parameters_stream_attr
parameters stream.
Definition: sdl_script_interface.h:205
@ drawing_node
Drawing node.
Definition: sdl_script_interface.h:52
@ closed_attr
Closed attribute.
Definition: sdl_script_interface.h:149
@ text_node
Text node.
Definition: sdl_script_interface.h:47
Generic data stream interface.
@ eng_rect_attr
Engineering rectangle attribute.
Definition: sdl_script_interface.h:128
virtual SDKResult SDK_CALLTYPE CreateRootElement(NodeType type, ISDLElementSP &element)=0
Creates SDL root element.
@ color_ref_list_attr
list of references to color list.
Definition: sdl_script_interface.h:206
A smart pointer class for managing SDK components interface pointers.
Definition: sdk_ref_ptr.h:23
@ width_attr
Width attribute.
Definition: sdl_script_interface.h:157
@ rotate_transf_attr
Rotate transformation attribute.
Definition: sdl_script_interface.h:137
@ base_dist_attr
Base distance attribute.
Definition: sdl_script_interface.h:118
@ angle_attr
Angle attribute.
Definition: sdl_script_interface.h:141
@ params_node
Parameters node.
Definition: sdl_script_interface.h:35
Common base SDK interfaces.
@ font_stretch_attr
Font stretch attribute.
Definition: sdl_script_interface.h:187
@ tangent_list_attr
list of tangents (float, in degrees), auxiliary attribute
Definition: sdl_script_interface.h:221
virtual SDKResult SDK_CALLTYPE AttachElement(ISDLElementSP &child, NodeType type, AnchorType anchor, float x_offset, float y_offset)=0
Attaches element.
Single 2D point.
Definition: geometry_base_types.h:33
@ radius_attr
Radius attribute.
Definition: sdl_script_interface.h:158
@ container_node
Container node.
Definition: sdl_script_interface.h:54
@ geometric_pen_node
Geometric pen node.
Definition: sdl_script_interface.h:77
@ line_join_attr
Line join attribute.
Definition: sdl_script_interface.h:170
@ shape_node
Shape node.
Definition: sdl_script_interface.h:55
@ anchor_attr
Anchor attribute.
Definition: sdl_script_interface.h:146
virtual SDKResult SDK_CALLTYPE Count(SDKUInt32 &count) const =0
Returns count.
@ multi_icon_node
Multi-icon node.
Definition: sdl_script_interface.h:57
@ start_angle_attr
Start angle attribute.
Definition: sdl_script_interface.h:142
@ pen_segment_node
Pen segment node.
Definition: sdl_script_interface.h:82
@ scale_transf_attr
Scale transformation attribute.
Definition: sdl_script_interface.h:135
@ chars_attr
Chars attribute.
Definition: sdl_script_interface.h:121
@ graphic_size_attr
using geometry for dimensions calculation
Definition: sdl_script_interface.h:211
@ horz_dist_attr
Horizontal distance attribute.
Definition: sdl_script_interface.h:116
@ start_cap_attr
Start cap attribute.
Definition: sdl_script_interface.h:167
@ scale_node
Scale node.
Definition: sdl_script_interface.h:42
virtual SDKResult SDK_CALLTYPE GetRootElement(ISDLElementSP &root_element)=0
Returns the root element.
virtual SDKResult SDK_CALLTYPE Write(sdk::base::SDKStreamSP &stream)=0
Writes...
@ complex_brush_node
Complex brush node.
Definition: sdl_script_interface.h:74
virtual SDKResult SDK_CALLTYPE AddAttribute(AttributeType type, const SDKAny &value)=0
Adds attribute...
virtual SDKResult SDK_CALLTYPE Count(SDKUInt32 &count) const =0
Returns count.
@ svg_start_
SVG start attribute.
Definition: sdl_script_interface.h:197
virtual SDKResult SDK_CALLTYPE Write(sdk::base::SDKStreamSP &stream)=0
Writes...
@ count_attr
Count attribute.
Definition: sdl_script_interface.h:165
NodeType
Node types.
Definition: sdl_script_interface.h:30
virtual SDKResult SDK_CALLTYPE AddParameter(SDLResourceID id, const SDKAny &value)=0
Adds parameter.
virtual SDKResult SDK_CALLTYPE GetParameter(SDKUInt32 index, SDLResourceID &id, SDKAny &value) const =0
Returns parameter.
@ offset_transf_attr
Offset transformation attribute.
Definition: sdl_script_interface.h:136
@ geometry_attr
Geometry attribute.
Definition: sdl_script_interface.h:148
@ pie_node
Pie node.
Definition: sdl_script_interface.h:67
@ end_angle_attr
End angle attribute.
Definition: sdl_script_interface.h:143
virtual SDKResult SDK_CALLTYPE CreateParameters(ISDLParametersCollectionSP ¶meters)=0
Creates an empty parameters collection.
virtual SDKResult SDK_CALLTYPE GetSymbolGeometryType(SymbolGeometryType &geom_type)=0
Returns the symbol geometry type.
@ transforms_node
Transformations node.
Definition: sdl_script_interface.h:39
virtual SDKResult SDK_CALLTYPE GetDescendants(ISDLElementCollectionSP &descendants)=0
Returns descendants of the element.
@ effect_kind_attr
Effect kind attribute.
Definition: sdl_script_interface.h:106
@ unknown_node
Unknown node.
Definition: sdl_script_interface.h:31
@ file_name_attr
File name attribute.
Definition: sdl_script_interface.h:100
@ svg_transform_attr
SVG d transform attribute.
Definition: sdl_script_interface.h:199
SDL script.
Definition: sdl_script_interface.h:246
virtual SDKResult SDK_CALLTYPE AddSizeAttribute(AttributeType type, const SDKSizeF &value)=0
Adds size attribute.
@ skip_last_attr
Skip last attribute.
Definition: sdl_script_interface.h:179
virtual SDKResult SDK_CALLTYPE AddPointAttribute(AttributeType type, const SDKPointF2D &value)=0
Adds point attribute.
@ height_attr
Height attribute.
Definition: sdl_script_interface.h:161
@ dash_array_attr
Dash array attribute.
Definition: sdl_script_interface.h:172
@ font_attr
Font attribute.
Definition: sdl_script_interface.h:181
Symbol Definition Language (SDL) interfaces.
@ icon_node
Icon node.
Definition: sdl_script_interface.h:51
@ vacuous_attr
Vacuous attribute.
Definition: sdl_script_interface.h:192
@ vert_dist_attr
Vertical distance attribute.
Definition: sdl_script_interface.h:117
virtual SDKResult SDK_CALLTYPE SetAttribute(AttributeType type, const SDKAny &value)=0
Sets attribute.
@ component_node
Component node.
Definition: sdl_script_interface.h:84
@ multi_text_node
Multi text node.
Definition: sdl_script_interface.h:49
virtual SDKResult SDK_CALLTYPE Type(NodeType &type) const =0
Type...
virtual SDKResult SDK_CALLTYPE AddParameterByName(const SDKString &symbol_name, const SDKString ¶m_name, const SDKAny &value)=0
Adds parameter by name.
virtual SDKResult SDK_CALLTYPE AttachSymbol(ISDLElementSP &child, SDLResourceID symbol_id, const sdk::base::SDKStreamSP ¶ms, AnchorType anchor, float x_offset, float y_offset)=0
Attaches symbol.
virtual SDKResult SDK_CALLTYPE AttachSymbolByName(ISDLElementSP &child, const SDKString &symbol_name, const sdk::base::SDKStreamSP ¶ms, AnchorType anchor, float x_offset, float y_offset)=0
Attaches symbol by name.
@ hatch_angle_attr
Hatch angle attribute.
Definition: sdl_script_interface.h:144
@ svg_d_geometry_attr
SVG d geometry attribute.
Definition: sdl_script_interface.h:198
Describes a basic enumeration interfaces.
virtual SDKResult SDK_CALLTYPE CreateElement(NodeType type, ISDLElementSP &element)=0
Creates SDL element.
AnchorType
Anchor type enumeration.
Definition: sdl.h:118
@ bitmap_attr
Matrix attribute.
Definition: sdl_script_interface.h:139
@ string_node
String node.
Definition: sdl_script_interface.h:48
@ index_list_attr
list of 3D indexes.
Definition: sdl_script_interface.h:203
@ segment_node
Segment node.
Definition: sdl_script_interface.h:61
@ size_eng_attr
Engineering size attribute.
Definition: sdl_script_interface.h:129
@ figure_node
Figure node.
Definition: sdl_script_interface.h:60
@ dist_attr
Distance attribute.
Definition: sdl_script_interface.h:114
@ line_align_attr
Line allignment attribute.
Definition: sdl_script_interface.h:175
@ font_weight_attr
Font weight attribute.
Definition: sdl_script_interface.h:186
AttributeType
Specifies an attribute type.
Definition: gdb_attribute.h:32
@ path_node
Path node.
Definition: sdl_script_interface.h:59
@ clip_radius_attr
Clip radius attribute.
Definition: sdl_script_interface.h:159
virtual SDKResult SDK_CALLTYPE Deserialize(const sdk::base::SDKStreamSP ¶m_stream)=0
Deserializes.
@ dash_cap_attr
Dash cap attribute.
Definition: sdl_script_interface.h:169
@ id_ref_attr
ID reference attribute.
Definition: sdl_script_interface.h:103
@ font_style_attr
Font style attribute.
Definition: sdl_script_interface.h:185
@ geometry_interface_attr
geometry interface.
Definition: sdl_script_interface.h:204
virtual SDKResult SDK_CALLTYPE AddRotateParameter(const SDLResourceID id, float rotate)=0
Adds rotate parameter.
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
@ vector_node
Vector node.
Definition: sdl_script_interface.h:68
@ size_attr
Size attribute.
Definition: sdl_script_interface.h:127
@ font_horz_align_attr
Font horizontal allignment attribute.
Definition: sdl_script_interface.h:190
@ matrix_attr
Matrix attribute.
Definition: sdl_script_interface.h:138
@ ellipse_node
Ellipse node.
Definition: sdl_script_interface.h:63
@ font_numeric_attr
Font numeric attribute.
Definition: sdl_script_interface.h:183
SizeF.
Definition: geometry_base_types.h:1111
@ point_attr
Point attribute.
Definition: sdl_script_interface.h:131