Component:CircleSegmentShaderMesh: Difference between revisions

From Resonite Wiki
add info
correct my sins.
 
Line 3: Line 3:
|Name=Circle Segment Shader Mesh
|Name=Circle Segment Shader Mesh
}}
}}
The '''CircleSegmentShaderMesh''' creates a single quad that covers the bounding box area of a flat torus circle defined by the given values.
The '''CircleSegmentShaderMesh''' creates a single quad that covers the bounding box area of a flat torus circle defined by the given values. This is used to render the [[Component:UI_CircleSegment]] material.
 
Note: The behavior of this mesh is inherently strange, as many of it's fields are UN-intuitive.
 
For example, the first or default UV map for each vertex is assigned to the position of the vertex in local space. The second UV map for every vertex regardless of position is assigned to (<code>AngleStart</code>, <code>ArcAngle</code>) and then converted from degrees to radians. The third UV map for every vertex regardless of position is assigned to (<code>RadiusStart</code>, <code>RadiusEnd</code>). Finally the fourth UV map for every vertex regardless of position is assigned to (<code>BorderSize</code>, <code>RoundedCornerRadius</code>)


== Fields ==
== Fields ==
Line 20: Line 16:
|ArcLength|Float| The amount of degrees of the circle arch
|ArcLength|Float| The amount of degrees of the circle arch
|FillColor|ColorX| Used to color the vertices of the mesh (vertex colors)
|FillColor|ColorX| Used to color the vertices of the mesh (vertex colors)
|BorderColor|ColorX| Assigned to every vertex's XYZW tangents (yes that is what it does)
|BorderColor|ColorX| The border color the [[Component:UI_CircleSegment]] rendering on this mesh.
|BorderSize|Float| Assigned as the X value on the 4th uv map of every vertex regardless of position (yes that is what it does)
|BorderSize|Float| The border thickness of the [[Component:UI_CircleSegment]] rendering on this mesh.
|RoundedCornerRadius|Float| Assigned as the Y value on the 4th uv map of every vertex regardless of position (yes that is what it does)
|RoundedCornerRadius|Float| The radius of the corner rounding of the [[Component:UI_CircleSegment]] rendering on this mesh.
}}
}}


Line 31: Line 27:


== Usage ==
== Usage ==
Used as a mesh to render the [[Component:UI_CircleSegment]] material.


== Examples ==
== Examples ==


== See Also ==
== See Also ==
* [[Component:UI_CircleSegment]]


[[Category:Components{{#translation:}}|Circle Segment Shader Mesh]]
[[Category:Components{{#translation:}}|Circle Segment Shader Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Circle Segment Shader Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Circle Segment Shader Mesh]]

Latest revision as of 02:42, 3 January 2025

Component image 
Circle Segment Shader Mesh component as seen in the Scene Inspector

The CircleSegmentShaderMesh creates a single quad that covers the bounding box area of a flat torus circle defined by the given values. This is used to render the Component:UI_CircleSegment material.

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.
RadiusStart Float The inner radius of the circle
Thickness Float How thick the circle is outwards from the inner radius
AngleStart Float What angle the circle starts at in degrees
ArcLength Float The amount of degrees of the circle arch
FillColor ColorX Used to color the vertices of the mesh (vertex colors)
BorderColor ColorX The border color the Component:UI_CircleSegment rendering on this mesh.
BorderSize Float The border thickness of the Component:UI_CircleSegment rendering on this mesh.
RoundedCornerRadius Float The radius of the corner rounding of the Component:UI_CircleSegment rendering on this mesh.

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

Used as a mesh to render the Component:UI_CircleSegment material.

Examples

See Also