Component:PointMesh: Difference between revisions

From Resonite Wiki
Automated: update component fields
Automated: update 'BakeMesh()' description
 
(4 intermediate revisions by 2 users not shown)
Line 7: Line 7:
|Name=Point Mesh
|Name=Point Mesh
}}
}}
Point mesh makes geometry data of a cloud of points that have uvs, scales, colors, and more. These points can be displayed via a [[Component:MeshRenderer|Mesh Renderer]] using a [[Component:UnlitMaterial|Unlit Material]] with at least it's <code>UseBillboardGeometry</code> field set to true.


<!--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}}
|Profile|ColorProfile|
|Profile|ColorProfile| {{Template:ProceduralMeshColorProfile}}
|Points|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv4=true|
|Points|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv4=true| The positions of each vertex point.
|Sizes|{{RootFieldType|SyncArray`1|[[Type:Float2|Float2]]}}|TypeAdv5=true|
|Sizes|{{RootFieldType|SyncArray`1|[[Type:Float2|Float2]]}}|TypeAdv5=true| The sizes of each vertex point.
|Rotations|{{RootFieldType|SyncArray`1|[[Type:Float|Float]]}}|TypeAdv6=true|
|Rotations|{{RootFieldType|SyncArray`1|[[Type:Float|Float]]}}|TypeAdv6=true| The rotations of each vertex point.
|Colors|{{RootFieldType|SyncArray`1|[[Type:Color|Color]]}}|TypeAdv7=true|
|Colors|{{RootFieldType|SyncArray`1|[[Type:Color|Color]]}}|TypeAdv7=true| The vertex color of each vertex point.
|ColorsProfile|ColorProfile|
|ColorsProfile|ColorProfile| The color profile of each vertex point.
|UVs|{{RootFieldType|SyncArray`1|[[Type:Float4|Float4]]}}|TypeAdv9=true|
|UVs|{{RootFieldType|SyncArray`1|[[Type:Float4|Float4]]}}|TypeAdv9=true| The uv center and quad scales of each vertex point.
|Sort|Bool|
|Sort|Bool| Enable sorting the mesh vertex indices by distance from <code>SortPoint</code>.
|SortPoint|Float3|
|SortPoint|Float3| The point to sort by distance from.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Not usually useable by the user without [[Mods]].


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Generated by any of the dot billboard brushes in Resonite Essentials/Brushes/Billboard Brushes


<!--T:5-->
<!--T:5-->
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:Components{{#translation:}}|Point Mesh]]
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Point Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Point Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Point Mesh]]

Latest revision as of 21:30, 6 November 2024


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


Component image 
Point Mesh component as seen in the Scene Inspector

Point mesh makes geometry data of a cloud of points that have uvs, scales, colors, and more. These points can be displayed via a Mesh Renderer using a Unlit Material with at least it's UseBillboardGeometry field set to true.

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.
Points array of Float3 The positions of each vertex point.
Sizes array of Float2 The sizes of each vertex point.
Rotations array of Float The rotations of each vertex point.
Colors array of Color The vertex color of each vertex point.
ColorsProfile ColorProfile The color profile of each vertex point.
UVs array of Float4 The uv center and quad scales of each vertex point.
Sort Bool Enable sorting the mesh vertex indices by distance from SortPoint.
SortPoint Float3 The point to sort by distance from.

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.

Usage

Not usually useable by the user without Mods.

Examples

Generated by any of the dot billboard brushes in Resonite Essentials/Brushes/Billboard Brushes

Related Components