commonMain.dislike.DislikeAnalyzer.kt Maven / Gradle / Ivy
/*
* Copyright (c) 2024, Google LLC, OpenSavvy and contributors.
*
* 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 opensavvy.material3.colors.dislike
import opensavvy.material3.colors.hct.Hct
import kotlin.math.round
/**
* Check and/or fix universally disliked colors.
*
*
* Color science studies of color preference indicate universal distaste for dark yellow-greens,
* and also show this is correlated to distate for biological waste and rotting food.
*
*
* See Palmer and Schloss, 2010 or Schloss and Palmer's Chapter 21 in Handbook of Color
* Psychology (2015).
*/
class DislikeAnalyzer private constructor() {
init {
throw UnsupportedOperationException()
}
companion object {
/**
* Returns true if color is disliked.
*
*
* Disliked is defined as a dark yellow-green that is not neutral.
*/
fun isDisliked(hct: Hct): Boolean {
val huePasses = round(hct.hue) >= 90.0 && round(hct.hue) <= 111.0
val chromaPasses: Boolean = round(hct.chroma) > 16.0
val tonePasses: Boolean = round(hct.tone) < 65.0
return huePasses && chromaPasses && tonePasses
}
/** If color is disliked, lighten it to make it likable. */
fun fixIfDisliked(hct: Hct): Hct {
if (isDisliked(hct)) {
return Hct(hct.hue, hct.chroma, 70.0)
}
return hct
}
}
}