4 | 
5 | 
6 |
7 | ## Introduction
8 | **ViewSystem** is a element based UI management system based on Unity GUI. It is developed and used by Macaca Games.
9 | UI management in Unity3D is always a hard work, the goal of **ViewSystem** is to make UI management more easier and flexable.
10 |
11 | ### Feature
12 | - Element based UI manager system
13 | - UI Element pooling system
14 | - Property and Event override in runtime
15 | - Node based editor
16 |
17 | ## How It Works
18 | ### ViewElement
19 | 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.
20 |
21 | For example, the red square part in the screenshot is a ViewElement.22 |
23 |
24 |
25 | And the most important thing, ViewElement only focus how it will show or leave and **doesn't** care where it will be placed.
26 |
27 | 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).
28 |
29 |
30 | ### ViewPage
31 | 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.
32 |
33 | - FullPage
34 |
35 | The basic type of ViewPage, the system only allow one FullPage shows on the screen at the same time.
36 | When the ChangePage action is fire, system will leave all ViewElements defined in last FullPage and then show the ViewElements defined in next FullPage.
37 |
38 | - OverlayPage
39 |
40 | Sometimes we may wants an UI page shows and covered current screen, the OverlayPage can helps to implement the feature.
41 | This is very useful when making Dialog, LoadingView ect.
42 |
43 | OverlayPage allow to shows more than one page in the same time, each OverlayPage maintain it's own lifecycle.
44 |
45 | > 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.
46 |
47 | ### ViewState
48 | ViewState is similar as ViewPage, ViewState can define the duplicate part in two or more ViewPage.
49 |
50 | Each ViewPage can setup at most one ViewState.
51 |
52 | And also the ViewElements define in ViewState will not be update until the ViewState is changed.
53 |
54 | ### ViewController
55 | ViewController is the core component of ViewSystem, all control of the UI is base on this component.
56 |
57 | 58 | 59 | 60 | 61 | ## Links 62 | 63 | ### [Document](https://macacagames.github.io/MacacaViewSystemDocs/). 64 | 65 | ### [Demo Unity project](https://github.com/MacacaGames/ViewSystemExample) 66 | 67 | ### [Script API](https://macacagames.github.io/MacacaViewSystem/api/MacacaGames.ViewSystem.html) 68 | -------------------------------------------------------------------------------- /README.md.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 533a2571d823b48e091ee4162aa11720 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /Runtime.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 230d1b7c9ab2142b4b5c18b466682515 3 | folderAsset: yes 4 | DefaultImporter: 5 | externalObjects: {} 6 | userData: 7 | assetBundleName: 8 | assetBundleVariant: 9 | -------------------------------------------------------------------------------- /Runtime/Attribute.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 7a565da42aa1148c6923605807501ae4 3 | folderAsset: yes 4 | DefaultImporter: 5 | externalObjects: {} 6 | userData: 7 | assetBundleName: 8 | assetBundleVariant: 9 | -------------------------------------------------------------------------------- /Runtime/Attribute/AutoOverrideAttribute.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: f8f047df44cca4bb782afd02de0632a8 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Runtime/Attribute/ViewSystemAttribute.cs: -------------------------------------------------------------------------------- 1 | using UnityEngine; 2 | #if UNITY_EDITOR 3 | using UnityEditor; 4 | #endif 5 | 6 | namespace MacacaGames.ViewSystem 7 | { 8 | public class ReadOnlyAttribute : PropertyAttribute { } 9 | #if UNITY_EDITOR 10 | [CustomPropertyDrawer(typeof(ReadOnlyAttribute))] 11 | public class ReadOnlyDrawer : PropertyDrawer 12 | { 13 | public override void OnGUI(Rect position, SerializedProperty property, GUIContent label) 14 | { 15 | GUI.enabled = false; 16 | EditorGUI.PropertyField(position, property, label, true); 17 | GUI.enabled = true; 18 | } 19 | 20 | public override float GetPropertyHeight(SerializedProperty property, GUIContent label) 21 | { 22 | return EditorGUI.GetPropertyHeight(property, label, true); 23 | } 24 | } 25 | #endif 26 | [System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple = true)] 27 | [System.Obsolete("ViewEventGroup is change to ViewSystemEvent", true)] 28 | public class ViewEventGroup : System.Attribute 29 | { 30 | string groupName; 31 | public ViewEventGroup(string groupName) 32 | { 33 | this.groupName = groupName; 34 | } 35 | 36 | public string GetGroupName() 37 | { 38 | return groupName; 39 | } 40 | } 41 | 42 | [System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple = true)] 43 | public class ViewSystemEventAttribute : System.Attribute 44 | { 45 | string groupName; 46 | public ViewSystemEventAttribute() 47 | { 48 | this.groupName = "Default"; 49 | } 50 | public ViewSystemEventAttribute(string groupName) 51 | { 52 | this.groupName = groupName; 53 | } 54 | public string GetGroupName() 55 | { 56 | return groupName; 57 | } 58 | } 59 | 60 | 61 | ///