Component:CurvedPlaneMesh: Difference between revisions

From Resonite Wiki
Automated: update component fields
oops forgot one
 
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=CurvedPlaneMeshComponent.png
|Image=CurvedPlaneMeshComponent.png
|Name=Curved Plane Mesh
|Name=Curved Plane Mesh
}}
}}
Generates a plane mesh that is curved vertically. A picture in this page of it can be seen.


<!--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}}
|Size|Float2|
|Size|Float2| How big the curve plane mesh is, mostly a ratio
|Curvature|Float|
|Curvature|Float| How much to bend the curve plane mesh by
|TiltAngle|Float|
|TiltAngle|Float| How much to "rotate" the curve plane mesh length wise.
|AspectRatioCompensation|CurvatureAspectRatioCompensation|
|AspectRatioCompensation|'''[[#CurvatureAspectRatioCompensation|CurvatureAspectRatioCompensation]]'''|TypeAdv7=true| How to compensate for stretching due to curving the plane mesh backwards.
|UVScale|Float2|
|UVScale|Float2| The inverse of the size the material should appear on the surface as.
|UVOffset|Float2|
|UVOffset|Float2| Shift the visual detail of the material around.
|Segments|Int|
|Segments|Int| How many bends/angles the plane should have in it's curve
|FlatShading|Bool|
|FlatShading|Bool| Turn off smooth shading
}}
}}


Line 30: Line 30:
<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
The curve plane mesh is most notably used for the curvature of the VR [[Dash Menu]].
What a curved plane mesh looks like.
[[File:CurvedPlaneMesh.png|500px]]


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

Latest revision as of 23:23, 15 October 2024

Component image 
Curved Plane Mesh component as seen in the Scene Inspector

Generates a plane mesh that is curved vertically. A picture in this page of it can be seen.

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 Float2 How big the curve plane mesh is, mostly a ratio
Curvature Float How much to bend the curve plane mesh by
TiltAngle Float How much to "rotate" the curve plane mesh length wise.
AspectRatioCompensation CurvatureAspectRatioCompensation How to compensate for stretching due to curving the plane mesh backwards.
UVScale Float2 The inverse of the size the material should appear on the surface as.
UVOffset Float2 Shift the visual detail of the material around.
Segments Int How many bends/angles the plane should have in it's curve
FlatShading Bool Turn off smooth shading

Usage

Examples

The curve plane mesh is most notably used for the curvature of the VR Dash Menu.

What a curved plane mesh looks like.

Related Components