Skip to content

Instantly share code, notes, and snippets.

@nickbutcher
Last active November 1, 2024 09:45
Show Gist options
  • Save nickbutcher/1dcde5a989011d01fda491bc9a59c21e to your computer and use it in GitHub Desktop.
Save nickbutcher/1dcde5a989011d01fda491bc9a59c21e to your computer and use it in GitHub Desktop.
A prototype implementation of a shadow effect inspired by the Google Play Games app (https://play.google.com/store/apps/details?id=com.google.android.play.games).
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright (c) 2017 Google Inc.
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.
-->
<FrameLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">
<ProgressBar
android:id="@+id/loading"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:indeterminate="true" />
<android.support.v7.widget.RecyclerView
android:id="@+id/carousel"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:clipToPadding="false"
android:orientation="horizontal"
android:paddingStart="96dp"
android:scrollbarStyle="insideOverlay"
android:scrollbars="horizontal"
app:layoutManager="LinearLayoutManager"
tools:context=".MainActivity" />
</FrameLayout>
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright (c) 2017 Google Inc.
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.
-->
<com.example.playgamesshadows.IconView
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="224dp"
android:layout_height="match_parent" />
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright (c) 2017 Google Inc.
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.
-->
<resources>
<declare-styleable name="AppTheme">
<attr name="iconViewStyle" format="reference" />
</declare-styleable>
<declare-styleable name="IconView">
<attr name="constantShadowTranslationY" format="dimension" />
<attr name="variableShadowTranslationY" format="dimension" />
<attr name="scaleDown" format="float" />
<attr name="bigBlurRadius" format="float" />
<attr name="smallBlurRadius" format="float" />
</declare-styleable>
</resources>
/*
* Copyright 2017 Google Inc.
*
* 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.
*/
package com.example.playgamesshadows
import android.content.Context
import android.graphics.Bitmap
import android.graphics.Bitmap.Config.*
import android.graphics.Canvas
import android.graphics.Color
import android.graphics.ColorMatrix
import android.graphics.ColorMatrixColorFilter
import android.graphics.Paint
import android.graphics.Rect
import android.graphics.RectF
import android.graphics.drawable.Drawable
import android.renderscript.Allocation
import android.renderscript.Element
import android.renderscript.RenderScript
import android.renderscript.ScriptIntrinsicBlur
import android.support.annotation.AttrRes
import android.support.annotation.StyleRes
import android.support.v4.view.animation.FastOutSlowInInterpolator
import android.util.AttributeSet
import android.view.View
class IconView @JvmOverloads constructor(
context: Context,
attrs: AttributeSet,
@AttrRes defStyleAttr: Int = R.attr.iconViewStyle,
@StyleRes defStyleRes: Int = R.style.Widget_ShadowPlay_IconView)
: View(context, attrs, defStyleAttr, defStyleRes) {
var icon: Drawable? = null
set(value) {
field = value
setIconBounds()
createShadows()
}
var offset = 0f
set(value) {
field = interp.getInterpolation(value.coerceIn(0f, 1f))
val scale = scaleDown + (1f - scaleDown) * (1f - field)
scaleX = scale
scaleY = scale
smallBlurShadowAlpha = (field * 255).toInt()
bigBlurShadowAlpha = 255 - smallBlurShadowAlpha
shadowTranslate = constantShadowTranslationY + variableShadowTranslationY * (1f - field)
postInvalidateOnAnimation()
}
private var bigBlurShadow: Bitmap? = null
private var smallBlurShadow: Bitmap? = null
private var smallBlurShadowAlpha = 255
private var bigBlurShadowAlpha = 255
private var shadowTranslate = 0f
private var constantShadowTranslationY = 8f
private var variableShadowTranslationY = 16f
private var scaleDown = 0.85f
private var bigBlurRadius = 24f
private var smallBlurRadius = 8f
private var padding = bigBlurRadius.toInt()
private val iconBounds = Rect()
private val shadowBounds = RectF()
private val shadowPaint = Paint(Paint.ANTI_ALIAS_FLAG).apply {
colorFilter = ColorMatrixColorFilter(ColorMatrix().apply {
setScale(SHADOW_SCALE_RGB, SHADOW_SCALE_RGB, SHADOW_SCALE_RGB, SHADOW_SCALE_ALPHA)
})
}
init {
val a = context.obtainStyledAttributes(attrs, R.styleable.IconView, defStyleAttr, defStyleRes)
constantShadowTranslationY = a.getDimension(R.styleable.IconView_constantShadowTranslationY,
constantShadowTranslationY)
variableShadowTranslationY = a.getDimension(R.styleable.IconView_variableShadowTranslationY,
variableShadowTranslationY)
scaleDown = a.getFloat(R.styleable.IconView_scaleDown, scaleDown).coerceIn(0f, 1f)
bigBlurRadius = a.getFloat(R.styleable.IconView_bigBlurRadius, bigBlurRadius)
.coerceIn(0f, 25f)
padding = bigBlurRadius.toInt()
smallBlurRadius = a.getFloat(R.styleable.IconView_smallBlurRadius, smallBlurRadius)
.coerceIn(0f, 25f)
a.recycle()
}
override fun onSizeChanged(w: Int, h: Int, oldw: Int, oldh: Int) {
val shadowTop = (h - w) / 2
val iconTop = shadowTop + padding
val iconSize = w - padding - padding
iconBounds.set(padding, iconTop, padding + iconSize, iconTop + iconSize)
shadowBounds.set(0f, shadowTop.toFloat(), w.toFloat(), (shadowTop + w).toFloat())
setIconBounds()
createShadows()
}
override fun onDraw(canvas: Canvas) {
super.onDraw(canvas)
val saveCount = canvas.save()
canvas.translate(shadowBounds.left, shadowBounds.top + shadowTranslate)
shadowPaint.alpha = bigBlurShadowAlpha
canvas.drawBitmap(bigBlurShadow, 0f, 0f, shadowPaint)
shadowPaint.alpha = smallBlurShadowAlpha
canvas.drawBitmap(smallBlurShadow, 0f, 0f, shadowPaint)
canvas.restoreToCount(saveCount)
icon?.draw(canvas)
}
private fun setIconBounds() {
icon?.bounds = iconBounds
}
private fun createShadows() {
if (icon == null || shadowBounds.width() == 0f) return
if (bigBlurShadow == null) {
bigBlurShadow = Bitmap.createBitmap(
shadowBounds.width().toInt(), shadowBounds.height().toInt(), ARGB_8888)
} else {
bigBlurShadow?.eraseColor(Color.TRANSPARENT)
}
if (smallBlurShadow == null) {
smallBlurShadow = Bitmap.createBitmap(
shadowBounds.width().toInt(), shadowBounds.height().toInt(), ARGB_8888)
} else {
smallBlurShadow?.eraseColor(Color.TRANSPARENT)
}
val c = Canvas()
createShadow(bigBlurShadow, c, bigBlurRadius)
createShadow(smallBlurShadow, c, smallBlurRadius)
}
private fun createShadow(bitmap: Bitmap?, canvas: Canvas, blurRadius: Float) {
canvas.setBitmap(bitmap)
canvas.translate(padding - iconBounds.left.toFloat(),
padding - iconBounds.top.toFloat())
icon?.draw(canvas)
val rs = getRS(context)
val blur = getBlur(context)
val input = Allocation.createFromBitmap(rs, bitmap)
val output = Allocation.createTyped(rs, input.type)
blur.setRadius(blurRadius.coerceIn(0f, 25f))
blur.setInput(input)
blur.forEach(output)
output.copyTo(bitmap)
input.destroy()
output.destroy()
}
companion object {
private const val SHADOW_SCALE_RGB = 0.85f
private const val SHADOW_SCALE_ALPHA = 0.6f
private val interp = FastOutSlowInInterpolator()
private var rs: RenderScript? = null
fun getRS(context: Context): RenderScript {
if (rs == null) {
rs = RenderScript.create(context.applicationContext)
}
return rs!!
}
private var blur: ScriptIntrinsicBlur? = null
fun getBlur(context: Context): ScriptIntrinsicBlur {
if (blur == null) {
val rs = getRS(context)
blur = ScriptIntrinsicBlur.create(rs, Element.U8_4(rs))
}
return blur!!
}
}
}
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2015 Google Inc.
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.
/*
* Copyright 2017 Google Inc.
*
* 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.
*/
package com.example.playgamesshadows
import android.app.LoaderManager
import android.content.AsyncTaskLoader
import android.content.Context
import android.content.Intent
import android.content.Loader
import android.graphics.drawable.Drawable
import android.os.Bundle
import android.support.v7.app.AppCompatActivity
import android.support.v7.widget.LinearSnapHelper
import android.support.v7.widget.RecyclerView
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import kotlinx.android.synthetic.main.activity_main.*
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
carousel.setHasFixedSize(true)
LinearSnapHelper().attachToRecyclerView(carousel)
carousel.addOnScrollListener(object : RecyclerView.OnScrollListener() {
override fun onScrolled(recyclerView: RecyclerView, dx: Int, dy: Int) {
val center = recyclerView.width / 2
(0 until recyclerView.childCount).forEach { i ->
val child = recyclerView.getChildAt(i) as? IconView ?: return@forEach
val cx = (child.left + child.right) / 2
val offsetPx = Math.abs(center - cx)
child.offset = offsetPx / center.toFloat()
}
}
})
loaderManager.initLoader(0, Bundle.EMPTY,
object : LoaderManager.LoaderCallbacks<List<Drawable>> {
override fun onCreateLoader(id: Int, args: Bundle?) = AppIconLoader(applicationContext)
override fun onLoadFinished(loader: Loader<List<Drawable>>, icons: List<Drawable>) {
loading.visibility = View.GONE
carousel.adapter = AppAdapter(icons)
}
override fun onLoaderReset(loader: Loader<List<Drawable>>?) {}
})
}
private class AppIconLoader(context: Context) : AsyncTaskLoader<List<Drawable>>(context) {
private val icons = mutableListOf<Drawable>()
override fun onStartLoading() {
if (icons.isNotEmpty()) {
deliverResult(icons)
} else {
forceLoad()
}
}
override fun loadInBackground(): List<Drawable>? {
val pm = context.packageManager
val launchableAppIcons = mutableListOf<Drawable>()
val launcherIntent = Intent().apply { addCategory(Intent.CATEGORY_LAUNCHER) }
pm.getInstalledApplications(0).forEach { appInfo ->
launcherIntent.`package` = appInfo.packageName
// only show launch-able apps
if (pm.queryIntentActivities(launcherIntent, 0).isNotEmpty()) {
launchableAppIcons += appInfo.loadUnbadgedIcon(pm)
}
}
return launchableAppIcons
}
override fun deliverResult(data: List<Drawable>) {
icons += data
super.deliverResult(data)
}
}
class AppAdapter(private val icons: List<Drawable>) : RecyclerView.Adapter<AppViewHolder>() {
override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): AppViewHolder {
return AppViewHolder(LayoutInflater.from(parent.context)
.inflate(R.layout.app_item, parent, false) as IconView)
}
override fun onBindViewHolder(holder: AppViewHolder, position: Int) {
holder.iconView.icon = icons[position]
}
override fun getItemCount() = icons.size
}
class AppViewHolder(val iconView: IconView) : RecyclerView.ViewHolder(iconView)
}
View raw

(Sorry about that, but we can’t show files that are this big right now.)

@mkiisoft
Copy link

mkiisoft commented Feb 6, 2019

@MicroRJ Nick it's literally a designer and developer advocate @google for Android. BTW, Thanks Nick for this cool implementation.

@UmairAhmed420
Copy link

@nick hi there ... can you specify this implementation for single image(icon )instead of bunch of icons ?

@sylviestephanies
Copy link

@nickbutcher Hi! Thank you for sharing this. I have a question because this only applies to drawable (icon), is it possible to use the same method in FrameLayout / CardView?

I'm still a newbie in android development and I need to achieve a CardView with subtle drop shadow like 9-patch.
But 9-patch takes up space inside the card. I need to draw the shadow outside the card boundaries.

Please help out. Thank you :)

@tj3333
Copy link

tj3333 commented Jun 24, 2020

Hi @nick thank you for sharing this,
I am trying use this shadow for rectangular icon,But it always showing me square in shape

Please help me out ,Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment