Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mob-sakai/AtlasImage
AtlasImage is a graphic component use SpriteAtlas for uGUI. In addition, add useful sprite selector and border editor to the inspector.
https://github.com/mob-sakai/AtlasImage
atlas sprite ugui uguicomponent unity unity3d
Last synced: 3 months ago
JSON representation
AtlasImage is a graphic component use SpriteAtlas for uGUI. In addition, add useful sprite selector and border editor to the inspector.
- Host: GitHub
- URL: https://github.com/mob-sakai/AtlasImage
- Owner: mob-sakai
- License: mit
- Created: 2018-04-30T15:02:50.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2020-12-28T15:06:31.000Z (about 4 years ago)
- Last Synced: 2024-07-14T04:37:04.614Z (7 months ago)
- Topics: atlas, sprite, ugui, uguicomponent, unity, unity3d
- Language: C#
- Homepage: https://github.com/mob-sakai/AtlasImage
- Size: 89.8 KB
- Stars: 130
- Watchers: 10
- Forks: 27
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-opensource-unity - AtlasImage - AtlasImage is a graphic component use SpriteAtlas for uGUI. In addition, add useful sprite selector and border editor to the inspector. (Open Source Packages / 2D)
- awesome-unity3d - AtlasImage - AtlasImage is a graphic component use SpriteAtlas for uGUI. In addition, add useful sprite selector and border editor to the inspector (Open Source Repositories / 2D)
- awesome-unity-open-source-on-github - AtlasImage - AtlasImage is a graphic component use SpriteAtlas for uGUI (Atlas)
README
Atlas Image
===
A graphic component use `SpriteAtlas` for uGUI.
In addition, add useful **sprite picker** and **border editor** to the inspector.
[](https://openupm.com/packages/com.coffee.atlas-image/)
[](https://github.com/mob-sakai/AtlasImage/releases)
[](https://github.com/mob-sakai/AtlasImage/releases) [](https://github.com/mob-sakai/AtlasImage/blob/main/LICENSE)
[](http://makeapullrequest.com)
<< [Description](#Description) | [Demo](#demo) | [Installation](#installation) | [Usage](#usage) | [Development Note](#development-note) | [Change log](https://github.com/mob-sakai/AtlasImage/blob/main/CHANGELOG.md) >>
## Description
Are you still fatigued with `SpriteAtlas` and `Image`?
* No interface for SpriteAtlas
* Support only `Sprite`.
* We pack sprites for drawing call optimization, but there is no interface.
* Confusing sprite picker
* You can select sprites using object picker.
* Opject picker displays **all sprites in the project**...
* Do you know which sprite is included in atlas?
* Troublesome border setting
* You can edit sprite border using sprite editor.
* It is troublesome to select a sprite, open a sprite editor, and edit the border.
`AtlasImage` provides useful feature to use `SpriteAtlas` for UI!
### Sprite for renderring can be changed with a SpriteAtlas or a sprite name.
```cs
atlasImage.spriteAtlas = Resources.Load("A SpriteAtlas name") as SpriteAtlas;
atlasImage.spriteName = "A sprite name in the SpriteAtlas";
```
### In the inspector, sprite picker displays only sprites in the SpriteAtlas.
### You can edit the border in the preview window.
### Convert `Image` to `AtlasImage` by context menu.
## Demo
## Installation
### Requirement
* Unity 2017.1 or later
### (For Unity 2018.3 or later) Using OpenUPM
This package is available on [OpenUPM](https://openupm.com).
You can install it via [openupm-cli](https://github.com/openupm/openupm-cli).
```
openupm add com.coffee.atlas-image
```
### (For Unity 2018.3 or later) Using Git
Find the manifest.json file in the Packages folder of your project and add a line to `dependencies` field.
* Major version: 
`"com.coffee.atlas-image": "https://github.com/mob-sakai/AtlasImage.git"`
To update the package, change suffix `#{version}` to the target version.
* e.g. `"com.coffee.atlas-image": "https://github.com/mob-sakai/AtlasImage.git#1.0.0",`
Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to install and update the package.
#### For Unity 2018.2 or earlier
1. Download a source code zip file from [Releases](https://github.com/mob-sakai/AtlasImage/releases) page
2. Extract it
3. Import it into the following directory in your Unity project
- `Packages` (It works as an embedded package. For Unity 2018.1 or later)
- `Assets` (Legacy way. For Unity 2017.1 or later)
## Usage
1. Enable SpriteAtlas. Go to `Edit > Project Settings > Editor`, and change the sprite packing mode from Disabled to either:
* Enabled for Builds, when you want to use packing for builds only and not when in Play mode.
* Always Enabled when you want the packed Sprite to resolve its texture from the Sprite Atlas during Play mode, but resolve its texture from the original Texture during Edit mode.
1. Add `AtlasImage` component instead of `Image` component from `Add Component` in inspector.
1. Select the `SpriteAtlas` by dropdown manu, and select the sprite with object piker.
1. Enjoy!
## Development Note
### How to work?
1. Pack atlas on open select sprite window.
```cs
static void PackAtlas(SpriteAtlas atlas)
{
System.Type
.GetType("UnityEditor.U2D.SpriteAtlasUtility, UnityEditor")
.GetMethod("PackAtlases", BindingFlags.NonPublic | BindingFlags.Static)
.Invoke(null, new object[]{ new []{ atlas }, EditorUserBuildSettings.activeBuildTarget });
}
```
1. Add label `` to sprites in atlas.
```cs
static string SetAtlasLabelToSprites(SpriteAtlas atlas, bool add)
{
// GUID for the atlas.
string[] atlasLabel = { AssetDatabase.AssetPathToGUID(AssetDatabase.GetAssetPath(atlas)) };
// Packed sprites in atlas.
SerializedProperty spPackedSprites = new SerializedObject(atlas).FindProperty("m_PackedSprites");
Sprite[] sprites = Enumerable.Range(0, spPackedSprites.arraySize)
.Select(index => spPackedSprites.GetArrayElementAtIndex(index).objectReferenceValue)
.OfType()
.ToArray();
// Add/remove label to sprites.
foreach (var s in sprites)
{
string[] newLabels = add
? AssetDatabase.GetLabels(s).Union(atlasLabel).ToArray()
: AssetDatabase.GetLabels(s).Except(atlasLabel).ToArray();
AssetDatabase.SetLabels(s, newLabels);
}
return atlasLabel[0];
}
```
1. Open the object picker with label. It filter the sprites to display.
```cs
EditorGUIUtility.ShowObjectPicker(atlas.GetSprite(spriteName), false, "l:" + atlasLabel, controlID);
```
1. On closed the object picker, remove label from sprites in atlas.
## Contributing
### Issues
Issues are very valuable to this project.
- Ideas are a valuable source of contributions others can make
- Problems show where this project is lacking
- With a question you show where contributors can improve the user experience
### Pull Requests
Pull requests are, a great way to get your ideas into this repository.
See [sandbox/README.md](https://github.com/mob-sakai/AtlasImage/blob/sandbox/README.md).
### Support
This is an open source project that I am developing in my spare time.
If you like it, please support me.
With your support, I can spend more time on development. :)
[](https://www.patreon.com/join/mob_sakai?)
[](https://github.com/users/mob-sakai/sponsorship)
## License
* MIT
## Author
*  [mob-sakai](https://github.com/mob-sakai) [](https://twitter.com/intent/follow?screen_name=mob_sakai) 
## See Also
* GitHub page : https://github.com/mob-sakai/AtlasImage
* Releases : https://github.com/mob-sakai/AtlasImage/releases
* Issue tracker : https://github.com/mob-sakai/AtlasImage/issues
* Change log : https://github.com/mob-sakai/AtlasImage/blob/main/CHANGELOG.md