Automated: create new component page |
add info |
||
Line 3: | Line 3: | ||
|Name=Label Content Driver | |Name=Label Content Driver | ||
}} | }} | ||
The '''LabelContentDriver''' Component is used to handle driving and updating the visual of labels placed by a [[Labeler Tool]]. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|AutoUpdate|Bool| | |AutoUpdate|Bool| Automatically update the visual per tick | ||
|Padding|Float2| | |Padding|Float2| How much padding this label should have from the label's text content. | ||
|BaseWidth|Float| | |BaseWidth|Float| The width of the underline for the text attached to the label. | ||
|ContentOrientSpace|{{RootFieldType|RootSpace}}|TypeAdv3=true| | |ContentOrientSpace|{{RootFieldType|RootSpace}}|TypeAdv3=true| How to orient the text content of this label. | ||
|OrientAtLocalUser|Bool| | |OrientAtLocalUser|Bool| Whether to look at the local user (usually true) | ||
|_contentRoot|Slot| | |_contentRoot|Slot| The root of the text content for the label this is driving. | ||
|_targetPoint|Slot| | |_targetPoint|Slot| The target point of the line coming from the underline for the label this is driving. | ||
|_contentRotation|FloatQ| | |_contentRotation|FloatQ| The rotation of the content of the label this is driving. | ||
|_contentRotationDrive|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv8=true| | |_contentRotationDrive|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv8=true| The rotation field of the content. | ||
|_labelPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv9=true| | |_labelPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv9=true| The position field of the label. | ||
|_labelWidth|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv10=true| | |_labelWidth|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv10=true| The length field of the label underline. | ||
|_lineWidth|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv11=true| | |_lineWidth|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv11=true| The width field of the line for the label. | ||
|_labelRotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv12=true| | |_labelRotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv12=true| The rotation field of the label. | ||
|_pointPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv13=true| | |_pointPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv13=true| The target point field for what the label is pointing to. | ||
}} | }} | ||
== | == Usage == | ||
Not used directly by the user. Used in the [[Labeler Tool]]. | |||
== Examples == | == Examples == | ||
See [[Labeler Tool]]. | |||
== See Also == | == See Also == | ||
* [[Labeler Tool]] | |||
[[Category:Components:Uncategorized{{#translation:}}|Label Content Driver]] | [[Category:Components:Uncategorized{{#translation:}}|Label Content Driver]] | ||
[[Category:Components{{#translation:}}|Label Content Driver]] | [[Category:Components{{#translation:}}|Label Content Driver]] | ||
Latest revision as of 19:13, 6 April 2025
Component image File:LabelContentDriverComponent.pngLabel Content Driver component as seen in the Scene Inspector
The LabelContentDriver Component is used to handle driving and updating the visual of labels placed by a Labeler Tool.
Fields
Name | Type | Description |
---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't. |
AutoUpdate
|
Bool | Automatically update the visual per tick |
Padding
|
Float2 | How much padding this label should have from the label's text content. |
BaseWidth
|
Float | The width of the underline for the text attached to the label. |
ContentOrientSpace
|
direct RootSpace | How to orient the text content of this label. |
OrientAtLocalUser
|
Bool | Whether to look at the local user (usually true) |
_contentRoot
|
Slot | The root of the text content for the label this is driving. |
_targetPoint
|
Slot | The target point of the line coming from the underline for the label this is driving. |
_contentRotation
|
FloatQ | The rotation of the content of the label this is driving. |
_contentRotationDrive
|
field drive of FloatQ | The rotation field of the content. |
_labelPosition
|
field drive of Float3 | The position field of the label. |
_labelWidth
|
field drive of Float | The length field of the label underline. |
_lineWidth
|
field drive of Float | The width field of the line for the label. |
_labelRotation
|
field drive of FloatQ | The rotation field of the label. |
_pointPosition
|
field drive of Float3 | The target point field for what the label is pointing to. |
Usage
Not used directly by the user. Used in the Labeler Tool.
Examples
See Labeler Tool.