Component:LabelPointerMesh: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page LabelPointerMesh (Component) to Component:LabelPointerMesh: Creating component Namespace
add info
 
(7 intermediate revisions by 2 users not shown)
Line 7: Line 7:
|Name=Label Pointer Mesh
|Name=Label Pointer Mesh
}}
}}
The '''LabelPointerMesh''' component is used by the labeler tool to point to a position and underline some generated text elements.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|OverrideBoundingBox|Bool|
|OverrideBoundingBox|Bool| {{Template:Override Bounding Box}}
|OverridenBoundingBox|BoundingBox|
|OverridenBoundingBox|BoundingBox| {{Template:Overridden Bounding Box}}
|LabelPoint|Float3|
|Profile|ColorProfile| {{Template:ProceduralMeshColorProfile}}
|TargetPoint|Float3|
|LabelPoint|Float3| Where the label should render in local space.
|LabelRotation|FloatQ|
|TargetPoint|Float3| Where the line from the label should point to.
|LabelWidth|Float|
|LabelRotation|FloatQ| The rotation of the label visual.
|Width|Float|
|LabelWidth|Float| The width of the label visual.
|ExpandLerp|Float|
|Width|Float| The width of the line going from the label to <code>TargetPoint</code>
|DualSided|Bool|
|ExpandLerp|Float| How long the label underline should be.
|DualSided|Bool| Whether the mesh should have duplicate geometry with the fronts facing the opposite direction.
}}
}}


<!--T:3-->
== Sync Delegates ==
== Usage ==
{{Table ComponentTriggers
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
}}


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Used by the labeler tool.


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
* [[Labeler Tool]]
</translate>
</translate>
[[Category:ComponentStubs]]
 
[[Category:Components{{#translation:}}|Label Pointer Mesh]]
[[Category:Components{{#translation:}}|Label Pointer Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Label Pointer Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Label Pointer Mesh]]

Latest revision as of 16:25, 21 January 2025


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Component image 
Label Pointer Mesh component as seen in the Scene Inspector

The LabelPointerMesh component is used by the labeler tool to point to a position and underline some generated text elements.

Fields

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.
HighPriorityIntegration Bool If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes.
OverrideBoundingBox Bool Force the bounding box calculated from this component to use OverridenBoundingBox instead of calculating when requested.
OverridenBoundingBox BoundingBox the bounding box this component should say it has when OverrideBoundingBox is enabled. Useful for bounding box calculations with Flux, or changing the selection box for this component when rendered.
Profile ColorProfile The profile that the vertex colors for this mesh should be displayed in.
LabelPoint Float3 Where the label should render in local space.
TargetPoint Float3 Where the line from the label should point to.
LabelRotation FloatQ The rotation of the label visual.
LabelWidth Float The width of the label visual.
Width Float The width of the line going from the label to TargetPoint
ExpandLerp Float How long the label underline should be.
DualSided Bool Whether the mesh should have duplicate geometry with the fronts facing the opposite direction.

Sync Delegates

Triggers
Method Name Method type and Arguments. Description
BakeMesh() Action Bake meshes is a sync method that creates a static mesh component with this component, replaces all references to this component with the static mesh component, then deletes this component.

Examples

Used by the labeler tool.

See Also