Component: Component Label (Misc)

Author	Matrix Ltd.
Version	1.2
Category	Misc

Component Label component

Add a label to a component by including this component as a sub-component. The label will always face the viewer and move with its parent object. Text for the label is automatically read from the host component's name or any chosen property.

Component Source Code

Please click here to view the component source code (Beta): FC_Comp_Source_component_label.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

	SetTargets
Set the objects used to determine the label text and position.
- HANDLE	TextObject
Object that will provide the label text from its name or a property.
- HANDLE	BoundsObject
Object that will set the label position and bounding box.
- VOID	Return

	ShowProperty
Sets the label to show a named property of the target object.
- STRING	Property
Name of the property to show.
- VOID	Return

	SetPosition
Set where the label will appear relative to the object.
- BYTE	Position
Set the position - choose a preset from the list of constants, or 'Position XYZ to enter values below.
- FLOAT	X
X axis offset (only if 'Position_XYZ' selected for 'Position')
- FLOAT	Y
Y axis offset (only if 'Position_XYZ' selected for 'Position')
- FLOAT	Z
Z axis offset (only if 'Position_XYZ' selected for 'Position')
- VOID	Return

	Hide
Hides the label.
- VOID	Return

	SetColor
Sets the color of the label using a single ULONG value - such as returned by panel GetColor functions.
- ULONG	Color
Color to set the labels to.
- VOID	Return

	SetColorRGB
Set the label color using separate red, green and blue color channels.
- BYTE	Red
Color parameter
- BYTE	Green
Color parameter
- BYTE	Blue
Color parameter
- VOID	Return

	Update
Refresh the label after a change.
- VOID	Return

	ShowName
Sets the label to show the target object's name
- VOID	Return

Property reference

	Properties
	Show
Decide what label to show... None - no labels are displayed Name - shows the component's name Property - shows a property value of the component (a field for the property name will appear below)
	Label target
Set the object from which the label text will be taken. If none is given, defaults to the parent of the label component.
	Bounds target
Set the object used to set the dimensions used for the positioning of the labels. If none is given, defaults to the parent of the label component.
	Auto Update
Automatically update the label whenever the target's name or labelled property changes. Use this sparingly, as it requires the component to regularly poll the component for changes!!
	Appearance
	Color
Color of the label text.
	Background
Color for label backgroiunds - may be transparent.
	Always On Top
Whether labels should always be draw on top of other objects.
	Size
	Scale
Sets the basic size (text height) of the labels.
	Follow Zoom
Whether labels get bigger and smaller when the panel is zoomed in and out.
	Offset
	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', the manual offsett values can be edited below.

==Macro reference==

	SetTargets
Set the objects used to determine the label text and position.
- HANDLE	TextObject
Object that will provide the label text from its name or a property.
- HANDLE	BoundsObject
Object that will set the label position and bounding box.
- VOID	Return

	ShowProperty
Sets the label to show a named property of the target object.
- STRING	Property
Name of the property to show.
- VOID	Return

	SetPosition
Set where the label will appear relative to the object.
- BYTE	Position
Set the position - choose a preset from the list of constants, or 'Position XYZ to enter values below.
- FLOAT	X
X axis offset (only if 'Position_XYZ' selected for 'Position')
- FLOAT	Y
Y axis offset (only if 'Position_XYZ' selected for 'Position')
- FLOAT	Z
Z axis offset (only if 'Position_XYZ' selected for 'Position')
- VOID	Return

	Hide
Hides the label.
- VOID	Return

	SetColor
Sets the color of the label using a single ULONG value - such as returned by panel GetColor functions.
- ULONG	Color
Color to set the labels to.
- VOID	Return

	SetColorRGB
Set the label color using separate red, green and blue color channels.
- BYTE	Red
Color parameter
- BYTE	Green
Color parameter
- BYTE	Blue
Color parameter
- VOID	Return

	Update
Refresh the label after a change.
- VOID	Return

	ShowName
Sets the label to show the target object's name
- VOID	Return

Property reference

	Properties
	Show
Decide what label to show... None - no labels are displayed Name - shows the component's name Property - shows a property value of the component (a field for the property name will appear below)
	Label target
Set the object from which the label text will be taken. If none is given, defaults to the parent of the label component.
	Bounds target
Set the object used to set the dimensions used for the positioning of the labels. If none is given, defaults to the parent of the label component.
	Auto Update
Automatically update the label whenever the target's name or labelled property changes. Use this sparingly, as it requires the component to regularly poll the component for changes!!
	Appearance
	Color
Color of the label text.
	Background
Color for label backgroiunds - may be transparent.
	Always On Top
Whether labels should always be draw on top of other objects.
	Size
	Scale
Sets the basic size (text height) of the labels.
	Follow Zoom
Whether labels get bigger and smaller when the panel is zoomed in and out.
	Offset
	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', the manual offsett values can be edited below.