Component:TriangleDiagnosticMesh: Difference between revisions

From Resonite Wiki
Automated: update 'HighPriorityIntegration' description
debug
 
(6 intermediate revisions by the same user not shown)
Line 3: Line 3:
|Name=Triangle Diagnostic Mesh
|Name=Triangle Diagnostic Mesh
}}
}}
{{stub}}
The '''TriangleDiagnosticMeshes''' component is used to show where a triangle is in the world. This is usually used as a debug tool.


== Usage ==
{{Template:Debug}}
 
== 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}}
|TriangleIndex|Int|
|TriangleIndex|Int| The index of the triangle on the mesh to make a diagnostic for.
|Vertex0Color|Color|
|Vertex0Color|Color| The vertex color of vertex 0 for this diagnostic mesh.
|Vertex1Color|Color|
|Vertex1Color|Color| The vertex color of vertex 1 for this diagnostic mesh.
|Vertex2Color|Color|
|Vertex2Color|Color| The vertex color of vertex 2 for this diagnostic mesh.
|VertexColorProfile|ColorProfile|
|VertexColorProfile|ColorProfile| The color profile of the input [[Type:Color|Colors]] of <code>Vertex0Color</code>, <code>Vertex1Color</code>, and <code>Vertex2Color</code>.
|Displace|Float|
|Displace|Float| How much to displace the triangle's position by it's normal (front face direction)
|Mesh|{{RootFieldType|AssetRef`1|[[Type:Mesh|Mesh]]}}|TypeAdv10=true|
|Mesh|{{RootFieldType|AssetRef`1|[[Type:Mesh|Mesh]]}}|TypeAdv10=true| The mesh to make a diagnostic for.
}}
}}


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


== Examples ==
== Examples ==
This component is usually generated by [[ProtoFlux:Raycast One|ProtoFlux Raycast One Nodes]] whenever their debug mode is enabled.


== See Also ==
== See Also ==
Line 28: Line 36:
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Triangle Diagnostic Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Triangle Diagnostic Mesh]]
[[Category:Components{{#translation:}}|Triangle Diagnostic Mesh]]
[[Category:Components{{#translation:}}|Triangle Diagnostic Mesh]]
[[Category:ComponentStubs]]

Latest revision as of 02:12, 15 February 2025

Component image 
Triangle Diagnostic Mesh component as seen in the Scene Inspector

The TriangleDiagnosticMeshes component is used to show where a triangle is in the world. This is usually used as a debug tool.

This game element is a debug item. Elements like this may be removed at any time without warning, and creations should not rely on it.

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. Some components stop their functionality when this field is disabled, but some don't.
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.
TriangleIndex Int The index of the triangle on the mesh to make a diagnostic for.
Vertex0Color Color The vertex color of vertex 0 for this diagnostic mesh.
Vertex1Color Color The vertex color of vertex 1 for this diagnostic mesh.
Vertex2Color Color The vertex color of vertex 2 for this diagnostic mesh.
VertexColorProfile ColorProfile The color profile of the input Colors of Vertex0Color, Vertex1Color, and Vertex2Color.
Displace Float How much to displace the triangle's position by it's normal (front face direction)
Mesh Mesh The mesh to make a diagnostic for.

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

Examples

This component is usually generated by ProtoFlux Raycast One Nodes whenever their debug mode is enabled.

See Also