Component:GridMesh: Difference between revisions

From Resonite Wiki
Automated: update 'HighPriorityIntegration' description
Automated: update 'BakeMesh()' description
 
(3 intermediate revisions by the same user not shown)
Line 7: Line 7:
|Name=Grid Mesh
|Name=Grid Mesh
}}
}}
Generates a procedural mesh for use with [[Component:MeshRenderer|Mesh Renderers]] that is like a [[Component:QuadMesh|Quad Mesh]] but has multiple squares instead of being one big square.


<!--T:2-->
<!--T:2-->
Line 12: Line 14:
{{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}}
|Points|Int2|
|Points|Int2| how many vertex points should be used on each axis to make the grid of quads
|Size|Float2|
|Size|Float2| how big the grid is scale wise.
|FlatShading|Bool|
|FlatShading|Bool| Disable smooth shading
|DisplacementMagnitude|Float|
|DisplacementMagnitude|Float| How far to displace the grid texture using <code>DisplacementTexture</code>
|DisplacementTexture|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv8=true|
|DisplacementTexture|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv8=true| The texture to use for displacement. must be set to Uncompressed.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
<!--T:6-->
The texture the DisplacementTexture field must be set to Uncompressed


<!--T:4-->
<!--T:4-->
Line 34: Line 38:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:Components{{#translation:}}|Grid Mesh]]
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Grid Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Grid Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Grid 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 
Grid Mesh component as seen in the Scene Inspector


Generates a procedural mesh for use with Mesh Renderers that is like a Quad Mesh but has multiple squares instead of being one big square.

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 Int2 how many vertex points should be used on each axis to make the grid of quads
Size Float2 how big the grid is scale wise.
FlatShading Bool Disable smooth shading
DisplacementMagnitude Float How far to displace the grid texture using DisplacementTexture
DisplacementTexture Texture2D The texture to use for displacement. must be set to Uncompressed.

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

Examples

Related Components