API Panel.LinkBar.SetBarGfx - Revision history

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:57Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:30Z

JonnyW: XML import

2014-01-16T15:57:51Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:33Z

XML import of API documentation

JonnyW: XML import

2013-07-01T16:10:30Z

XML import

JonnyW: XML import

2013-07-01T13:42:48Z

XML import

JonnyW at 13:42, 1 July 2013

2013-07-01T13:42:30Z

JonnyW: XML import

2013-07-01T13:35:37Z

XML import

JonnyW: XML import of LinkBar API

2013-07-01T10:46:11Z

XML import of LinkBar API

New page

<sidebar>API contents</sidebar>
Sets the position for the start point 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="55%" |Description
|-
|Bar_None
|No bar is drawn between the start or 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
|}

[[Variable Types|ULONG]] ''RGBA''
:The red, green, blue value to colour the point with

[[Variable Types|FLOAT]] ''Radius''
:The scale to use for 3D modes

==Return value==
''This call does not return a value''

==Detailed description==
''<span style="color:red;">No additional information</span>''

==Examples==
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetBarGfx(linkbar, ::Panel.LinkBar.Bar_None, rgba, radius)</pre>

''<span style="color:red;">No additional examples</span>''

← Older revision		Revision as of 11:54, 16 January 2023
Line 46:		Line 46:
	===Calling in a calculation===		===Calling in a calculation===
	* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetBarGfx(linkbar, ::Panel.LinkBar.Bar_None, rgba, width)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetBarGfx(linkbar, ::Panel.LinkBar.Bar_None, rgba, width)</pre>
−
−	~~''<span style="color:red;">No additional examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-! 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;
 |-
 |-
-|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
+|-
 |}

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Sets the graphic for the main line of the bar		Sets the graphic for the main line of the bar

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Sets the graphic for the main line of the bar		Sets the graphic for the main line of the bar

← Older revision		Revision as of 13:42, 1 July 2013
Line 49:		Line 49:

	==Detailed description==		==Detailed description==
−	''~~<span style="color:red;">No additional information</span>~~''	+	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.
		+

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
@@ Line 24: / Line 25: @@
 |-
 |Bar_None
-|No bar is drawn between the start or end points
+|No bar is drawn between the start and end points
 |-
 |Bar_Line

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
@@ Line 40: / Line 39: @@
 :The red, green, blue value to colour the point with
-[[Variable Types|FLOAT]] ''Radius''
+[[Variable Types|FLOAT]] ''Width''
 :The scale to use for 3D modes
@@ Line 61: / Line 60: @@
 ==Examples==
 ===Calling in a calculation===
-* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetBarGfx(linkbar, ::Panel.LinkBar.Bar_None, rgba, radius)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetBarGfx(linkbar, ::Panel.LinkBar.Bar_None, rgba, width)</pre>
 ''<span style="color:red;">No additional examples</span>''

@@ Line 2: / Line 2: @@
 <sidebar>API contents</sidebar>
-Sets the position for the start point of the bar
+Sets the graphic for the main line of the bar
 <div style="width:25%; float:right" class="toc">