Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coryleach/UnityGUI
UGUI Panel Systems for navigation, animation and more
https://github.com/coryleach/UnityGUI
effects gui package panel panelview stack transitions ugui ui unity unity3d
Last synced: 2 months ago
JSON representation
UGUI Panel Systems for navigation, animation and more
- Host: GitHub
- URL: https://github.com/coryleach/UnityGUI
- Owner: coryleach
- License: apache-2.0
- Created: 2019-10-27T22:12:50.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-09-20T06:51:33.000Z (over 1 year ago)
- Last Synced: 2024-11-09T18:03:30.378Z (2 months ago)
- Topics: effects, gui, package, panel, panelview, stack, transitions, ugui, ui, unity, unity3d
- Language: C#
- Homepage:
- Size: 660 KB
- Stars: 233
- Watchers: 9
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Gameframe.GUI 👋
This is a library of GUI helpers for UGUI
Includes a panel system that implements a navigation stack.
Includes a scene transition system.
Includes a SRP shader for blurring the background of UI panels.
## Quick Package Install
#### Using UnityPackageManager (for Unity 2019.3 or later)
Open the package manager window (menu: Window > Package Manager)
Select "Add package from git URL...", fill in the pop-up with the following link:
https://github.com/coryleach/UnityGUI.git#3.0.12
#### Using UnityPackageManager (for Unity 2019.1 or later)
Find the manifest.json file in the Packages folder of your project and edit it to look like this:
```js
{
"dependencies": {
"com.gameframe.gui": "https://github.com/coryleach/UnityGUI.git#3.0.12",
...
},
}
```
## Usage
After importing this package via the PackageManager import the Demo/Demo.unitypackage file from the Assets->Import Package option in the menu.
### PanelView
PanelView which provides Show & Hide behavior which can be instant or async and awaitable.
### AnimatedPanelView
References one or more IPanelAnimator components to control animate the Show & Hide of a panel. If you await the Show & Hide async methods
### PanelViewController
Controller for the display of a PanelView.
### PanelViewControllerBehaviour
A version of PanelViewController that is also a MonoBehaviour component that can be added to a game object.
Often you may want to set up & configure PanelViewControllers with data other than the panel type and using this class will allow you to do that in editor.
### PanelStackSystem
A scriptable object representation of a panel stack. Main purpose is in maintaining the navigation history of a menu. Push and Pop panel controllers onto this stack. If any PanelViewStackController component that subscribes to the PanelStackSystem will respond to the push and show/hide the corresponding panels. Generally the top PanelViewController on the stack is always visible.
### PanelViewStackController
A MonoBehaviour that references a PanelStackSystem. It responds to changes in the panel stack by getting the current showing and hiding controllers. It will then perform the necessary transitions.
### PanelViewControllerProvider
A scriptable object which services is a collection of PanelViewControllers. Generally you register PanelViewControllerBehaviour with a provider so that you can push them using the PanelPusher component. It also controls the location that views are parented to in the hierarchy.
### PanelViewControllerRegisterer
Add this component to a PanelViewControllerBehaviour to register the controller with a PanelViewControllerProvider instance.
### PanelType
Contains information about a panel and is used by the PanelViewController to locate the prefab and instantiate the PanelView.
## Author
👤 **Cory Leach**
* Twitter: [@coryleach](https://twitter.com/coryleach)
* Github: [@coryleach](https://github.com/coryleach)
## Show your support
Give a ⭐️ if this project helped you!
***
_This README was generated with ❤️ by [Gameframe.Packages](https://github.com/coryleach/unitypackages)_