Difference between revisions of "Component: Component Labels (Advanced Shapes)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd.
 
| Matrix Ltd.
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.2 (Release)
+
| 1.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Advanced Shapes
 
| Advanced Shapes
 
|}
 
|}
  
  
 +
==Component Labels component==
 +
Automatically generates labels for all panel objects and components in a given context. Labels will always face the camera, and can show the name of each object, or any chosen property.  Nesting can be used so that components within components are labelled, and so on.
  
−
==[[File:Component Icon 446d753f_a6dc_489d_b624_f4f191783aa0.png|Image]] Component Labels component==
+
==Detailed description==
−
Automatically generates labels for all panel objects and components in a given context.
+
 
−
Labels will always face the camera, and can show the name of each object, or any chosen
+
''No detailed description exists yet for this component''
−
property.  Nesting can be used so that components within components are labelled, and so on.
 
  
 
==Examples==
 
==Examples==
 +
 +
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
  
Line 26: Line 27:
 
==Downloadable macro reference==
 
==Downloadable macro reference==
  
−
''This component does not contain any downloadable macros''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShowProperty'''
 +
|-
 +
| colspan="2" | Sets the labels to show a named property of each object.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Property
 +
|-
 +
| colspan="2" | Name of the property to show.&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>ShowProperty</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Sets the labels to show a named property of each object.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShowNames'''
 +
|-
 +
| colspan="2" | Sets the labels to show the names of objects.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|STRING]] ''Property''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::Name of the property to show.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Hide'''
 +
|-
 +
| colspan="2" | Hides all labels.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTarget'''
 +
|-
 +
| colspan="2" | Set the target object.  All items within the scope of this object will be given labels, not the taget object itself.  If the target is set to zero or 'this', all objects in the  current scope will be labelled.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | target
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:''This call does not return a value''
 
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetColor'''
 +
|-
 +
| colspan="2" | Sets the color of the labels.  Note that this affects all nesting levels, so any nesting level specific colors set in the properties panel will be overridden.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Color
 +
|-
 +
| colspan="2" | Color to set the labels to.&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>ShowNames</tt></u></span>===
 
−
Sets the labels to show the names of objects.
 
  
−
'''Parameters'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
:''This macro has no parameters''
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Update'''
−
 
+
|-
−
'''Return value'''
+
| colspan="2" | Refresh the labels after a change.&nbsp;
−
 
+
|-
−
:''This call does not return a value''
+
|-
−
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
−
 
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
===<span style="font-weight: normal;"><u><tt>Hide</tt></u></span>===
+
|}
−
Hides all labels.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:''This macro has no parameters''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>SetTarget</tt></u></span>===
 
−
Set the target object.  All items within the scope of this object will be given labels, not the taget object itself.  If the target is set to zero or 'this', all objects in the
 
−
 
 
−
current scope will be labelled.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|HANDLE]] ''target''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>SetColor</tt></u></span>===
 
−
Sets the color of the labels.  Note that this affects all nesting levels, so any nesting
 
−
 
 
−
level specific colors set in the properties panel will be overridden.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|ULONG]] ''Color''
 
−
::Color to set the labels to.
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>Update</tt></u></span>===
 
−
Refresh the labels after a change.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:''This macro has no parameters''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
  
  
Line 117: Line 123:
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Show</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''show''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Decide what labels to show...
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
None - no labels are displayed
+
|-
−
 
+
|-
−
Name - shows each component's name
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Show
−
Property - shows a particular property of each component (see 'property' below.
+
|-
−
 
+
| colspan="2" | Decide what labels to show... None - no labels are displayed Name - shows each component's name Property - shows a particular property of each component (see 'property' below.&nbsp;
−
<span style="font-weight: normal;"><u>Auto Update</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''auto_update''.
+
| width="90%" | Auto Update
−
 
+
|-
−
Automatically update the labels whenever panel items are added, deleted or re-named.
+
| colspan="2" | Automatically update the labels whenever panel items are added, deleted or re-named.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Auto Target</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Auto Target
−
This property is of type ''True or false'' and can be referenced with the variable name ''auto_target''.
+
|-
−
 
+
| colspan="2" | When auto target is on, the auto labeller will label every item in its own context. When off, the "SetTarget" macro must be used to set the scope of the labeller.&nbsp;
−
When auto target is on, the auto labeller will label every item in its own context.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
When off, the "SetTarget" macro must be used to set the scope of the labeller.
+
| width="90%" | Color
−
 
+
|-
−
<span style="font-weight: normal;"><u>Color</u></span>
+
| colspan="2" | Color of the labels text.&nbsp;
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''color''.
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
 
+
| width="90%" | Background
−
Color of the labels text.
+
|-
−
 
+
| colspan="2" | Color for label backgroiunds - may be transparent.&nbsp;
−
<span style="font-weight: normal;"><u>Background</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''bg_color''.
+
| width="90%" | Always On Top
−
 
+
|-
−
Color for label backgroiunds - may be transparent.
+
| colspan="2" | Whether labels should always be draw on top of other objects.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Always On Top</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Scale
−
This property is of type ''True or false'' and can be referenced with the variable name ''on_top''.
+
|-
−
 
+
| colspan="2" | Sets the basic size (text height) of the labels.&nbsp;
−
Whether labels should always be draw on top of other objects.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Scale</u></span>
+
| width="90%" | Follow Zoom
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''scale''.
+
| colspan="2" | Whether labels get bigger and smaller when the panel is zoomed in and out.&nbsp;
−
 
+
|-
−
Sets the basic size (text height) of the labels.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Auto
−
<span style="font-weight: normal;"><u>Follow Zoom</u></span>
+
|-
−
 
+
| colspan="2" | Attempt to automatically move the label to the side of the object.  Choose a positive or negative offset in any of the three axes.  When 'off' is chosen, you will be able to enter manual offsets along each axis.&nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''auto_scale''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
Whether labels get bigger and smaller when the panel is zoomed in and out.
+
| width="90%" | Nesting
−
 
+
|-
−
<span style="font-weight: normal;"><u>Auto</u></span>
+
| colspan="2" | Whether to label child items of groups, groups within groups etc. Off - only items at the same level as the labeller get labelled. Nest levels - how many 'generations' to iterate into groups. Show Leaves - does not label groups, but labels all individual items, no matter how far nested. &nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''auto_offset''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
−
Attempt to automatically move the label to the side of the object.  Choose a positive or negative offset in
+
|-
−
 
+
|-
−
any of the three axes.  When 'off' is chosen, you will be able to enter manual offsets along each axis.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
−
<span style="font-weight: normal;"><u>Nesting</u></span>
+
|-
−
 
+
|}
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''nesting''.
 
−
 
 
−
Whether to label child items of groups, groups within groups etc.
 
−
 
 
−
Off - only items at the same level as the labeller get labelled.
 
−
 
 
−
Nest levels - how many 'generations' to iterate into groups.
 
−
 
 
−
Show Leaves - does not label groups, but labels all individual items, no matter how far nested.
 

Revision as of 21:01, 16 November 2021

Author Matrix Ltd.
Version 1.2
Category Advanced Shapes


Component Labels component

Automatically generates labels for all panel objects and components in a given context. Labels will always face the camera, and can show the name of each object, or any chosen property. Nesting can be used so that components within components are labelled, and so on.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png ShowProperty
Sets the labels to show a named property of each object. 
Fc9-string-icon.png - STRING Property
Name of the property to show. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ShowNames
Sets the labels to show the names of objects. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Hide
Hides all labels. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetTarget
Set the target object. All items within the scope of this object will be given labels, not the taget object itself. If the target is set to zero or 'this', all objects in the current scope will be labelled. 
[[File:]] - target
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetColor
Sets the color of the labels. Note that this affects all nesting levels, so any nesting level specific colors set in the properties panel will be overridden. 
Fc9-u32-icon.png - ULONG Color
Color to set the labels to. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Update
Refresh the labels after a change. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Show
Decide what labels to show... None - no labels are displayed Name - shows each component's name Property - shows a particular property of each component (see 'property' below. 
Fc9-type-7-icon.png Auto Update
Automatically update the labels whenever panel items are added, deleted or re-named. 
Fc9-type-7-icon.png Auto Target
When auto target is on, the auto labeller will label every item in its own context. When off, the "SetTarget" macro must be used to set the scope of the labeller. 
Fc9-type-1-icon.png Color
Color of the labels text. 
Fc9-type-2-icon.png Background
Color for label backgroiunds - may be transparent. 
Fc9-type-7-icon.png Always On Top
Whether labels should always be draw on top of other objects. 
Fc9-type-15-icon.png Scale
Sets the basic size (text height) of the labels. 
Fc9-type-7-icon.png Follow Zoom
Whether labels get bigger and smaller when the panel is zoomed in and out. 
Fc9-type-16-icon.png Auto
Attempt to automatically move the label to the side of the object. Choose a positive or negative offset in any of the three axes. When 'off' is chosen, you will be able to enter manual offsets along each axis. 
Fc9-type-16-icon.png Nesting
Whether to label child items of groups, groups within groups etc. Off - only items at the same level as the labeller get labelled. Nest levels - how many 'generations' to iterate into groups. Show Leaves - does not label groups, but labels all individual items, no matter how far nested.  
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Component_Labels_(Advanced_Shapes)&oldid=25687"