Difference between revisions of "API Panel.LinkBar.SetBarGfx"

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets the graphic for the main line of the bar
 
 
 
<div style="width:25%; float:right" class="toc">
 
====Class hierarchy====
 
[[API Panel|Panel]]
 
:[[API Panel.LinkBar|LinkBar]]
 
::[[API Panel.LinkBar|SetBarGfx]]
 
</div>
 
__TOC__
 
 
 
==Parameters==
 
[[Variable Types|HANDLE]] ''LinkBar''
 
:The handle to the bar to alter
 
 
 
[[Variable Types|ULONG]] ''Mode''
 
:The graphics mode to draw the bar with
 
:''Typical values for this parameter:''
 
::{| class="wikitable" width="65%"
 
 
|-
 
|-
! width="30%" |Name
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
! width="55%" |Description
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetBarGfx'''
 
|-
 
|-
|Bar_None
+
| colspan="2" | Sets the graphic for the main line of the bar&nbsp;
|No bar is drawn between the start and end points
 
 
|-
 
|-
|Bar_Line
 
|A line is drawn connecting the start and end
 
 
|-
 
|-
|Bar_Cone
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
|A 3D cone is drawn connecting the start and end points
+
| width="90%" | LinkBar
 
|-
 
|-
|Bar_Cylinder
+
| colspan="2" | The handle to the bar to alter&nbsp;
|A cylinder is drawn connecting the start and end points
+
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Mode
 +
|-
 +
| colspan="2" | The graphics mode to draw the bar with&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | RGBA
 +
|-
 +
| colspan="2" | The red, green, blue value to colour the point with&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Width
 +
|-
 +
| colspan="2" | The scale to use for 3D modes&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
 
[[Variable Types|ULONG]] ''RGBA''
 
:The red, green, blue value to colour the point with
 
 
[[Variable Types|FLOAT]] ''Width''
 
:The scale to use for 3D modes
 
 
 
==Return value==
 
''This call does not return a value''
 
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png SetBarGfx
Sets the graphic for the main line of the bar 
Fc9-h32-icon.png - HANDLE LinkBar
The handle to the bar to alter 
Fc9-u32-icon.png - ULONG Mode
The graphics mode to draw the bar with 
Fc9-u32-icon.png - ULONG RGBA
The red, green, blue value to colour the point with 
Fc9-f32-icon.png - FLOAT Width
The scale to use for 3D modes 
Fc9-void-icon.png - NONE Return


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