Difference between revisions of "API Panel.LinkBar"

Latest revision as of 15:57, 16 January 2014

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

This class is contained within Panel.

Create	Creates a new bar linking a pair of position handles
SetVisible	Sets whether the link is displayed or not
SetStartPos	Sets the position for the start point of the bar
SetEndPos	Sets the position for the end point of the bar
SetStartAdjustment	Sets the clipping adjustments for the beginning of the link
SetEndAdjustment	Sets the clipping adjustments for the end of the link
SetStartGfx	Sets the graphic for the start point of the bar
SetBarGfx	Sets the graphic for the main line of the bar
SetEndGfx	Sets the graphic for the end point of the bar
GetStartPos	Gets the position the bars start point is located at
GetBarPos	Gets the position the bar is located at
GetEndPos	Gets the position the bars end point is located at
Update	Manually refresh the screen the point cloud exists on
EnableAuto	Sets whether Flowcode should automatically draw links for component object property types

Used by SetStartGfx(), SetEndGfx()
Type	Name	Value	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

Used by SetBarGfx()
Type	Name	Value	Description
LONG	Bar_None	0	No bar is drawn between the start and 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

Used by SetStartAdjustment(), SetEndAdjustment()
Type	Name	Value	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

No additional examples

@@ Line 1: / Line 1: @@
+<sidebar>API Contents</sidebar>
-<sidebar>API contents</sidebar>
 Position linkage management
@@ Line 20: / Line 18: @@
 |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]]
@@ Line 30: / Line 28: @@
 |-
 |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 49: @@
 |-
 |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 111: / Line 109: @@
 |Bar_None
 |0
-|No bar is drawn between the start or end points
+|No bar is drawn between the start and end points
 |-
 |LONG