https://github.com/ml-opensource/clippedimageview
Simple Android widgets to support customizable clip paths
https://github.com/ml-opensource/clippedimageview
Last synced: 11 months ago
JSON representation
Simple Android widgets to support customizable clip paths
- Host: GitHub
- URL: https://github.com/ml-opensource/clippedimageview
- Owner: ml-opensource
- License: apache-2.0
- Created: 2017-09-19T00:54:35.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-10-15T01:08:13.000Z (over 6 years ago)
- Last Synced: 2025-01-27T08:16:36.721Z (about 1 year ago)
- Language: Java
- Size: 130 KB
- Stars: 0
- Watchers: 20
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Auto-masking Views for Android
==============================
These custom ImageViews use their backgrounds as masks to clip their
foregrounds. Many libraries limit themselves to just a couple of simple
shapes: circles, ovals, squircles, teardrops, and (of course) rectangles.
With this, you can use _any_ transparency-sporting drawable as a mask -
even vector assets!
The code used for this library was derived from work by @fanrunqi on
their [AvatarImageView][0].
Prior to 9/2017 these files were shipped as part of [CutoutViewIndicator][1]
Who would use this?
-------------------
This library is aimed at any android app loading images into
ImageViews (or ImageButtons, etc...). We support all the big image-loading
libraries (Glide, Picasso, Volley) as well as standard Android framework
methods (`android:src`, `setImageDrawable`, `app:srcCompat`).
Do I need to worry about anything?
----------------------------------
All you need to do is assign both a foreground and a background, and the
`ClippedImageView` will handle the rest. It won't draw anything otherwise.
`TextClippedImageView` requires an additional step: you'll need to set
a 'text mask'.
So, uh, what do clipping and masking even mean? in this context?
----------------------------------------------------------------
Clipping is the act of removing all visible parts of an image outside a
certain boundary. That boundary is usually called the 'clip bounds', and
an image made up entirely of area outside the clip bounds is called a 'mask'.
# Code Snippets
Gradle module file (make sure you don't add these to the 'buildscript' block):
```groovy
repositories {
// ...
maven { url "https://jitpack.io" }
}
// ...
dependencies {
// ...
implementation 'com.github.fuzz-productions:ClippedImageView:v0.2.0'
}
```
Sample XML:
```
```
Java:
```
ClippedImageView civ = // ...
civ.setBackgroundResource(R.drawable.background);
civ.setImageResource(R.drawable.foreground);
TextClippedImageview textClippedView = // ...
if (!textClippedView.hasTextMask()) {
textClippedView.setTextPathMask("Some Text");
}
// Optional: apply your own text styles
TextPaint paint = // ...
textClippedView.copyTextPaintPropertiesFrom(paint);
```
Kotlin:
```
val civ: ClippedImageView = // ...
civ.setBackgroundResource(R.drawable.background)
civ.setImageResource(R.drawable.foreground)
val textClippedView: TextClippedImageView = // ...
if (!textClippedView.hasTextMask()) {
textClippedView.setTextPathMask("Some Text")
}
// Optional: apply your own text styles
val paint: TextPaint = // ...
textClippedView.copyTextPaintPropertiesFrom(paint)
```
# License
```
Copyright 2016 fanrunqi
Modifications Copyright 2016-2019 Philip Cohn-Cort
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
[0]: https://github.com/fanrunqi/AvatarImageView
[1]: https://github.com/fuzz-productions/CutoutViewIndicator