Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mob-sakai/MeshEffectForTextMeshPro
Mesh effect components for TextMeshPro in Unity.
https://github.com/mob-sakai/MeshEffectForTextMeshPro
component effects support-textmeshpro textmeshpro ugui ui unity unity3d
Last synced: 2 months ago
JSON representation
Mesh effect components for TextMeshPro in Unity.
- Host: GitHub
- URL: https://github.com/mob-sakai/MeshEffectForTextMeshPro
- Owner: mob-sakai
- License: mit
- Created: 2018-11-28T14:02:44.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2019-01-25T01:52:05.000Z (about 6 years ago)
- Last Synced: 2024-11-11T18:30:38.784Z (3 months ago)
- Topics: component, effects, support-textmeshpro, textmeshpro, ugui, ui, unity, unity3d
- Language: C#
- Size: 16.9 MB
- Stars: 160
- Watchers: 15
- Forks: 26
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-unity-open-source-on-github - MeshEffectForTextMeshPro - Mesh effect components (TextMesh Pro)
README
MeshEffectForTextMeshPro
===
### NOTE: This project is experimental.
### NOTE: This project will be integrated to [UIEffect](https://github.com/mob-sakai/UIEffect).
MeshEffectForTextMeshPro provide visual effect components for TextMeshPro in Unity.
[](https://github.com/mob-sakai/MeshEffectForTextMeshPro/releases)
[](https://github.com/mob-sakai/MeshEffectForTextMeshPro/releases)
[](https://github.com/mob-sakai/MeshEffectForTextMeshPro/blob/master/LICENSE.txt)
[](http://makeapullrequest.com)
<< [Description](#Description) | [WebGL Demo](#demo) | [Download](https://github.com/mob-sakai/MeshEffectForTextMeshPro/releases) | [Usage](#usage) | [Example of using](#example-of-using) | [Development Note](#development-note) | [Change log](https://github.com/mob-sakai/MeshEffectForTextMeshPro/blob/master/CHANGELOG.md) >>
### What's new? [See changelog ](https://github.com/mob-sakai/MeshEffectForTextMeshPro/blob/develop/CHANGELOG.md)
### Do you want to receive notifications for new releases? [Watch this repo ](https://github.com/mob-sakai/MeshEffectForTextMeshPro/subscription)
## Description
Do you like TextMeshPro? I’m lovin’ it:)
As you know, TextMeshPro, the ultimate text solution, is one of the greatest assets in Unity.
It is more beautiful than the standard TextMesh and Text, it is highly functional and free.
One of the big mystery of TextMeshPro is that "typical mesh effects (vertex effects) for uGUI can not be used for TextMeshPro".
Since TextMeshPro does not call `IMeshModifier` interface, TextMeshPro ignores the typical mesh effects.
The mesh effects of TextMeshPro (eg VertexJitter, VertexColorCycler etc) are very unique in their implementation and can only be used for TextMeshPro...
I think that an easy way to implement a common mesh effect is necessary.
This project provides a base class for mesh effect.
It works well not only for standard Graphic components (Image, RawImage, Text, etc.) but also for TextMeshPro and TextMeshProUGUI.
Just change your mesh effect a few places, it will support TextMeshPro!
Let's decorate your TextMeshPro with effects!
#### Features
* Works well not only for standard Graphic components (Image, RawImage, Text, etc.) but also for TextMeshPro and TextMeshProUGUI.
* Support multiple fonts.
* There is no useless allocation.
* Good performance.
* You can implement MeshEffect with VertexHelper or Mesh.
* Easily make your mesh effect support TextMeshPro. [See detail](#make-your-mesh-effect-support-textmeshpro)
* If your project does not use TMPro, add "NOT_USE_TMPRO" symbol. Or uncomment the first line of BaseMeshEffect.cs.
```cs
//#define NOT_USE_TMPRO // If your project does not use TMPro, uncomment this line.
```
## Demo
[WebGL Demo](http://mob-sakai.github.io/MeshEffectForTextMeshPro)
## Usage
1. Download MeshEffectForTextMeshPro.unitypackage from [Releases](https://github.com/mob-sakai/MeshEffectForTextMeshPro/releases).
2. Import the package into your Unity project. Select `Import Package > Custom Package` from the `Assets` menu.
3. Add any effect component to TextMeshPro from `Add Component` in inspector or `Component > MeshEffectForTextMeshPro > ...` menu.
4. Adjust the parameters of the effect as you like, in inspector.
5. If your project does not use TMPro, add "NOT_USE_TMPRO" symbol. Or uncomment the first line of BaseMeshEffect.cs.
```cs
//#define NOT_USE_TMPRO // If your project does not use TMPro, uncomment this line.
```
6. Enjoy!
##### Requirement
* Unity 5.5+ *(including Unity 2019.x)*
* TextMeshPro v1.0.0+
## Development Note
#### Make your mesh effect supports TextMeshPro
1. Change the base class from `BaseMeshEffect` to `Coffee.UIExtensions.BaseMeshEffect`.
```cs
// Before
public class YourMeshEffect : BaseMeshEffect
or
public class YourMeshEffect : MonoBehavior, IMeshModifier
// After
public class YourMeshEffect : Coffee.UIExtensions.BaseMeshEffect
```
2. If you are using specific methods, override it properly.
* OnEnable, OnDisable, LateUpdate, OnDidApplyAnimationProperties, OnValidate, ModifyMesh.
* Call `base.xxx` except ModifyMesh.
```cs
// Before
void OnEnable ()
{
...
}
void OnDisable ()
{
...
}
...
void ModifyMesh (VertexHelper vh)
{
...
}
// After
protected override void OnEnable ()
{
base.OnEnable();
...
}
void OnDisable ()
{
base.OnDisable();
...
}
...
public override void ModifyMesh (VertexHelper vh)
{
//base.ModifyMesh(vh); <- ModifyMesh's base method is unnecessary.
...
}
```
3. Change `graphic.SetVerticesDirty` to `SetVerticesDirty`
```cs
// Before
public bool horizontal { get { return this.m_Horizontal; } set { this.m_Horizontal = value; graphic.SetVerticesDirty(); } }
// After
public bool horizontal { get { return this.m_Horizontal; } set { this.m_Horizontal = value; SetVerticesDirty(); } }
```
4. If there are compile errors, remove them.
## License
* MIT
* © UTJ/UCL
## Author
[mob-sakai](https://github.com/mob-sakai)
## See Also
* GitHub page : https://github.com/mob-sakai/MeshEffectForTextMeshPro
* Releases : https://github.com/mob-sakai/MeshEffectForTextMeshPro/releases
* Issue tracker : https://github.com/mob-sakai/MeshEffectForTextMeshPro/issues
* Current project : https://github.com/mob-sakai/MeshEffectForTextMeshPro/projects/1
* Change log : https://github.com/mob-sakai/MeshEffectForTextMeshPro/blob/master/CHANGELOG.md