Component:BoxArrayMesh: Difference between revisions

From Resonite Wiki
Automated: update component fields
Add info
 
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=BoxArrayMeshComponent.png
|Image=BoxArrayMeshComponent.png
|Name=Box Array Mesh
|Name=Box Array Mesh
}}
}}
Box Array Mesh is a component that is generated by brush tools and can be a cloud of boxes with points, sizes, and rotations.
Note: <code>Points</code>, <code>Sizes</code>, <code>Rotations</code>, <code>Colors</code>, and <code>UV_Scales</code> arrays must be the same length for this component to work.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|
|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|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv4=true|
|Points|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv4=true| List of positions that there should be boxes
|Sizes|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv5=true|
|Sizes|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv5=true| List of sizes for each box.
|Rotations|{{RootFieldType|SyncArray`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv6=true|
|Rotations|{{RootFieldType|SyncArray`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv6=true| List of rotations for each box.
|Colors|{{RootFieldType|SyncArray`1|[[Type:Color|Color]]}}|TypeAdv7=true|
|Colors|{{RootFieldType|SyncArray`1|[[Type:Color|Color]]}}|TypeAdv7=true| List of colors for each box.
|ColorsProfile|ColorProfile|
|ColorsProfile|ColorProfile| {{Template:ProceduralMeshColorProfile}}. However, this is for every box in the array.
|UV_Scales|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv9=true|
|UV_Scales|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv9=true| List of UV scales for each box, scaling the material surface detail bigger or smaller.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Use a brush tool from <code>ResoniteEssentials/Tools/Brushes/Box Brushes</code> and draw to make one of these with values already initialized.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
An example of the result of a box array mesh generated by a brush tool.
[[File:BoxArrayMesh_Example.png|500px]]


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

Latest revision as of 15:42, 6 November 2024

Component image 
Box Array Mesh component as seen in the Scene Inspector

Box Array Mesh is a component that is generated by brush tools and can be a cloud of boxes with points, sizes, and rotations.

Note: Points, Sizes, Rotations, Colors, and UV_Scales arrays must be the same length for this component to work.

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 array of Float3 List of positions that there should be boxes
Sizes array of Float3 List of sizes for each box.
Rotations array of FloatQ List of rotations for each box.
Colors array of Color List of colors for each box.
ColorsProfile ColorProfile The profile that the vertex colors for this mesh should be displayed in.. However, this is for every box in the array.
UV_Scales array of Float3 List of UV scales for each box, scaling the material surface detail bigger or smaller.

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

Use a brush tool from ResoniteEssentials/Tools/Brushes/Box Brushes and draw to make one of these with values already initialized.

Examples

An example of the result of a box array mesh generated by a brush tool.

Related Components