API Panel.LinkBar.SetBarGfx

From Flowcode Help
Jump to navigationJump to search

<sidebar>API Contents</sidebar> Sets the graphic for the main line of the bar

Class hierarchy

Panel

LinkBar
SetBarGfx

Parameters

HANDLE LinkBar

The handle to the bar to alter

ULONG Mode

The graphics mode to draw the bar with
Typical values for this parameter:
Name Description
Bar_None No bar is drawn between the start and end points
Bar_Line A line is drawn connecting the start and end
Bar_Cone A 3D cone is drawn connecting the start and end points
Bar_Cylinder A cylinder is drawn connecting the start and end points

ULONG RGBA

The red, green, blue value to colour the point with

FLOAT Width

The scale to use for 3D modes


Return value

This call does not return a value


Detailed description

This sets the graphics mode for the main line of the bar. The default for the bar is to draw a single pixel line (Bar_Line).


The Mode is the type of link to draw, and if a graphic is to be drawn this will be affected by Width, which is always assumed to be positive and its sign is ignored. The height of the bar is its length, which is auto-calculated.


The RGBA is a true-colour red, green, blue value. This is 255 (0xFF) for red, 0xFF00 for green and 0xFF0000 for blue.


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Panel.LinkBar.SetBarGfx(linkbar, ::Panel.LinkBar.Bar_None, rgba, width)

No additional examples