Component:MultiLineMesh: Difference between revisions

From Resonite Wiki
Automated: update 'HighPriorityIntegration' description
Add info
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=MultiLineMeshComponent.png
|Image=MultiLineMeshComponent.png
|Name=Multi Line Mesh
|Name=Multi Line Mesh
}}
}}
The '''MultiLineMesh''' component generates geometry for use with a [[Component:MeshRenderer]]. For now, this component is unusable without [[Mods]] due to having a list type object.


<!--T:2-->
<!--T:2-->
Line 12: Line 12:
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|OverrideBoundingBox|Bool|
|OverrideBoundingBox|Bool| {{Template:Override Bounding Box}}
|OverridenBoundingBox|BoundingBox|
|OverridenBoundingBox|BoundingBox| {{Template:Overridden Bounding Box}}
|Profile|ColorProfile|
|Profile|ColorProfile| {{Template:ProceduralMeshColorProfile}}
|Lines|{{RootFieldType|SyncList`1|[[#Line|Line]]}}|TypeAdv4=true|
|Lines|{{RootFieldType|SyncList`1|[[#Line|Line]]}}|TypeAdv4=true| A set of lines that make up the source of the data for the geometry of this mesh.
}}
}}


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


== Line ==
== Line ==
{{stub}}
=== Fields ===
{{Table TypeFields
{{Table TypeFields
|Scale|Float|
|Scale|Float| The radius of the line. This is a multiplier.
|Color|Color|
|Color|Color| The vertex color of the line
|Points|Int|
|Points|Int| How many points are in this line.
|Topology|Topology|
|Topology|Topology| the kind of Topology this line has.
|Shading|Shading|
|Shading|Shading| How to handle the Shading of this line.
|Ends|Ends|
|Ends|Ends| How to handle the caps at the start and end of this line
|DualSided|Bool|
|DualSided|Bool| Whether the line can be seen from the inside.
|AbsolutePointOffets|Bool|
|AbsolutePointOffets|Bool| Whether each position is relative or not from the last point
|UVScale|Float2|
|UVScale|Float2| the scale of the material detail on the surface of this line.
|ScaleUVByCircumference|Bool|
|ScaleUVByCircumference|Bool| Whether to keep the material detail per square millimeter consistent regardless of the value used for <code>Scale</code>
|PreciseUV|Bool|
|PreciseUV|Bool| Whether to make a more accurate UV for the line.
|Positions|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv11=true|
|Positions|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv11=true| A list of positions to use for making the line
|Scales|{{RootFieldType|SyncArray`1|[[Type:Float|Float]]}}|TypeAdv12=true|
|Scales|{{RootFieldType|SyncArray`1|[[Type:Float|Float]]}}|TypeAdv12=true| The scale of each line segment. Each one is multipled by <code>Scales</code> for the final geometry.
|Orientations|{{RootFieldType|SyncArray`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv13=true|
|Orientations|{{RootFieldType|SyncArray`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv13=true| The rotation of each segment of the line
|Colors|{{RootFieldType|SyncArray`1|[[Type:Color|Color]]}}|TypeAdv14=true|
|Colors|{{RootFieldType|SyncArray`1|[[Type:Color|Color]]}}|TypeAdv14=true| The vertex colors of each segment of the line
|Profile|ColorProfile|
|Profile|ColorProfile| The color profile used for the vertex colors of this line.
|PointOffsets|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv16=true|
|PointOffsets|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv16=true| The offset of each point of the line. Used in tandem with <code>Orientations</code> to handle line shape.
}}
}}
<!--T:3-->
== Usage ==
Attach to a slot and insert into a [[Component:MeshRenderer]] to view the generated geometry. Don't forget to use a [[Material]].


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
 
</translate>
</translate>
[[Category:ComponentStubs]]
 
[[Category:Components{{#translation:}}|Multi Line Mesh]]
[[Category:Components{{#translation:}}|Multi Line Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Multi Line Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Multi Line Mesh]]
[[Category:Components With Nested Types{{#translation:}}|Multi Line Mesh]]
[[Category:Components With Nested Types{{#translation:}}|Multi Line Mesh]]

Latest revision as of 18:12, 11 November 2024

Component image 
Multi Line Mesh component as seen in the Scene Inspector

The MultiLineMesh component generates geometry for use with a Component:MeshRenderer. For now, this component is unusable without Mods due to having a list type object.

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.
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.
Lines list of Line A set of lines that make up the source of the data for the geometry of this mesh.

Sync Delegates

Triggers
Name 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.

Line

Fields
Name Type Description
Scale Float The radius of the line. This is a multiplier.
Color Color The vertex color of the line
Points Int How many points are in this line.
Topology Topology the kind of Topology this line has.
Shading Shading How to handle the Shading of this line.
Ends Ends How to handle the caps at the start and end of this line
DualSided Bool Whether the line can be seen from the inside.
AbsolutePointOffets Bool Whether each position is relative or not from the last point
UVScale Float2 the scale of the material detail on the surface of this line.
ScaleUVByCircumference Bool Whether to keep the material detail per square millimeter consistent regardless of the value used for Scale
PreciseUV Bool Whether to make a more accurate UV for the line.
Positions array of Float3 A list of positions to use for making the line
Scales array of Float The scale of each line segment. Each one is multipled by Scales for the final geometry.
Orientations array of FloatQ The rotation of each segment of the line
Colors array of Color The vertex colors of each segment of the line
Profile ColorProfile The color profile used for the vertex colors of this line.
PointOffsets array of Float3 The offset of each point of the line. Used in tandem with Orientations to handle line shape.


Usage

Attach to a slot and insert into a Component:MeshRenderer to view the generated geometry. Don't forget to use a Material.

Examples

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


See Also