API Panel.LinkBar - Revision history

JonnyW: XML import

2014-01-16T15:57:51Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:46Z

XML import of API documentation

JonnyW: XML import

2013-07-01T16:10:30Z

XML import

JonnyW: XML import

2013-07-01T13:35:37Z

XML import

JonnyW: XML import

2013-07-01T12:02:48Z

XML import

JonnyW: XML import of LinkBar API

2013-07-01T10:46:12Z

XML import of LinkBar API

New page

<sidebar>API contents</sidebar>
Position linkage management

This class is contained within [[API Panel|Panel]].

__TOC__

==Functions provided for this class==
{|
|-
|width="35%"|[[API Panel.LinkBar.Create|Create]]
|Creates a new bar linking a pair of position handles
|-
|width="35%"|[[API Panel.LinkBar.SetVisible|SetVisible]]
|Sets whether the link is displayed or not
|-
|width="35%"|[[API Panel.LinkBar.SetStartPos|SetStartPos]]
|Sets the position for the start point of the bar
|-
|width="35%"|[[API Panel.LinkBar.SetStartPos|SetStartPos]]
|Sets the position for the start point of the bar
|-
|width="35%"|[[API Panel.LinkBar.SetStartAdjustment|SetStartAdjustment]]
|Sets the clipping adjustments for the beginning of the link
|-
|width="35%"|[[API Panel.LinkBar.SetEndAdjustment|SetEndAdjustment]]
|Sets the clipping adjustments for the end of the link
|-
|width="35%"|[[API Panel.LinkBar.SetStartGfx|SetStartGfx]]
|Sets the position for the start point of the bar
|-
|width="35%"|[[API Panel.LinkBar.SetBarGfx|SetBarGfx]]
|Sets the position for the start point of the bar
|-
|width="35%"|[[API Panel.LinkBar.SetEndGfx|SetEndGfx]]
|Sets the position for the start point of the bar
|-
|width="35%"|[[API Panel.LinkBar.GetStartPos|GetStartPos]]
|Gets the position the bars start point is located at
|-
|width="35%"|[[API Panel.LinkBar.GetBarPos|GetBarPos]]
|Gets the position the bar is located at
|-
|width="35%"|[[API Panel.LinkBar.GetEndPos|GetEndPos]]
|Gets the position the bars end point is located at
|-
|width="35%"|[[API Panel.LinkBar.Update|Update]]
|Manually refresh the screen the point cloud exists on
|-
|width="35%"|[[API Panel.LinkBar.EnableAuto|EnableAuto]]
|Creates a new bar linking a pair of position handles
|}

==Constants provided for this class==
{| class="wikitable" width="85%"
|+ Used by [[API Panel.LinkBar.SetStartGfx|SetStartGfx]](), [[API Panel.LinkBar.SetEndGfx|SetEndGfx]]()
|-
!width="10%"|Type
!width="20%"|Name
!width="20%"|Value
!width="60%"|Description
|-
|LONG
|Cap_None
|0
|No cap is drawn for the start or end point
|-
|LONG
|Cap_Line
|1
|A line arrow is drawn
|-
|LONG
|Cap_Triangle
|2
|A flat 2D traingle
|-
|LONG
|Cap_Cone
|3
|A 3D cone
|-
|LONG
|Cap_Sphere
|4
|A 3D sphere
|-
|LONG
|Cap_Dome
|5
|A 3D half-sphere
|-
|LONG
|Cap_Cylinder
|6
|A 3D cylinder
|}

{| class="wikitable" width="85%"
|+ Used by [[API Panel.LinkBar.SetBarGfx|SetBarGfx]]()
|-
!width="10%"|Type
!width="20%"|Name
!width="20%"|Value
!width="60%"|Description
|-
|LONG
|Bar_None
|0
|No bar is drawn between the start or end points
|-
|LONG
|Bar_Line
|1
|A line is drawn connecting the start and end
|-
|LONG
|Bar_Cone
|2
|A 3D cone is drawn connecting the start and end points
|-
|LONG
|Bar_Cylinder
|3
|A cylinder is drawn connecting the start and end points
|}

{| class="wikitable" width="85%"
|+ Used by [[API Panel.LinkBar.SetStartAdjustment|SetStartAdjustment]](), [[API Panel.LinkBar.SetEndAdjustment|SetEndAdjustment]]()
|-
!width="10%"|Type
!width="20%"|Name
!width="20%"|Value
!width="60%"|Description
|-
|LONG
|Adjust_None
|0
|The point will meet the center of the target position
|-
|LONG
|Adjust_Sphere
|1
|The point will meet the edge of the sphere encompassing the position
|-
|LONG
|Adjust_Box
|2
|The point will meet the bounding box of the sphere
|}

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

==See also==
''<span style="color:red;">No additional information</span>''

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Position linkage management		Position linkage management

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


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Position linkage management		Position linkage management

@@ Line 111: / Line 111: @@
 |Bar_None
 |0
-|No bar is drawn between the start or end points
+|No bar is drawn between the start and end points
 |-
 |LONG

@@ Line 30: / Line 30: @@
 |-
 |width="35%"|[[API Panel.LinkBar.SetStartGfx|SetStartGfx]]
-|Sets the position for the start point of the bar
+|Sets the graphic for the start point of the bar
 |-
 |width="35%"|[[API Panel.LinkBar.SetBarGfx|SetBarGfx]]
-|Sets the position for the start point of the bar
+|Sets the graphic for the main line of the bar
 |-
 |width="35%"|[[API Panel.LinkBar.SetEndGfx|SetEndGfx]]
-|Sets the position for the start point of the bar
+|Sets the graphic for the end point of the bar
 |-
 |width="35%"|[[API Panel.LinkBar.GetStartPos|GetStartPos]]
@@ Line 51: / Line 51: @@
 |-
 |width="35%"|[[API Panel.LinkBar.EnableAuto|EnableAuto]]
-|Creates a new bar linking a pair of position handles
+|Sets whether Flowcode should automatically draw links for component object property types
 |}

@@ Line 20: / Line 20: @@
 |Sets the position for the start point of the bar
 |-
-|width="35%"|[[API Panel.LinkBar.SetStartPos|SetStartPos]]
+|width="35%"|[[API Panel.LinkBar.SetEndPos|SetEndPos]]
-|Sets the position for the start point of the bar
+|Sets the position for the end point of the bar
 |-
 |width="35%"|[[API Panel.LinkBar.SetStartAdjustment|SetStartAdjustment]]