Component:TorusMesh: Difference between revisions

From Resonite Wiki
Automated: update DeDuplicate
Add info
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=TorusMeshComponent.png
|Image=TorusMeshComponent.png
|Name=Torus Mesh
|Name=Torus Mesh
}}
}}
The '''TorusMesh''' component generates procedural geometry that is used with [[Component:MeshRenderer]].
This mesh resembles a Donut.


<!--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}}
|MinorSegments|Int|
|MinorSegments|Int| The amount of detail/cuts along the circle of the torus. Making this 4 will make the torus a square instead of a circle shape.
|MajorSegments|Int|
|MajorSegments|Int| The amount of detail/cuts going around and through the center along the outside and inside.
|MajorRadius|Float|
|MajorRadius|Float| The size of the torus
|MinorRadius|Float|
|MinorRadius|Float| the fatness/thickness of the torus. If this is too big than the hole in the center will seal up.
|UVScale|Float2|
|UVScale|Float2| the scale of the material detail on the surface of the torus.
}}
}}


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


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Attach to a slot and insert this component into a [[Component:MeshRenderer]] to view its geometry. Don't forget to add a [[Material]]


<!--T:4-->
<!--T:4-->
Line 34: Line 37:


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>


[[Category:Components{{#translation:}}|Torus Mesh]]
[[Category:Components{{#translation:}}|Torus Mesh]]
[[Category:ComponentStubs]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Torus Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Torus Mesh]]

Latest revision as of 21:09, 10 November 2024

Component image 
Torus Mesh component as seen in the Scene Inspector

The TorusMesh component generates procedural geometry that is used with Component:MeshRenderer.

This mesh resembles a Donut.

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.
MinorSegments Int The amount of detail/cuts along the circle of the torus. Making this 4 will make the torus a square instead of a circle shape.
MajorSegments Int The amount of detail/cuts going around and through the center along the outside and inside.
MajorRadius Float The size of the torus
MinorRadius Float the fatness/thickness of the torus. If this is too big than the hole in the center will seal up.
UVScale Float2 the scale of the material detail on the surface of the torus.

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

Attach to a slot and insert this component into a Component:MeshRenderer to view its geometry. Don't forget to add a Material

Examples

See Also