Component:IcoSphereMesh: Difference between revisions

From Resonite Wiki
Automated: update 'BakeMesh()' description
add more info
 
Line 1: Line 1:
<languages></languages>
<languages></languages>
<translate>
<translate>
{{Note|The Vertex count on the mesh generated by this component increases exponentially with respect to the value in <code>Subdivisions</code> — Please use caution when using larger values|danger}}  
{{Note|The vertex count on a generated '''IcoSphereMesh''' is 20×4<sup>n</sup>, where n is <code>Subdivisions</code> — this may result in extremely large vertex counts for seemingly small values of <code>Subdivisions</code> — '''Please use caution!'''|warning}}
{{Infobox Component
{{Infobox Component
|Image=IcoSphereMeshComponent.png
|Image=IcoSphereMeshComponent.png
|Name=IcoSphereMesh
|Name=IcoSphereMesh
}}
}}
== Introduction ==
The '''IcoSphereMesh''' component procedurally generates a icosahedron mesh for use with a MeshRenderer, according to the parameters provided.  
The '''IcoSphereMesh''' component procedurally generates a icosahedron mesh for use with a MeshRenderer, according to the parameters provided.  
== Usage ==
 
As of [https://github.com/Frooxius/NeosPublic/issues/1206 Version 2020.10.25.1103], this value is clamped in the range [0,8] to prevent accidentally creating a mesh with an excessive number of vertices.
 
== Fields ==
{{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}}
|Radius|Float| Radius of the IcoSphere
|Radius|Float| Radius of the IcoSphere
|Subdivisions|Int| Number of IcoSphere subdivisions — Values are clamped in the range [0,8]
|Subdivisions|Int| Number of IcoSphere subdivisions — Values are clamped in the range [0,8]
Line 25: Line 27:
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
}}
}}
== Behavior ==
{{Note|The vertex count on a generated '''IcoSphereMesh''' is 20×4<sup>n</sup>, where n is <code>Subdivisions</code> — this may result in extremely large vertex counts for seemingly small values of <code>Subdivisions</code> — '''Please use caution!'''|warning}}


As of [https://github.com/Frooxius/NeosPublic/issues/1206 Version 2020.10.25.1103], this value is clamped in the range [0,8] to prevent accidentally creating a mesh with an excessive number of vertices.
== Usage ==
Attach to a slot and insert into a [[Component:MeshRenderer]] to view the geometry. Don't forget to use a [[Material]].


== Examples ==
== Examples ==
== Related Components ==
{{stub}}
 
== See Also ==
* [[Component:SphereMesh]]
</translate>
</translate>
[[Category:Components{{#translation:}}|Ico Sphere Mesh]]
[[Category:Components{{#translation:}}|Ico Sphere Mesh]]
[[Category:ComponentStubs]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Ico Sphere Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Ico Sphere Mesh]]

Latest revision as of 19:34, 13 November 2024

The vertex count on a generated IcoSphereMesh is 20×4n, where n is Subdivisions — this may result in extremely large vertex counts for seemingly small values of SubdivisionsPlease use caution!
Component image 
IcoSphereMesh component as seen in the Scene Inspector

The IcoSphereMesh component procedurally generates a icosahedron mesh for use with a MeshRenderer, according to the parameters provided.

As of Version 2020.10.25.1103, this value is clamped in the range [0,8] to prevent accidentally creating a mesh with an excessive number of vertices.

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.
Radius Float Radius of the IcoSphere
Subdivisions Int Number of IcoSphere subdivisions — Values are clamped in the range [0,8]
FlatShading Bool Use flat/faceted shading instead of smooth shading.
FlatFaceExtrude Float Distance to extrude faces after being generated. Creates an "Exploded" appearance
FlatFaceScale Float Scale of individual faces, relative to their base size.

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.

Usage

Attach to a slot and insert into a Component:MeshRenderer to view the 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