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

From Flowcode Help
Jump to navigationJump to search
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
<sidebar>API contents</sidebar>
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
Sets the graphic for the start point of the bar
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetStartGfx'''
 
+
|-
<div style="width:25%; float:right" class="toc">
+
| colspan="2" | Sets the graphic for the start point of the bar&nbsp;
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
|-
:[[API Panel.LinkBar|LinkBar]]
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
::[[API Panel.LinkBar|SetStartGfx]]
+
| width="90%" | LinkBar
</div>
+
|-
__TOC__
+
| colspan="2" | The handle to the bar to alter&nbsp;
 
+
|-
==Parameters==
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
[[Variable Types|HANDLE]] ''LinkBar''
+
| width="90%" | Mode
:The handle to the bar to alter
 
 
 
[[Variable Types|ULONG]] ''Mode''
 
:The graphics mode to draw the bar start-point with
 
:''Typical values for this parameter:''
 
::{| class="wikitable" width="65%"
 
 
|-
 
|-
! width="30%" |Name
+
| colspan="2" | The graphics mode to draw the bar start-point with&nbsp;
! width="55%" |Description
 
 
|-
 
|-
|Cap_None
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
|No cap is drawn for the start or end point
+
| width="90%" | RGBA
 
|-
 
|-
|Cap_Line
+
| colspan="2" | The red, green, blue value to colour the point with&nbsp;
|A line arrow is drawn
 
 
|-
 
|-
|Cap_Triangle
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
|A flat 2D traingle
+
| width="90%" | Width
 
|-
 
|-
|Cap_Cone
+
| colspan="2" | The width to use for 3D and arrow modes&nbsp;
|A 3D cone
 
 
|-
 
|-
|Cap_Sphere
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
|A 3D sphere
+
| width="90%" | Height
 
|-
 
|-
|Cap_Dome
+
| colspan="2" | The height to use for 3D and arrow modes&nbsp;
|A 3D half-sphere
 
 
|-
 
|-
|Cap_Cylinder
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
|A 3D cylinder
+
| 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 width to use for 3D and arrow modes
 
 
[[Variable Types|FLOAT]] ''Height''
 
:The height to use for 3D and arrow modes
 
 
 
==Return value==
 
''This call does not return a value''
 
  
  
Line 74: Line 51:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetStartGfx(linkbar, ::Panel.LinkBar.Cap_None, rgba, width, height)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetStartGfx(linkbar, ::Panel.LinkBar.Cap_None, rgba, width, height)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png SetStartGfx
Sets the graphic for the start point 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 start-point with 
Fc9-u32-icon.png - ULONG RGBA
The red, green, blue value to colour the point with 
Fc9-f32-icon.png - FLOAT Width
The width to use for 3D and arrow modes 
Fc9-f32-icon.png - FLOAT Height
The height to use for 3D and arrow modes 
Fc9-void-icon.png - NONE Return


Detailed description

This sets the graphics mode for the start point of the bar. The default for the start is to have no graphics.


The Mode is the type of link to draw, and if a graphic is to be drawn this will be affected by Width and Height. Width is always assumed to be positive and its sign is ignored, but Height may be negative to invert the arrow or graphic specified.


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.SetStartGfx(linkbar, ::Panel.LinkBar.Cap_None, rgba, width, height)