Component:PointClusterMesh: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
Automated: update 'BakeMesh()' description
Basic description, document some fields
 
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=PointClusterMeshComponent.png
|Image=PointClusterMeshComponent.png
|Name=Point Cluster Mesh
|Name=Point Cluster Mesh
}}
}}
The '''PointClusterMesh''' component generates a randomized cluster of points in a cloud. 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-->
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}}
|Distribution|'''[[#DistributionType|DistributionType]]'''|TypeAdv4=true|
|Distribution|'''[[#DistributionType|PointClusterMesh.DistributionType]]'''|TypeAdv4=true|
|Colors|'''[[#ColorMode|ColorMode]]'''|TypeAdv5=true|
|Colors|'''[[#ColorMode|PointClusterMesh.ColorMode]]'''|TypeAdv5=true|
|TextureColorSource|{{RootFieldType|AssetRef`1|[[Type:ITexture|ITexture]]}}|TypeAdv6=true|
|TextureColorSource|{{RootFieldType|AssetRef`1|[[Type:ITexture|ITexture]]}}|TypeAdv6=true|
|HeightScaleSource|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv7=true|
|HeightScaleSource|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv7=true|
Line 23: Line 23:
|MaxClipAttempts|Int|
|MaxClipAttempts|Int|
|HeightmapExp|Float|
|HeightmapExp|Float|
|Seed|Int|
|Seed|Int| The number to use to seed the generation of random points.
|Points|Int|
|Points|Int| The number of points to generate.
|Atlas|{{RootFieldType|RelayRef`1|[[Component:AtlasInfo|AtlasInfo]]}}|TypeAdv14=true|
|Atlas|{{RootFieldType|RelayRef`1|[[Component:AtlasInfo|AtlasInfo]]}}|TypeAdv14=true|
|Scale|Float3|
|Scale|Float3| The scale of the generated mesh.
|RangeExp|Float|
|RangeExp|Float|
|JitterRange|Float3|
|JitterRange|Float3| The maximum value to randomly offset each point.
|Color0|ColorX|
|Color0|ColorX|
|Color1|ColorX|
|Color1|ColorX|
Line 35: Line 35:
|SimplexNoiseScale|Float3|
|SimplexNoiseScale|Float3|
|SimplexNoiseOffset|Float3|
|SimplexNoiseOffset|Float3|
|UniformSize|Bool|
|UniformSize|Bool| Whether all points should always be uniformly scaled.
|MinSize|Float2|
|MinSize|Float2| The minimum size of a point.
|MaxSize|Float2|
|MaxSize|Float2| The maximum size of a point.
|MinRotation|Float|
|MinRotation|Float| The minimum rotation of a point.
|MaxRotation|Float|
|MaxRotation|Float| The maximum rotation of a point.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
|BakeMesh:[[Type:Action|Action]]|[[Type:Action|Action]]|false|{{Template:BakeMeshSyncMethod}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
This is used for the colored orbs in the sky of the [[Resonite Cloud Home]].


<!--T:4-->
<!--T:4-->
Line 54: Line 55:


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
[[Component:PointMesh]]
</translate>
</translate>


Latest revision as of 01:53, 27 August 2025

Component image 
Point Cluster Mesh component as seen in the Scene Inspector

The PointClusterMesh component generates a randomized cluster of points in a cloud. 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. 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.
Distribution PointClusterMesh.DistributionType
Colors PointClusterMesh.ColorMode
TextureColorSource ITexture
HeightScaleSource Texture2D
TextureIntensityClip Float
TextureAlphaClip Float
MaxClipAttempts Int
HeightmapExp Float
Seed Int The number to use to seed the generation of random points.
Points Int The number of points to generate.
Atlas direct RelayRef`1<AtlasInfo>
Scale Float3 The scale of the generated mesh.
RangeExp Float
JitterRange Float3 The maximum value to randomly offset each point.
Color0 ColorX
Color1 ColorX
ColorLerpScale Float
ColorGap Float
SimplexNoiseScale Float3
SimplexNoiseOffset Float3
UniformSize Bool Whether all points should always be uniformly scaled.
MinSize Float2 The minimum size of a point.
MaxSize Float2 The maximum size of a point.
MinRotation Float The minimum rotation of a point.
MaxRotation Float The maximum rotation of a point.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
BakeMesh:Action Action X 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

This is used for the colored orbs in the sky of the Resonite Cloud Home.

Examples

See Also

Component:PointMesh

Retrieved from "https://wiki.resonite.com/index.php?title=Component:PointClusterMesh&oldid=112350"