Component:LegacyPanel: Difference between revisions

From Resonite Wiki
← Older edit
Visual
Automated: Added {{Legacy}}
userspace
 
(4 intermediate revisions by one other user not shown)
Line 3: Line 3:
|Name=Legacy Panel
|Name=Legacy Panel
}}
}}
{{stub}}


== Usage ==
The '''LegacyPanel''' component is used in old migrated legacy content UI.
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Style|{{RootFieldType|RelayRef`1|[[Component:LegacyUIStyle|LegacyUIStyle]]}}|TypeAdv0=true|
|Style|{{RootFieldType|RelayRef`1|[[Component:LegacyUIStyle|LegacyUIStyle]]}}|TypeAdv0=true| The style that determines what this panel looks like.
|AcceptPhysicalTouch|Bool|
|AcceptPhysicalTouch|Bool| {{Template:Touchable_AcceptPhysicalTouch}}
|AcceptRemoteTouch|Bool|
|AcceptRemoteTouch|Bool| {{Template:Touchable_AcceptRemoteTouch}}
|ShowHeader|Bool|
|ShowHeader|Bool| Whether to show the panel title.
|ShowHandle|Bool|
|ShowHandle|Bool| Whether to show the panel side bar bevel mesh.
|Padding|Float|
|Padding|Float| How much padding should be used from the edge to the inner content.
|ZPadding|Float|
|ZPadding|Float| How much the UI elements should float above the backing plate.
|Thickness|Float|
|Thickness|Float| The thickness of the beveled panel mesh.
|WhiteList|{{RootFieldType|SyncRefList`1|[[Type:IBounded|IBounded]]}}|TypeAdv8=true|
|WhiteList|{{RootFieldType|SyncRefList`1|[[Type:IBounded|IBounded]]}}|TypeAdv8=true| Elements that should not be used in the bounds calculations.
|BlackList|{{RootFieldType|SyncRefList`1|[[Type:IBounded|IBounded]]}}|TypeAdv9=true|
|BlackList|{{RootFieldType|SyncRefList`1|[[Type:IBounded|IBounded]]}}|TypeAdv9=true| Elements that should be used in the bounds calculations.
|Color|ColorX|
|Color|ColorX| The color of the panel.
|_material|{{RootFieldType|DriveRef`1|[[PBS_RimMetallic|PBS_RimMetallic]]}}|TypeAdv11=true|
|_material|{{RootFieldType|DriveRef`1|[[PBS_RimMetallic|PBS_RimMetallic]]}}|TypeAdv11=true| The material being used for this panel.
|_panelMesh|{{RootFieldType|DriveRef`1|[[Component:BevelPlaneMesh|BevelPlaneMesh]]}}|TypeAdv12=true|
|_panelMesh|{{RootFieldType|DriveRef`1|[[Component:BevelPlaneMesh|BevelPlaneMesh]]}}|TypeAdv12=true| The mesh being used for this panel.
|_panelPos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv13=true|
|_panelPos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv13=true| The position field of this panel.
|_handleActive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv14=true|
|_handleActive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv14=true| The handle active field of this panel.
|_headerActive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv15=true|
|_headerActive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv15=true| The header active field of this panel.
|_handleMesh|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv16=true|
|_handleMesh|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv16=true| The handle mesh of this panel.
|_handlePos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv17=true|
|_handlePos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv17=true| The handle position of this panel.
|_handleColliderSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv18=true|
|_handleColliderSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv18=true| The handle collider size of this panel.
|_headerTitleMesh|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv19=true|
|_headerTitleMesh|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv19=true| The title mesh of this panel.
|_headerButtonMesh|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv20=true|
|_headerButtonMesh|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv20=true| The header button mesh of this panel.
|_headerCollider|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv21=true|
|_headerCollider|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv21=true| The header collider of this panel.
|_headerPos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv22=true|
|_headerPos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv22=true| The header position field of this panel.
|_headerTitlePos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv23=true|
|_headerTitlePos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv23=true| The header title position of this panel.
|_title|String|
|_title|String| The title name of this panel.
|_titleText|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv25=true|
|_titleText|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv25=true| The text renderer that displays the title of this panel.
|_indicatePrivate|Bool|
|_indicatePrivate|Bool| Is used to change the colors of the panel to indicate that it is in [[userspace]].
|_titlePos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv27=true|
|_titlePos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv27=true| The position field of the title of this panel
|_titleBounds|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv28=true|
|_titleBounds|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv28=true| The bounds of the title of this panel.
|_contentSlot|Slot|
|_contentSlot|Slot| The content root slot of this panel.
|_headerRoot|Slot|
|_headerRoot|Slot| The header root slot of this panel.
|_handleAnchorPoint|Slot|
|_handleAnchorPoint|Slot| The side bar handle mesh's anchor point for this panel.
|_handleAnchorPointPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv32=true|
|_handleAnchorPointPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv32=true| The handle position field of this panel.
|_userspaceOwner|{{RootFieldType|UserRef}}|TypeAdv33=true|
|_userspaceOwner|{{RootFieldType|UserRef}}|TypeAdv33=true| The owner of this panel.
|_titleButtons|{{RootFieldType|SyncList`1|[[#TitleButton|LegacyPanel.TitleButton]]}}|TypeAdv34=true|
|_titleButtons|{{RootFieldType|SyncList`1|[[#TitleButton|LegacyPanel.TitleButton]]}}|TypeAdv34=true| The list of buttons that make up the panel's title.
|_highlightedButton|'''[[#TitleButton|LegacyPanel.TitleButton]]'''|TypeAdv35=true|
|_highlightedButton|'''[[#TitleButton|LegacyPanel.TitleButton]]'''|TypeAdv35=true| The title button object for the currently highlighted button.
|_pinButton|'''[[#TitleButton|LegacyPanel.TitleButton]]'''|TypeAdv36=true|
|_pinButton|'''[[#TitleButton|LegacyPanel.TitleButton]]'''|TypeAdv36=true| The title button object for the pin to user button.
|CloseOverride|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]<[[Component:LegacyPanel|LegacyPanel]]>}}|TypeAdv37=true|
|CloseOverride|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]<[[Component:LegacyPanel|LegacyPanel]]>}}|TypeAdv37=true| A sync delegate that takes a [[Component:LegacyPanel|LegacyPanel]] that overrides the handling of closing this panel.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|HeaderButtonTouched:[[Type:TouchEvent|TouchEvent]]|[[Type:TouchEvent|TouchEvent]]|true|
|HeaderButtonTouched:[[Type:TouchEvent|TouchEvent]]|[[Type:TouchEvent|TouchEvent]]|true| Called when the header button is touched.
|OnClose:[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|true|
|OnClose:[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|true| Called when the panel is closed.
|OnHide:[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|true|
|OnHide:[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|true| Called when the panel is hidden by the user.
|OnParent:[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|true|
|OnParent:[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|true| Called when the panel is pinned to the user via the pin button.
|OnUserspaceTransfer:[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|true|
|OnUserspaceTransfer:[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|[[Type:Action`1|Action`1]]<[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]>|true| Called when the panel is transfered from [[userspace]] to the currently focused world.
}}
}}


== Behavior ==
== TitleButton ==
{{Table TypeFields
|ItemColor|ColorX| The color of the button item
|Pressed|{{RootFieldType|SyncDelegate`1|[[Component:LegacyPanel#TitleButton|LegacyPanel.TitleButton]]}}|TypeAdv1=true| The sync delegate to call when this button is pressed.
|Enabled|bool| Whether the button is enabled.
|_material|{{RootFieldType|DriveRef`1|[[Component:PBS_RimMetallic|PBS_RimMetallic]]}}|TypeAdv3=true| The material of the button.
|_iconMaterial|'''[[Component:UnlitMaterial|UnlitMaterial]]'''|TypeAdv4=true| The icon's material for the button.
|_iconTexture|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv5=true| The icon's texture for the button.
|_lastPress|SyncTime| The last time the button was pressed.
|_itemRoot|{{RootFieldType|CleanupRef`1|[[Type:Slot|Slot]]}}|TypeAdv7=true| The button's root hierarchy.
|_position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv8=true| The position field of the button.
|_colliderSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv9=true| The collider size field of the button.
|_iconSize|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv10=true| The icon size field of the button.
|_iconOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv11=true| The icon offset field of the button.
}}
 
== Usage ==
Don't use in new content.


== Examples ==
== Examples ==
Found in migrated legacy content.


== See Also ==
== See Also ==
Line 65: Line 84:
[[Category:Components{{#translation:}}|Legacy Panel]]
[[Category:Components{{#translation:}}|Legacy Panel]]
[[Category:Components With Nested Types{{#translation:}}|Legacy Panel]]
[[Category:Components With Nested Types{{#translation:}}|Legacy Panel]]
[[Category:ComponentStubs]]

Latest revision as of 18:30, 14 April 2025

This article describes a feature marked as legacy—this usually means there's a newer, better alternative. Legacy features might not be removed but they will not be updated, and the team will not provide any support for them.
Component image 
Legacy Panel component as seen in the Scene Inspector


The LegacyPanel component is used in old migrated legacy content UI.

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.
Style direct RelayRef`1<LegacyUIStyle> The style that determines what this panel looks like.
AcceptPhysicalTouch Bool Whether to allow Component:TipTouchSources to interact with/activate this component.
AcceptRemoteTouch Bool Whether this component allows interaction via the user's interaction laser.
ShowHeader Bool Whether to show the panel title.
ShowHandle Bool Whether to show the panel side bar bevel mesh.
Padding Float How much padding should be used from the edge to the inner content.
ZPadding Float How much the UI elements should float above the backing plate.
Thickness Float The thickness of the beveled panel mesh.
WhiteList list of IBounded Elements that should not be used in the bounds calculations.
BlackList list of IBounded Elements that should be used in the bounds calculations.
Color ColorX The color of the panel.
_material reference drive of PBS_RimMetallic The material being used for this panel.
_panelMesh reference drive of BevelPlaneMesh The mesh being used for this panel.
_panelPos field drive of Float3 The position field of this panel.
_handleActive field drive of Bool The handle active field of this panel.
_headerActive field drive of Bool The header active field of this panel.
_handleMesh reference drive of BevelStripeMesh The handle mesh of this panel.
_handlePos field drive of Float3 The handle position of this panel.
_handleColliderSize field drive of Float3 The handle collider size of this panel.
_headerTitleMesh reference drive of BevelStripeMesh The title mesh of this panel.
_headerButtonMesh reference drive of BevelStripeMesh The header button mesh of this panel.
_headerCollider field drive of Float3 The header collider of this panel.
_headerPos field drive of Float3 The header position field of this panel.
_headerTitlePos field drive of Float3 The header title position of this panel.
_title String The title name of this panel.
_titleText TextRenderer The text renderer that displays the title of this panel.
_indicatePrivate Bool Is used to change the colors of the panel to indicate that it is in userspace.
_titlePos field drive of Float3 The position field of the title of this panel
_titleBounds field drive of Float2 The bounds of the title of this panel.
_contentSlot Slot The content root slot of this panel.
_headerRoot Slot The header root slot of this panel.
_handleAnchorPoint Slot The side bar handle mesh's anchor point for this panel.
_handleAnchorPointPosition field drive of Float3 The handle position field of this panel.
_userspaceOwner direct UserRef The owner of this panel.
_titleButtons list of LegacyPanel.TitleButton The list of buttons that make up the panel's title.
_highlightedButton LegacyPanel.TitleButton The title button object for the currently highlighted button.
_pinButton LegacyPanel.TitleButton The title button object for the pin to user button.
CloseOverride delegate of identity Action`1<LegacyPanel> A sync delegate that takes a LegacyPanel that overrides the handling of closing this panel.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
HeaderButtonTouched:TouchEvent TouchEvent ✓ Called when the header button is touched.
OnClose:Action`1<LegacyPanel.TitleButton> Action`1<LegacyPanel.TitleButton> ✓ Called when the panel is closed.
OnHide:Action`1<LegacyPanel.TitleButton> Action`1<LegacyPanel.TitleButton> ✓ Called when the panel is hidden by the user.
OnParent:Action`1<LegacyPanel.TitleButton> Action`1<LegacyPanel.TitleButton> ✓ Called when the panel is pinned to the user via the pin button.
OnUserspaceTransfer:Action`1<LegacyPanel.TitleButton> Action`1<LegacyPanel.TitleButton> ✓ Called when the panel is transfered from userspace to the currently focused world.

TitleButton

Fields
Name Type Description
ItemColor ColorX The color of the button item
Pressed delegate of identity LegacyPanel.TitleButton The sync delegate to call when this button is pressed.
Enabled bool Whether the button is enabled.
_material reference drive of PBS_RimMetallic The material of the button.
_iconMaterial UnlitMaterial The icon's material for the button.
_iconTexture StaticTexture2D The icon's texture for the button.
_lastPress SyncTime The last time the button was pressed.
_itemRoot direct CleanupRef`1<Slot> The button's root hierarchy.
_position field drive of Float3 The position field of the button.
_colliderSize field drive of Float3 The collider size field of the button.
_iconSize field drive of Float2 The icon size field of the button.
_iconOffset field drive of Float3 The icon offset field of the button.

Usage

Don't use in new content.

Examples

Found in migrated legacy content.

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:LegacyPanel&oldid=100032"