Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/macacagames/macacaviewsystem
ViewSystem is a element based UI management system based on Unity GUI
https://github.com/macacagames/macacaviewsystem
gui ugui unity unity-editor unity-gui unity3d
Last synced: about 1 month ago
JSON representation
ViewSystem is a element based UI management system based on Unity GUI
- Host: GitHub
- URL: https://github.com/macacagames/macacaviewsystem
- Owner: MacacaGames
- Created: 2020-02-05T14:13:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T08:39:21.000Z (6 months ago)
- Last Synced: 2024-05-22T14:01:27.986Z (6 months ago)
- Topics: gui, ugui, unity, unity-editor, unity-gui, unity3d
- Language: HTML
- Homepage:
- Size: 204 MB
- Stars: 70
- Watchers: 10
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Use case
## Introduction
**ViewSystem** is a element based UI management system based on Unity GUI. It is developed and used by Macaca Games.
UI management in Unity3D is always a hard work, the goal of **ViewSystem** is to make UI management more easier and flexable.
### Feature
- Element based UI manager system
- UI Element pooling system
- Property and Event override in runtime
- Node based editor
## How It Works
### ViewElement
ViewElement is the base unit in ViewSystem, any item shows on an UI page can be a ViewElement, such as a button, a icon or anything else.
For example, the red square part in the screenshot is a ViewElement.
And the most important thing, ViewElement only focus how it will show or leave and **doesn't** care where it will be placed.
Currently, there are 5 methods to show or leave a ViewElement: `Animator`, `Canvas Group Alpha`, `Active Switch`, `ViewElement Animation`, `Custom`. For more details, check [ViewElement Transition](/docs/Fundamentals.md#viewelement-trasition).
### ViewPage
ViewPage compose with one or more ViewElements and define where the ViewElements should be placed. Base on it's default behaviour there is two kind of ViewPage : FullPage, OverlayPage.
- FullPage
The basic type of ViewPage, the system only allow one FullPage shows on the screen at the same time.
When the ChangePage action is fire, system will leave all ViewElements defined in last FullPage and then show the ViewElements defined in next FullPage.
- OverlayPage
Sometimes we may wants an UI page shows and covered current screen, the OverlayPage can helps to implement the feature.
This is very useful when making Dialog, LoadingView ect.
OverlayPage allow to shows more than one page in the same time, each OverlayPage maintain it's own lifecycle.
> Currently, different OverlayPage can be show in the same time, but the same OverlayPage still has only one instance the duplicate call to shows an OverlayPage which is already on the screen is not allowed and the call will be ignore, but if you wish to replay the show animation in the ViewElement you can set the parameter **ReShowWhileSamePage** to True while calling the ShowOverlayPage API.
### ViewState
ViewState is similar as ViewPage, ViewState can define the duplicate part in two or more ViewPage.
Each ViewPage can setup at most one ViewState.
And also the ViewElements define in ViewState will not be update until the ViewState is changed.
### ViewController
ViewController is the core component of ViewSystem, all control of the UI is base on this component.
## Links
### [Document](https://macacagames.github.io/MacacaViewSystemDocs/).
### [Demo Unity project](https://github.com/MacacaGames/ViewSystemExample)
### [Script API](https://macacagames.github.io/MacacaViewSystem/api/MacacaGames.ViewSystem.html)