m ProbablePrime moved page IcoSphereMesh (Component) to Component:IcoSphereMesh: Creating component Namespace |
Automated: update 'BakeMesh()' description |
||
(8 intermediate revisions by 3 users not shown) | |||
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}} | ||
{{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 == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|HighPriorityIntegration|Bool| | |HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}} | ||
|OverrideBoundingBox|Bool| | |OverrideBoundingBox|Bool| | ||
|OverridenBoundingBox|BoundingBox| | |OverridenBoundingBox|BoundingBox| | ||
|Profile|ColorProfile| | |||
|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 19: | Line 19: | ||
|FlatFaceExtrude|Float| Distance to extrude faces after being generated. Creates an "Exploded" appearance | |FlatFaceExtrude|Float| Distance to extrude faces after being generated. Creates an "Exploded" appearance | ||
|FlatFaceScale|Float| Scale of individual faces, relative to their base size. | |FlatFaceScale|Float| Scale of individual faces, relative to their base size. | ||
}} | |||
== Sync Delegates == | |||
{{Table ComponentTriggers | |||
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}} | |||
}} | }} | ||
== Behavior == | == 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. | 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. | ||
== Examples == | == Examples == | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}| | [[Category:Components{{#translation:}}|Ico Sphere Mesh]] | ||
[[Category:Components:Assets:Procedural Meshes{{#translation:}}| | [[Category:ComponentStubs]] | ||
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Ico Sphere Mesh]] |
Latest revision as of 21:30, 6 November 2024
Component image
Introduction
The IcoSphereMesh component procedurally generates a icosahedron mesh for use with a MeshRenderer, according to the parameters provided.
Usage
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 | |
OverridenBoundingBox
|
BoundingBox | |
Profile
|
ColorProfile | |
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
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. |
Behavior
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.