Component:AxisMultiViewportPanner: Difference between revisions

From Resonite Wiki
imported>Chemicalcrux
Creating the page (with a bot!)
 
Added a video.
 
(3 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AxisMultiViewportPannerComponent.png
|Image=AxisMultiViewportPannerComponent.png
Line 9: Line 8:


<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''AxisMultiViewportPanner''' component toggles through [[UIX]] element's active state, min and max of the [[Component:RectTransform|RectTransform]]'s anchor. This allows a [[User|user]] to make "pages" in UIX.


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|ViewportIndex|Int|  
|ViewportIndex|Int|The current focused viewport [[UIX]] element.
|AnimationTime|Float|  
|AnimationTime|Float|The time it takes to pan across to get to the selected viewport index.
|Direction|AlignDirection|  
|Direction|'''[[#AlignDirection|AlignDirection]]'''|TypeAdv2=true|The direction this animates to get to the selected viewport index.
|Viewports|Viewport|  
|Viewports|{{RootFieldType|SyncList`1|[[#Viewport|Viewport]]}}|TypeAdv3=true|The list of [[UIX]] element viewports to pan to.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
This is useful if you want to make a slideshow, tab pages for [[UIX]], or anything that you want to have pan across for multiple pages in your design.
 
{{Note|This component does not have the capability of jumping or skipping from on page directly to the next while also using the animation time. It will go through each page one at a time to get to the destination. If you want to have the functionality to jump to a page, you will need to do a bit of math currently.|warning}}


<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
=== Videos ===
[[User:ProbablePrime|ProbablePrime]]'s tutorial video about the AxisMultiViewportPanner:
<youtube>kbASFui7YWk</youtube>


<!--T:6-->
<!--T:6-->
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:Components{{#translation:}}|AxisMultiViewportPanner (Component){{#translation:}}]]
[[Category:Components{{#translation:}}|Axis Multi Viewport Panner]]
[[Category:ComponentStubs]]
[[Category:Components With Nested Enums{{#translation:}}|Axis Multi Viewport Panner]]
[[Category:Components:UIX:Utility{{#translation:}}|AxisMultiViewportPanner (Component){{#translation:}}]]
[[Category:Components With Nested Types{{#translation:}}|Axis Multi Viewport Panner]]
[[Category:Components:UIX:Utility{{#translation:}}|Axis Multi Viewport Panner]]

Latest revision as of 00:47, 29 July 2024

Component image 
AxisMultiViewportPanner component as seen in the Scene Inspector


The AxisMultiViewportPanner component toggles through UIX element's active state, min and max of the RectTransform's anchor. This allows a user to make "pages" in UIX.

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.
ViewportIndex Int The current focused viewport UIX element.
AnimationTime Float The time it takes to pan across to get to the selected viewport index.
Direction AlignDirection The direction this animates to get to the selected viewport index.
Viewports list of Viewport The list of UIX element viewports to pan to.

Usage

This is useful if you want to make a slideshow, tab pages for UIX, or anything that you want to have pan across for multiple pages in your design.

This component does not have the capability of jumping or skipping from on page directly to the next while also using the animation time. It will go through each page one at a time to get to the destination. If you want to have the functionality to jump to a page, you will need to do a bit of math currently.

Examples

Videos

ProbablePrime's tutorial video about the AxisMultiViewportPanner:

Related Components