Component:CrossMesh: Difference between revisions

From Resonite Wiki
Automated: update 'HighPriorityIntegration' description
Automated: update 'BakeMesh()' description
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=CrossMeshComponent.png
|Image=CrossMeshComponent.png
|Name=Cross Mesh
|Name=Cross Mesh
}}
}}
A cross mesh is a 3D mesh made of 3 crossing boxes of equal thickness and length. It can be rotated, and the bars can be lengthened and thickened/thinned.


<!--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}}
|Size|Float|
|Size|Float| The size of the cross from end to end in local space.
|BarRatio|Float|
|BarRatio|Float| This multiplied by size is how thick each bar is in local space.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Attach to a slot, and assign to a [[Component:MeshRenderer|Mesh Renderer]] to see what it looks like. Don't forget to use a material.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Can be used to mark a point with a rotation like markers for debug testing.
An example of what a default rotated cross mesh looks like
[[File:CrossMesh.png|500px]]


<!--T:5-->
<!--T:5-->
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:Components{{#translation:}}|Cross Mesh]]
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Cross Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Cross Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Cross Mesh]]

Latest revision as of 21:30, 6 November 2024

Component image 
Cross Mesh component as seen in the Scene Inspector

A cross mesh is a 3D mesh made of 3 crossing boxes of equal thickness and length. It can be rotated, and the bars can be lengthened and thickened/thinned.

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.
Size Float The size of the cross from end to end in local space.
BarRatio Float This multiplied by size is how thick each bar is in local space.

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 assign to a Mesh Renderer to see what it looks like. Don't forget to use a material.

Examples

Can be used to mark a point with a rotation like markers for debug testing.

An example of what a default rotated cross mesh looks like

Related Components