SightLine Applications Command, Control, and Script API  v3.6
List of all members
SLADrawOverlay_t Struct Reference
Overlays

Description

Draw user specified overlay graphics on the screen.

typedef struct {
u8 cameraIndex;
u8 objId;
u8 action;
u8 propertyFlags;
u8 type;
u16 a;
u16 b;
u16 c;
u16 d;
u8 backgroundColor;
SVPLenString_t text;
u16 e;
} SLADrawOverlay_t;

NOTE: This replaces SLADrawObject_t

NOTE: For 3000 Picture in Picture, graphic objects are not drawn to the PIP window.
NOTE: To get all the object ids of current drawn objects use SLAGetParameters_t(DrawObject) with an object id of 0. To get the current object information use SLAGetParameters_t(DrawOverlay).
NOTE: Applied to the Command Camera or the camera index specified.
See Draw Order for additional drawing details.

Object Types

Value Description
0 Circle
1 Rectangle
2 Line
3 Reserved
4 Filled Circle
5 Filled Rectangle
6 Text Extended
7 Reserved
8 KLV Field
9 Cross
10 Square
11 Filled Square
12 to 254 Reserved
255 Error or Object Not Found

Object Type Specific Parameters

Object Type a b c d e
Circle Center X Center Y Radius – Line Thickness
Filled Circle Center X Center Y Radius – Line Thickness
Rectangle Upper left corner X Upper left corner Y Width Height Line Thickness
Filled rectangle Upper left corner X Upper left corner Y Width Height Line Thickness
Line End point 1 X End point 1 Y End point 2 X End point 2 Y Line Thickness
Text Extended Upper left X Upper left Y H Scaling | V Scaling Font ID | Spacing –
KLV Field Upper left X Upper left Y Scaling, Font Field, Format –
Cross Center X Center Y Width — Line Thickness
Square Center X Center Y Width/Height Angle Line Thickness
Filled Square Center X Center Y Width/Height Angle Line Thickness

H/V Scaling

Horizontal/Vertical scale shifted left 5 (e.g. 32 means no scaling (= 100%). 0 is also interpreted as no scaling). Ignored by 1500/3000 for font ID 5 (Arial) .. 10 (Calibri Bold).
Using a scale other than 100% may result in blurred/smeared text drawing.

Spacing

Pixels between a character to the next character. If 0, then uses the font's default spacing. For font ID 0 .. 10, this specifies the width of drawn fonts. For UserFont0..UserFont15, this specifies the extra space (padding) between fonts. Not used for font ID 5 .. 10 on 1500/3000.

Line Thickness (ignored on 1500/3000) (New 3.4)

Thickness of line strokes in pixels. 0 is same as 1.

Text Extended Object Type

Parameter Bits Description
c 0-7 Horizontal scaling is value of (Bits 0-7)/32, 0 = no scaling, not used for font ID 5..10 on 1500/3000
c 8-15 Vertical scaling is value of (Bits 8-15)/32, 0 = no scaling, not used for font ID 5..10 on 1500/3000
d 0-4 Font ID 0 = Courier, 1 = Courier bold, 5 = Arial, 6 = Arial Bold, 7 = Verdana, 8 = Verdana Bold, 9 = Calibri, 10 = Calibri Bold
(17XX/4000 only) 16..31 = UserFont0..UserFont15 – SightLine provides default user fonts but any of them can be replaced by SLAUserFont_t. New 3.4
d 5 Enable fixed width – applicable to fonts with ID 5 .. 10, draw fonts with a predefined fixed width.
d 6 Enable outline effect – applicable when background color set to transparent
d 7 Enable shadow effect – applicable when background color set to transparent
d 8-15 Pixels between a font to the next font; 0 = font default spacing
e 0-15 Ignored, must be 0

KLV Field Object Type

Parameter Bits Description
c 0-7 Horizontal and Vertical scaling is value of (Bits 0-7)/32, 0 = no scaling, not used for font ID 5..10 on 1500/3000
c 8-12 Font ID 0 = Courier, 1 = Courier bold, 5 = Arial, 6 = Arial Bold, 7 = Verdana, 8 = Verdana Bold, 9 = Calibri, 10 = Calibri Bold
(17XX/4000 only) 16..31 = UserFont0..UserFont15 – SightLine provides default user fonts but any of them can be replaced by SLAUserFont_t. New 3.4
c 13 Enable fixed width – applicable to fonts with ID 5 .. 10, draw fonts with a predefined fixed width.
c 14 Enable outline effect – applicable when background color set to transparent
c 15 Enable shadow effect – applicable when background color set to transparent
d 0-7 KLV Field
d 8-15 KLV Format
e 0-15 Ignored, must be 0

KLV Field Options

Value Field Name KLV Format
0 UTC Time Time
1 Mission ID N/A (Send 0)
2 Platform Heading Angle
3 Platform Pitch Angle
4 Platform Roll Angle
7 Sensor Latitude Position
8 Sensor Longitude Position
9 Sensor Altitude Distance
10 Sensor HFOV Angle
11 Sensor VFOV Angle
12 Sensor Relative Azimuth Angle Angle
13 Sensor Relative Elevation Angle Angle
14 Sensor Relative Roll Angle Angle
15 Frame Center Latitude Position
16 Frame Center Longitude Position
17 Frame Center Elevation Distance
19 Slant Range Distance
20 Target Location ElevationDistance
21 Target Location Latitude Position
22 Target Location Longitude Position

KLV Format Types

Type Values
Time 0 = YYYY-MM-DD hh:mm:ss, 1 = DDMonthYYYY, 2 = HH:MM:SS, 3 = Month DD YYYY, 4 = MM/DD/YY, 5 = MM/DD/YYYY, 6 = DD HHMMZ MON YY (DTG), 7 = DDHHMMZMONYY (DTG - No Spaces)
Angle 0 = Degrees, 1 = Radians, 2 = Milliradians
Distance 0 = Meters, 1 = Feet
Position 0 = MGRS-10 (1 Meter), 1 = Decimal Degrees, 2 = Degrees Minutes Seconds, 3 = MGRS-8 (10 Meter)

Color To Number Mapping

Value Color Value Color
0 White 8 Light Green
1 Black 9 Green
2 Light Gray 10 Dark Green
3 Gray 11 Red
4 Dark Gray 12 Orange
5 Light Blue 13 Yellow
6 Blue 14 Transparent
7 Dark Blue 15 Automatic

Automatic Color on 17XX/4000

Using automatic-color is not recommended on 17XX/4000 and future systems. It may be deprecated in the future on 17XX/4000. Due to the implementation of graphics drawing, using automatic-color may slow down processing speed.
Automatic color on 1500/3000 will continue to work.
NOTE: If automatic color is specified for a User Font (UserFont0 .. UserFont15), then it is ignored and treated as Transparent.


Message ID 0x9C

Byte Offset Name Description
4cameraIndexCamera Index
5objIdUnique object ID - Maximum number of unique objects is 128
ID Description
0 Used for destroying all objects when Action==Destroy
1 - 199 Unique ID for each object created
200 - 255 Reserved
6action
BitsDescription
00Destroy specified object ID
1Create new object with specified object ID
1-2Reserved
3-7Transparency for filled circle, filled rectangle, and filled square. 0 = No transparency ... 31 = fully transparent. New 3.0
7propertyFlags
BitsDescription
0 - 31Coordinates are specified in source coordinate space and object is drawn at the specified location in the source image
2Coordinates are specified in display coordinate space and object is moved along with scene motion – equivalent to scene mode tracking with a custom overlay
4Static overlays that do not move (such as text), coordinates are specified in display coordinate space (default)
otherReserved
4 - 5Reserved
60 – don't save this object, 1 – save this object (only valid if action is set to create). New 2.24
70 – coordinate origin (0,0) is at the center of the image, 1 – coordinate origin is at the upper left corner of the image
8typeObject Types
9-10aObject Type Specific Parameters
11-12bObject Type Specific Parameters
13-14cObject Type Specific Parameters
15-16dObject Type Specific Parameters
17backgroundColorObject Color
BitsDescription
0-3Background color: for vertical and horizontal lines, the background color is drawn as a shadow; use transparent (14) to disable drawing of shadow
4-7Foreground color: for filled objects "Automatic" will result in object being filled with a partially transparent middle gray value which can be used as a background for drawing text to ensure the text is always visible. For non filled objects it will be either white or black depending on the scene content.
Note: See action byte for setting transparency level for filled objects.
Note: Transparent is not supported for text foreground
Note: Using the same foreground and background color for text including automatic will result in unreadable text.
18 text.len string length
19-...text.str Text and KLV objects only: text string (64 characters max)
For KLV objects use "%s" for time, mission ID, latitude, and longitudes and "%f" for all others.
Example "Time: %s"
Example "Slant Range: %05.0f (ft)"
Example "HFOV: %2.1f (deg)"
Example "Sensor Position: %s"

Character Encoding: Depending on the font type, different character encodings are used:
- Courier(default), Courier bold: ASCII (7bit, 0x20..0x7F)
- Arial..Calibri Bold: ISO 8859-1 (8bit, 0x20..0xff, ASCII + additional characters such as European characters)
- UserFont0..UserFont15: UTF-8
variese(Optional) Object Type Specific Parameters (2bytes) New 3.4

Firmware Version: 3.6 SightLine Applications Inc.