drawIcon3D

0.50

LELocal

Hover & click on the images for description

Description

Description:

Draws an icon at the given position in the game world. This command has to be executed every frame. Use the Draw3D Mission Event Handler (which is executed every frame if the user can see the icon).
In order for the results of this command to be visible through a custom camera, enable HUD with cameraEffectEnableHUD.
showHUD false will hide the icon drawn by this command.
In order for arrows to appear, the icon texture should exist. The arrow size is proportionate to the icon size.

ⓘ

• To avoid flickering and ensure visual fidelity, always use the visual (render time scope) variant of position commands, such as getPosASLVisual.
• The width and height parameters are multipliers for activeWidth and activeHeight set in config. So for example, if one needs to create an icon half the screen wide (safeZoneW / 2) and half the screen tall (safeZoneH / 2), divide these by the according config values:
  private _iconWidth = (safeZoneW / 2) / getNumber (configFile >> "CfgInGameUI" >> "Cursor" >> "activeWidth"); private _iconHeight = (safeZoneH / 2) / getNumber (configFile >> "CfgInGameUI" >> "Cursor" >> "activeHeight");

Groups:

Interaction

Syntax

Syntax:

drawIcon3D [texture, color, position, width, height, angle, text, shadow, textSize, font, textAlign, drawSideArrows, offsetX, offsetY]

Parameters:

texture: String - icon texture

color:

• Array format Color (RGBA) - icon color
• 2.04 Array of two Arrays format Color (RGBA) - Icon and text color

position: Array format PositionAGL - icon position

width: Number - icon width

height: Number - icon height

angle: Number - icon rotation angle

text: String - (Optional, default "") text label to display next to the icon

shadow: (Optional, default 0)

• Number:
  • 0: no shadow
  • 1: shadow (not used in this context, used in UI context)
  • 2: outline
• Boolean:
  • true - outline
  • false - no shadow

textSize: Number - (Optional, default size of system) text size

font: String - (Optional, default "RobotoCondensedBold") font class name from CfgFontFamilies (see FXY File Format - Available Fonts)

textAlign: String - (Optional, default "center") text alignment, can be one of:

• "left" - aligns the end of text line with the given position (text appears to the left of the position)
• "right" - aligns the beginning of text line with the given position (text appears to the right of the position)
• "center" - aligns the middle of text line with the given position (text appears central to the position)

drawSideArrows: Boolean - (Optional, default false) true to draw arrows and the text label at edge of screen when the icon moves off the screen

since 2.04

offsetX: Number - (Optional, default 0) X offset for the icon text

since 2.04

offsetY: Number - (Optional, default 0) Y offset for the icon text

Return Value:

Nothing

2.22

Alternative Syntax

Syntax:

drawIcon3D icon

Parameters:

icon: HashMap - hashmap structure in the following case-sensitive, @-prefixed format:

• @position: Array - the only mandatory parameter, can be one of the following formats:
  • [x, y, (z:0)] - Position2D or PositionAGL
  • [object, offsetZ]
    • object: Object
    • offsetZ: Number vertical offset
  • [object, selection, offsetZ, lodIndex]
    • object: Object
    • selection: String - model selection, see animationNames, selectionNames
    • offsetZ: Number - (Optional, default 0) vertical offset
    • lodIndex: Number - (Optional, default Memory LOD index, see allLODs)
• @texture: String - (Optional, default "") icon image
• @size: Number - (Optional) texture sizeH, the sizeW is automatic, based on original texture dimensions (To find texture width use getTextureInfo)
• @font: String - (Optional) global font name. Default current system font.
• @color: Color - (Optional, default White) icon color
• @arrowColor: Color - (Optional, default @color) arrow color
• @shadow: Boolean - (Optional, default false) true to outline, false no shadow
• @fade: Array - (Optional, default [-1, -1]) in format [distMin, distMax] start and end distance of icon fade
• @dynamic: Boolean - (Optional, default false) true to change icon size dynamically with percieved view distance false static size
• @drawArrows: Boolean - (Optional, default false) true to draw side out of view arrows and text for static icons only. Always false if @dynamic true
• @offsetX: Number - (Optional, default 0) x offset in screen units. > 0 offset right, < 0 offset left (always 0 if @drawArrows true)
• @offsetY: Number - (Optional, default 0) y offset in screen units. > 0 offset down, < 0 offset up (always 0 if @drawArrows true)
• @hardAlpha: Number - (Optional, default -1) 0..1 global alpha override for entire icon
• @checkVisibility: Boolean - (Optional, default false) true the icon will be obstructed by objects, smoke and vegetation
• @arrowText: Array - (Optional, default []) text to draw next to side arrows for static icons only in format [text, size, offsetXCoef, offsetYCoef, color, shadow]:
  • text: String - text to show next to arrow
  • size: Number - (Optional, default current system font size) text height in screen units (To find text width use getTextWidth)
  • offsetXCoef: Number - (Optional, default 1) X-spacing coefficient between arrows and text
  • offsetYCoef: Number - (Optional, default 1) Y-spacing coefficient between arrows and text
  • color: Color (Optional, default White) text color
  • shadow: Boolean (Optional, default false) true to outline, false no shadow
• @texts: Array of Arrays - (Optional, default []) multiple visible texts in format [[text, size, offsetX, offsetY, color, shadow], ...]:
  • text: String - text to show
  • size: Number - (Optional, default current system font size) text height in screen units (To find text width use getTextWidth)
  • offsetX: Number - (Optional, default 0) x offset in screen units. > 0 offset right, < 0 offset left
  • offsetY: Number - (Optional, default 0) y offset in screen units. > 0 offset down, < 0 offset up
  • color: Color (Optional, default White) text color
  • shadow: Boolean (Optional, default false) true to outline, false no shadow
• @progress: Array - (Optional, default []) progress bar in format [width, height, offsetX, offsetY, colorFG, colorBG]:
  • width: Number - width of the progress bar in screen units (width < height - vertical bar)
  • height: Number - height of the progress bar in screen units (height <= width - horizontal bar)
  • offsetX: Number - (Optional, default 0) x offset
  • offsetY: Number - (Optional, default 0) y offset
  • colorFG: Color - (Optional, default White) forground color
  • colorBG: Color - (Optional, default Grey) background color
• @progressValue: Number - (Optional, default -1) progress bar progress in 0...1 range. -1 - progress bar is not drawn

Return Value:

Nothing

Examples

Example 1:

Icon and text:

addMissionEventHandler ["Draw3D", { drawIcon3D ["targetIcon.paa", [1, 1, 1, 1], ASLToAGL getPosASLVisual cursorTarget, 1, 1, 45, "Target", 1, 0.05, "TahomaB"]; }];

Example 2:

Just text:

addMissionEventHandler ["Draw3D", { drawIcon3D ["", [1, 0, 0, 1], ASLToAGL getPosASLVisual cursorTarget, 0, 0, 0, "Target", 1, 0.05, "PuristaMedium"]; }];

Example 3:

iconPos = player getPos [10, 0] vectorAdd [0,0,2]; addMissionEventHandler ["draw3D", { drawIcon3D [ "\a3\ui_f\data\IGUI\Cfg\Radar\radar_ca.paa", [0, 0, 1, 1], iconPos, 5, 5, getDirVisual player, "COMPASS", 0, 0.3, "PuristaMedium", "center", true ]; }];

Example 4:

Since 2.04

pos = player getPos [10, 0] vectorAdd [0,0,2]; addMissionEventHandler ["draw3D", { _k = 10 / (player distance pos); drawIcon3D [ "\a3\ui_f\data\IGUI\Cfg\Radar\radar_ca.paa", [1, 0, 0, 1], pos, 1 * _k, 1 * _k, 0, name player, 0, 0.04 * _k, "RobotoCondensed", "right", true, 0.005 * _k, -0.035 * _k ]; }];

Example 5:

Since 2.22

removeAllMissionEventHandlers "Draw3D"; deleteVehicle flagA; flagA = createVehicle ["Flag_AAF_F", position player, [], 0, "NONE"]; icon = createHashMapFromArray [ ["@position", [flagA, 5]], ["@texture", "\A3\Data_F\Flags\Flag_AAF_CO.paa"], ["@texts", [["Sector Alpha", 0.025, 0, 0.05, [1,1,0,1]]]], ["@size", 0.05], ["@drawArrows", true], ["@arrowText", ["A", 0.1, 0.3, 0.3, [1,1,0,1]]], ["@fade", [10, 100]], ["@arrowColor", [0,1,0,1]], ["@progress", [0.005, 0.05, -0.01, 0, [0.8,0.8,0,1], [0,0.6,0,0.6]]], ["@progressValue", 0.67] ]; addMissionEventHandler ["Draw3D", {drawIcon3D icon}];

Additional Information

See also:

drawLine3D getMissionPath showHUD cameraEffectEnableHUD

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Killzone_Kid - c

Posted on Aug 31, 2013 - 09:51 (UTC)

As command syntax indicates, this command expects icon position in format PositionAGL meaning that over the land it expects PositionATL and over the sea PositionASLW.
This command works well with addon textures, however getting it to display mission textures is a bit tricky. Follow this guide.

AgentRev - c

Posted on Apr 19, 2014 - 22:35 (UTC)

You should rely exclusively on modelToWorldVisual for a moving object's icon position if you want it to accurately stay at the correct height over the sea. It computes faster than ASLToAGL.
Width, height, and textSize are proportional to the user's interface size, which can optionally be compensated against via size / (getResolution select 5)
Additionally, width and height are inversely proportional to the fovLeft and fovTop parameters from the user's ArmaProfile, and AFAIK those parameters are not retrievable via scripting. For example, a fovTop higher than the default value of 0.75 will make all 3D icons smaller vertically. I'm not sure if this is a bug or by design, however it is definitely annoying to take into account.

DreadedEntity - c

Posted on Oct 23, 2014 - 02:42 (UTC)

Show text

drawIcon3D and BIS_fnc_addStackedEventHandler work well together.
Using formatting commands with drawIcon3D will not work, instead, they will be added to the string.

["uniqueID", "onEachFrame", { drawIcon3D ["myIcon.jpg", [1,1,1,0.5], getPos player, 1, 1, 0, format ["%1\n%2", "Dreaded", "Entity"]]; }] call BIS_fnc_addStackedEventHandler;

Shown text will be Dreaded\nEntity. (A3 1.32.127785)

The "text" parameter must be a string. You cannot use Structured_Text.

["uniqueID", "onEachFrame", { drawIcon3D [ "myIcon.jpg", [1,1,1,0.5], getPos player, 1, 1, 0, parseText format ["<t size='1.25' font='PuristaLight' color='#ff0000'>%1%2</t>", Dreaded, Entity] ]; }] call BIS_fnc_addStackedEventHandler;

(A3 1.32.127785)

🕖

This information is obsolete.

PierreMGI - c

Posted on Mar 22, 2016 - 20:38 (UTC)

If you want to use this command, on each frame, with plenty of objects or entities to mark, you can manage conditions in order to reduce the number of CPU operations. One of the most demanding CPU resource is probably a DrawIcon3D treatment for these objects/entities because even if not displayed (like for objects behind player), the CPU calculates the icons in the defined radius of your nearEntities / nearestObjects command. Don't stay with a simple radius condition (disk selecting entities or nearestObjects) which calculates all, then useless (not displayed), icons! Here is a way to restrict this command to your screen display: in a onEachFramed context:

unitsToDisplay = allUnits; addMissionEventHandler ["EachFrame", { private _offset = [0,0,0]; { private _screenPosition = worldToScreen (_x modelToWorldVisual _offset); if (_screenPosition isEqualTo []) then { continue }; // < your drawIcon3D treatment here > } foreach unitsToDisplay }];

Tested with +100 units, equally spread on a disk. (Note: FPS depend also on environment in map. Choose a "desert" for that).