├── .github
├── FUNDING.yml
├── ISSUE_TEMPLATE
│ ├── bug_report.md
│ ├── feature_request.md
│ └── question.md
└── workflows
│ ├── release.yml
│ └── test.yml
├── .gitignore
├── .npmignore
├── .releaserc.json
├── CHANGELOG.md
├── CHANGELOG.md.meta
├── CODE_OF_CONDUCT.md
├── CODE_OF_CONDUCT.md.meta
├── CONTRIBUTING.md
├── CONTRIBUTING.md.meta
├── LICENSE.md
├── LICENSE.md.meta
├── README.md
├── README.md.meta
├── Samples~
├── Demo.meta
└── Demo
│ ├── Light_Frame.png
│ ├── Light_Frame.png.meta
│ ├── UITransition_Art.png
│ ├── UITransition_Art.png.meta
│ ├── Unity-chan.png
│ ├── Unity-chan.png.meta
│ ├── Unmask_Demo.asmdef
│ ├── Unmask_Demo.asmdef.meta
│ ├── Unmask_Demo.controller
│ ├── Unmask_Demo.controller.meta
│ ├── Unmask_Demo.cs
│ ├── Unmask_Demo.cs.meta
│ ├── Unmask_Demo.unity
│ ├── Unmask_Demo.unity.meta
│ ├── Unmask_Demo_Button.controller
│ └── Unmask_Demo_Button.controller.meta
├── Scripts.meta
├── Scripts
├── Coffee.UnmaskForUGUI.asmdef
├── Coffee.UnmaskForUGUI.asmdef.meta
├── Editor.meta
├── Editor
│ ├── Coffee.UnmaskForUGUI.Editor.asmdef
│ ├── Coffee.UnmaskForUGUI.Editor.asmdef.meta
│ ├── ImportSampleMenu.cs
│ ├── ImportSampleMenu.cs.meta
│ ├── MenuOptions.cs
│ └── MenuOptions.cs.meta
├── Unmask.cs
├── Unmask.cs.meta
├── UnmaskRaycastFilter.cs
└── UnmaskRaycastFilter.cs.meta
├── package.json
└── package.json.meta
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 |
3 | github: mob-sakai # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4 | patreon: mob_sakai # Replace with a single Patreon username
5 | open_collective: # Replace with a single Open Collective username
6 | ko_fi: # Replace with a single Ko-fi username
7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9 | liberapay: # Replace with a single Liberapay username
10 | issuehunt: # Replace with a single IssueHunt username
11 | otechie: # Replace with a single Otechie username
12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
13 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Bug report
3 | about: Create a report to help us improve
4 | title: ''
5 | labels: bug
6 | assignees: mob-sakai
7 |
8 | ---
9 |
10 | NOTE: Your issue may already be reported! Please search on the [issue tracker](../) before creating one.
11 |
12 | **Describe the bug**
13 | A clear and concise description of what the bug is.
14 |
15 | **To Reproduce**
16 | Steps to reproduce the behavior:
17 | 1. Go to '...'
18 | 2. Click on '....'
19 | 3. Scroll down to '....'
20 | 4. See error
21 |
22 | **Expected behavior**
23 | A clear and concise description of what you expected to happen.
24 |
25 | **Screenshots**
26 | If applicable, add screenshots to help explain your problem.
27 |
28 | **Environment (please complete the following information):**
29 | - Version [e.g. 1.0.0]
30 | - Platform: [e.g. Editor(Windows/Mac), Standalone(Windows/Mac), iOS, Android, WebGL]
31 | - Unity version: [e.g. 2018.2.8f1]
32 | - Build options: [e.g. IL2CPP, .Net 4.x, LWRP]
33 |
34 | **Additional context**
35 | Add any other context about the problem here.
36 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Feature request
3 | about: Suggest an idea for this project
4 | title: ''
5 | labels: enhancement
6 | assignees: mob-sakai
7 |
8 | ---
9 |
10 | NOTE: Your issue may already be reported! Please search on the [issue tracker](../) before creating one.
11 |
12 | **Is your feature request related to a problem? Please describe.**
13 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
14 |
15 | **Describe the solution you'd like**
16 | A clear and concise description of what you want to happen.
17 |
18 | **Describe alternatives you've considered**
19 | A clear and concise description of any alternative solutions or features you've considered.
20 |
21 | **Additional context**
22 | Add any other context or screenshots about the feature request here.
23 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/question.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Question
3 | about: Ask a question about this project
4 | title: ''
5 | labels: question
6 | assignees: mob-sakai
7 |
8 | ---
9 |
10 | NOTE: Your issue may already be reported! Please search on the [issue tracker](../) before creating one.
11 |
12 | **Describe what help do you need**
13 | A description of the question.
14 |
15 | **Additional context**
16 | Add any other context or screenshots about the question here.
17 |
--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
1 | name: release
2 |
3 | on:
4 | push:
5 | branches:
6 | - preview
7 | - main
8 | - v*.x
9 | tags-ignore:
10 | - "**"
11 |
12 | jobs:
13 | release:
14 | runs-on: ubuntu-latest
15 | steps:
16 | - uses: actions/checkout@v4
17 |
18 | - uses: cycjimmy/semantic-release-action@v3
19 | with:
20 | extra_plugins: |
21 | @semantic-release/changelog
22 | @semantic-release/git
23 | env:
24 | GITHUB_TOKEN: ${{ github.token }}
25 |
--------------------------------------------------------------------------------
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
1 | # Secrets
2 | # UNITY_LICENSE:
3 | name: test
4 |
5 | on:
6 | push:
7 | branches:
8 | - develop
9 | tags:
10 | - "!*"
11 | pull_request:
12 | types:
13 | - opened
14 | - synchronize
15 |
16 | jobs:
17 | unity-test:
18 | runs-on: ubuntu-latest
19 | strategy:
20 | fail-fast: false
21 | matrix:
22 | unityVersion: [
23 | "2018.3.14f1",
24 | "2018.4.30f1",
25 | "2019.1.14f1",
26 | "2019.2.21f1",
27 | "2019.3.15f1",
28 | "2019.4.16f1",
29 | "2020.1.17f1",
30 | "2020.2.1f1",
31 | ]
32 |
33 | steps:
34 | # Checkout sandbox project
35 | - uses: actions/checkout@v4
36 | with:
37 | ref: sandbox
38 | submodules: true
39 | fetch-depth: 0
40 |
41 | # Update package submodule
42 | - name: "Update package submodule"
43 | working-directory: Packages/dev
44 | run: git checkout ${{ github.sha }}
45 |
46 | - uses: actions/cache@v3
47 | with:
48 | path: Library
49 | key: Library-${{ matrix.unityVersion }}-${{ github.sha }}
50 | restore-keys: |
51 | Library-${{ matrix.unityVersion }}-
52 | Library-
53 |
54 | # Install codecoverage package
55 | # - name: "Install codecoverage package"
56 | # if: startsWith(matrix.unityVersion, '2019.4.')
57 | # run: |
58 | # npx openupm-cli add -f com.unity.testtools.codecoverage@0.4.0-preview
59 |
60 | # Run tests
61 | - name: "Run tests"
62 | uses: game-ci/unity-test-runner@v3
63 | with:
64 | unityVersion: ${{ matrix.unityVersion }}
65 | customParameters: -nographics
66 | env:
67 | UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
68 |
69 | # - uses: actions/upload-artifact@v2
70 | # if: always()
71 | # with:
72 | # name: TestResults-${{ matrix.unityVersion }}
73 | # path: |
74 | # artifacts/*.xml
75 | # CodeCoverage/**/TestCoverageResults_*.xml
76 |
77 | # publish:
78 | # needs: unity-test
79 | # runs-on: ubuntu-latest
80 | # if: always()
81 | # steps:
82 |
83 | # - uses: actions/download-artifact@v2
84 | # with:
85 | # path: artifacts
86 |
87 | # - uses: testspace-com/setup-testspace@v1
88 | # with:
89 | # domain: ${{github.repository_owner}}
90 |
91 | # - name: Push test results
92 | # if: always()
93 | # run: |
94 | # testspace `find . -name '*.xml' | tr '\n' ' '`
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | Thumbs.db
2 | Desktop.ini
3 | .DS_Store
4 |
5 | !Samples~
6 |
7 | *.tgz
8 | *.tgz.meta
9 |
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | Thumbs.db
2 | Desktop.ini
3 | .DS_Store
4 |
5 | !Samples~
6 | Samples.meta
7 |
8 | *.tgz
9 | *.tgz.meta
10 | .releaserc.json
11 | .github
12 |
--------------------------------------------------------------------------------
/.releaserc.json:
--------------------------------------------------------------------------------
1 | {
2 | "branches": [
3 | "+([0-9])?(.{+([0-9]),x}).x",
4 | "master",
5 | "main",
6 | {
7 | "name": "preview",
8 | "prerelease": true
9 | }
10 | ],
11 | "tagFormat": "${version}",
12 | "plugins": [
13 | "@semantic-release/commit-analyzer",
14 | "@semantic-release/release-notes-generator",
15 | "@semantic-release/changelog",
16 | [
17 | "@semantic-release/npm",
18 | {
19 | "npmPublish": false
20 | }
21 | ],
22 | "@semantic-release/git",
23 | "@semantic-release/github"
24 | ]
25 | }
26 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | ## [1.4.2](https://github.com/mob-sakai/UnmaskForUGUI/compare/1.4.1...1.4.2) (2023-10-25)
2 |
3 |
4 | ### Bug Fixes
5 |
6 | * UnmaskRaycastFilter not working anymore ([14ab505](https://github.com/mob-sakai/UnmaskForUGUI/commit/14ab505fbfaf1103bbb1869d0e42817bf8830ced)), closes [#29](https://github.com/mob-sakai/UnmaskForUGUI/issues/29)
7 |
8 | ## [1.4.1](https://github.com/mob-sakai/UnmaskForUGUI/compare/1.4.0...1.4.1) (2023-03-14)
9 |
10 |
11 | ### Bug Fixes
12 |
13 | * Fixed error when executing menu item ([9f0afa1](https://github.com/mob-sakai/UnmaskForUGUI/commit/9f0afa19a46bc7b718a80142b02e33ade67fa3b4)), closes [#27](https://github.com/mob-sakai/UnmaskForUGUI/issues/27)
14 |
15 | # [1.4.0](https://github.com/mob-sakai/UnmaskForUGUI/compare/1.3.0...1.4.0) (2022-02-17)
16 |
17 |
18 | ### Features
19 |
20 | * add edge smoothing option ([c5317de](https://github.com/mob-sakai/UnmaskForUGUI/commit/c5317deafeba575161db8b168dae845d68347236))
21 |
22 | # [1.3.0](https://github.com/mob-sakai/UnmaskForUGUI/compare/1.2.0...1.3.0) (2021-06-29)
23 |
24 |
25 | ### Bug Fixes
26 |
27 | * fix sample ([2cf7348](https://github.com/mob-sakai/UnmaskForUGUI/commit/2cf734838e380fd16c7f14eb2513346da70415b8))
28 | * only for children option inside a scrollview ([b1e2bcc](https://github.com/mob-sakai/UnmaskForUGUI/commit/b1e2bccd05615df26d2cf69494430f72c6314a45)), closes [#24](https://github.com/mob-sakai/UnmaskForUGUI/issues/24)
29 | * remove component icons ([27cf23b](https://github.com/mob-sakai/UnmaskForUGUI/commit/27cf23b5d275d694bc33357c8d84a26993f49eec))
30 |
31 |
32 | ### Features
33 |
34 | * add menu to create template object ([907599c](https://github.com/mob-sakai/UnmaskForUGUI/commit/907599c97273f8ce96d55360d5b52cb42de83c5b))
35 |
36 | # [1.2.0](https://github.com/mob-sakai/UnmaskForUGUI/compare/v1.1.3...v1.2.0) (2020-10-07)
37 |
38 |
39 | ### Bug Fixes
40 |
41 | * adapt pivot when trying to fit to target ([a39fcef](https://github.com/mob-sakai/UnmaskForUGUI/commit/a39fcefba29beba079ac41d96ebabeaa5e92117e))
42 | * pass camera to check the point in rectangle when camera is not null ([65a0ad0](https://github.com/mob-sakai/UnmaskForUGUI/commit/65a0ad0424edd9093fc9dfdfc0daf3c5aa27a145))
43 |
44 |
45 | ### Features
46 |
47 | * add menu to import demo ([74603c5](https://github.com/mob-sakai/UnmaskForUGUI/commit/74603c5e08a4acd6b6fc8b711bf1b195bf7cf366))
48 |
49 | # Changelog
50 |
51 | ## [v1.1.3](https://github.com/mob-sakai/UnmaskForUGUI/tree/v1.1.3) (2019-07-12)
52 |
53 | [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/v1.1.2...v1.1.3)
54 |
55 | **Fixed bugs:**
56 |
57 | - There is no asmdef file in this package [\#16](https://github.com/mob-sakai/UnmaskForUGUI/issues/16)
58 |
59 | **Closed issues:**
60 |
61 | - Separate the demo directory as unitypackage [\#17](https://github.com/mob-sakai/UnmaskForUGUI/issues/17)
62 |
63 | ## [v1.1.2](https://github.com/mob-sakai/UnmaskForUGUI/tree/v1.1.2) (2019-07-10)
64 |
65 | [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/v1.1.1...v1.1.2)
66 |
67 | **Fixed bugs:**
68 |
69 | - Can't install package using UPM [\#15](https://github.com/mob-sakai/UnmaskForUGUI/issues/15)
70 |
71 | ## [v1.1.1](https://github.com/mob-sakai/UnmaskForUGUI/tree/v1.1.1) (2019-02-07)
72 |
73 | [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/v1.1.0...v1.1.1)
74 |
75 | **Fixed bugs:**
76 |
77 | - UnmaskRaycastFilter is not reliable [\#14](https://github.com/mob-sakai/UnmaskForUGUI/issues/14)
78 |
79 | ## [v1.1.0](https://github.com/mob-sakai/UnmaskForUGUI/tree/v1.1.0) (2019-01-25)
80 |
81 | [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/1.1.0...v1.1.0)
82 |
83 | **Install UnmaskForUGUI with Unity Package Manager!**
84 |
85 | Find the manifest.json file in the Packages folder of your project and edit it to look like this:
86 | ```js
87 | {
88 | "dependencies": {
89 | "com.coffee.unmask": "https://github.com/mob-sakai/UnmaskForUGUI.git#1.1.0",
90 | ...
91 | },
92 | }
93 | ```
94 | To update the package, change `#1.1.0` to the target version.
95 |
96 | **Implemented enhancements:**
97 |
98 | - Unmask only for children option [\#11](https://github.com/mob-sakai/UnmaskForUGUI/issues/11)
99 |
100 | ## [v1.0.0](https://github.com/mob-sakai/UnmaskForUGUI/tree/v1.0.0) (2018-10-18)
101 |
102 | [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/v0.2.0...v1.0.0)
103 |
104 | **Implemented enhancements:**
105 |
106 | - Add `Fit On LateUpdate` option [\#10](https://github.com/mob-sakai/UnmaskForUGUI/issues/10)
107 |
108 | ## [v0.2.0](https://github.com/mob-sakai/UnmaskForUGUI/tree/v0.2.0) (2018-10-16)
109 |
110 | [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/v0.1.0...v0.2.0)
111 |
112 | **Implemented enhancements:**
113 |
114 | - Update demo & readme [\#9](https://github.com/mob-sakai/UnmaskForUGUI/issues/9)
115 |
116 | ## [v0.1.0](https://github.com/mob-sakai/UnmaskForUGUI/tree/v0.1.0) (2018-10-14)
117 |
118 | [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/987e437b26b83a78d6f54d6cc6778c3181e8e5dc...v0.1.0)
119 |
120 | **Implemented enhancements:**
121 |
122 | - Add demo [\#5](https://github.com/mob-sakai/UnmaskForUGUI/issues/5)
123 | - Support nesting [\#4](https://github.com/mob-sakai/UnmaskForUGUI/issues/4)
124 | - Following another object [\#3](https://github.com/mob-sakai/UnmaskForUGUI/issues/3)
125 | - Ray through the unmasked rectangle [\#2](https://github.com/mob-sakai/UnmaskForUGUI/issues/2)
126 | - Reverse mask [\#1](https://github.com/mob-sakai/UnmaskForUGUI/issues/1)
127 |
128 |
129 |
130 | \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
131 |
--------------------------------------------------------------------------------
/CHANGELOG.md.meta:
--------------------------------------------------------------------------------
1 | fileFormatVersion: 2
2 | guid: fbca627d531eb4ca9b5846c638709e4c
3 | timeCreated: 1539214410
4 | licenseType: Pro
5 | DefaultImporter:
6 | userData:
7 | assetBundleName:
8 | assetBundleVariant:
9 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6 |
7 | We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8 |
9 | ## Our Standards
10 |
11 | Examples of behavior that contributes to a positive environment for our community include:
12 |
13 | * Demonstrating empathy and kindness toward other people
14 | * Being respectful of differing opinions, viewpoints, and experiences
15 | * Giving and gracefully accepting constructive feedback
16 | * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17 | * Focusing on what is best not just for us as individuals, but for the overall community
18 |
19 | Examples of unacceptable behavior include:
20 |
21 | * The use of sexualized language or imagery, and sexual attention or
22 | advances of any kind
23 | * Trolling, insulting or derogatory comments, and personal or political attacks
24 | * Public or private harassment
25 | * Publishing others' private information, such as a physical or email
26 | address, without their explicit permission
27 | * Other conduct which could reasonably be considered inappropriate in a
28 | professional setting
29 |
30 | ## Enforcement Responsibilities
31 |
32 | Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33 |
34 | Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35 |
36 | ## Scope
37 |
38 | This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39 |
40 | ## Enforcement
41 |
42 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at sakai861104@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
43 |
44 | All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45 |
46 | ## Enforcement Guidelines
47 |
48 | Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49 |
50 | ### 1. Correction
51 |
52 | **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53 |
54 | **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55 |
56 | ### 2. Warning
57 |
58 | **Community Impact**: A violation through a single incident or series of actions.
59 |
60 | **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61 |
62 | ### 3. Temporary Ban
63 |
64 | **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65 |
66 | **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67 |
68 | ### 4. Permanent Ban
69 |
70 | **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71 |
72 | **Consequence**: A permanent ban from any sort of public interaction within the community.
73 |
74 | ## Attribution
75 |
76 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77 | available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78 |
79 | Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80 |
81 | [homepage]: https://www.contributor-covenant.org
82 |
83 | For answers to common questions about this code of conduct, see the FAQ at
84 | https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md.meta:
--------------------------------------------------------------------------------
1 | fileFormatVersion: 2
2 | guid: bbddc129164884a2ba83385fd1abb547
3 | TextScriptImporter:
4 | externalObjects: {}
5 | userData:
6 | assetBundleName:
7 | assetBundleVariant:
8 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | ## How to Contribute
4 |
5 | #### Code of Conduct
6 |
7 | This repository has adopted the Contributor Covenant as it's
8 | Code of Conduct. It is expected that participants adhere to it.
9 |
10 | #### Proposing a Change
11 |
12 | If you are unsure about whether or not a change is desired,
13 | you can create an issue. This is useful because it creates
14 | the possibility for a discussion that's visible to everyone.
15 |
16 | When fixing a bug it is fine to submit a pull request right away.
17 |
18 | #### Sending a Pull Request
19 |
20 | Steps to be performed to submit a pull request:
21 |
22 | 1. Fork the repository and create your branch from `develop`.
23 | 2. If you have fixed a bug or added code that should be tested, add tests.
24 | 3. Click `Window > Generals > Test Runner` to test
25 | 4. Commit with a massage based on [Angular Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153).
26 | 5. Fill out the description, link any related issues and submit your pull request.
27 |
28 | #### License
29 |
30 | By contributing to this repository, you agree that your contributions will be licensed under its MIT license.
31 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md.meta:
--------------------------------------------------------------------------------
1 | fileFormatVersion: 2
2 | guid: b85675b2587cd4b2e919c33d7913131f
3 | TextScriptImporter:
4 | externalObjects: {}
5 | userData:
6 | assetBundleName:
7 | assetBundleVariant:
8 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | Copyright 2018 mob-sakai
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4 |
5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6 |
7 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--------------------------------------------------------------------------------
/LICENSE.md.meta:
--------------------------------------------------------------------------------
1 | fileFormatVersion: 2
2 | guid: cefd86cfe94614a08ac447d0a9ec6ad3
3 | timeCreated: 1539214411
4 | licenseType: Pro
5 | TextScriptImporter:
6 | userData:
7 | assetBundleName:
8 | assetBundleVariant:
9 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Unmask For UGUI
2 | ===
3 |
4 | Reverse mask for uGUI element in Unity.
5 |
6 | 
7 |
8 | [](https://openupm.com/packages/com.coffee.unmask/)
9 | [](https://github.com/mob-sakai/UnmaskForUGUI/releases)
10 | [](https://github.com/mob-sakai/UnmaskForUGUI/releases)
11 | [](https://github.com/mob-sakai/UnmaskForUGUI/blob/main/LICENSE.txt)
12 | [](http://makeapullrequest.com)
13 | [](https://twitter.com/intent/follow?screen_name=mob_sakai)
14 |
15 | 
16 | 
17 | 
18 | 
19 | 
20 | 
21 |
22 | 
23 |
24 | << [Description](#description) | [WebGL Demo](#demo) | [Installation](#installation) | [Usage](#usage) | [Contributing](#contributing) >>
25 |
26 |
27 |
28 |
29 |
30 | ## Description
31 |
32 | Unmask provides the following features:
33 | 1. Reverse mask
34 | 2. Ray through the unmasked rectangle
35 | 3. Following another object
36 | 4. Support nesting
37 |
38 | | Component | Features | Screenshot |
39 | |-|-|-|
40 | |**Unmask**|Reverse masking for parent Mask component.
**Fit Target / Fit On Late Update:** Fit graphic's transform to target transform on LateUpdate. **Only For Children:** Unmask affects only for children. **Show Unmask Graphic:** Show the graphic that is associated with the unmask render area.||
41 | |**UnmaskRaycastFilter**|The ray Passes through the unmasked rectangle. You can click on the unmasked button on the back side.||
42 |
43 |
44 |
45 |
55 |
56 | ## Installation
57 |
58 | ### Requirement
59 |
60 | 
61 | 
62 | 
63 | 
64 | 
65 | 
66 |
67 | 
68 |
69 | ### Using OpenUPM
70 |
71 | This package is available on [OpenUPM](https://openupm.com).
72 | You can install it via [openupm-cli](https://github.com/openupm/openupm-cli).
73 | ```
74 | openupm add com.coffee.unmask
75 | ```
76 |
77 | ### Using Git
78 |
79 | Find the manifest.json file in the Packages folder of your project and edit it to look like this:
80 | ```
81 | {
82 | "dependencies": {
83 | "com.coffee.unmask": "https://github.com/mob-sakai/UnmaskForUGUI.git",
84 | ...
85 | },
86 | }
87 | ```
88 |
89 | To update the package, change suffix `#{version}` to the target version.
90 |
91 | * e.g. `"com.coffee.unmask": "https://github.com/mob-sakai/UnmaskForUGUI.git#2.0.0",`
92 |
93 | Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to install and update the package.
94 |
95 | ### For Unity 2018.2 or earlier
96 |
97 | 1. Download a source code zip file from [Releases](https://github.com/mob-sakai/UnmaskForUGUI/releases) page
98 | 2. Extract it
99 | 3. Import it into the following directory in your Unity project
100 | - `Packages` (It works as an embedded package. For Unity 2018.1 or later)
101 | - `Assets` (Legacy way. For Unity 2017.1 or later)
102 |
103 |
104 |
105 |
106 |
107 | ## How to play demo
108 |
109 | - For Unity 2019.1 or later
110 | - Open `Package Manager` window and select `UI Unmask` package in package list and click `Demo > Import in project` button
111 | - For Unity 2018.4 or earlier
112 | - Click `Assets/Samples/UI Unmask/Import Demo` from menu
113 |
114 | The assets will be imported into `Assets/Samples/UI Unmask/{version}/Demo`.
115 | Open `UIUnmask_Demo` scene and play it.
116 |
117 |
118 |
119 |
133 |
134 | ## Example of using
135 |
136 | | Case | Description |Screenshot |
137 | |-|-|-|
138 | |Unmasked text|Black screen is cut out with unmasked text.||
139 | |Hole|Black screen is cut out with unmasked Image.||
140 | |Tutorial button|In tutorial, only specific button can be pressed.||
141 | |Iris in/out|Transition effect with iris in/out.||
142 |
143 |
144 |
145 |
146 |
147 | ## Contributing
148 |
149 | ### Issues
150 |
151 | Issues are very valuable to this project.
152 |
153 | - Ideas are a valuable source of contributions others can make
154 | - Problems show where this project is lacking
155 | - With a question you show where contributors can improve the user experience
156 |
157 | ### Pull Requests
158 |
159 | Pull requests are, a great way to get your ideas into this repository.
160 | See [CONTRIBUTING.md](/../../blob/main/CONTRIBUTING.md) and [develop](https://github.com/mob-sakai/UnmaskForUGUI/tree/develop) branch..
161 |
162 | ### Support
163 |
164 | This is an open source project that I am developing in my spare time.
165 | If you like it, please support me.
166 | With your support, I can spend more time on development. :)
167 |
168 | [](https://www.patreon.com/join/2343451?)
169 | [](https://github.com/users/mob-sakai/sponsorship)
170 |
171 |
172 |
173 |
174 |