/*
* Copyright 2020 The Android Open Source Project
*
* 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 androidx.compose.foundation.layout
import androidx.compose.runtime.Stable
import androidx.compose.runtime.State
import androidx.compose.runtime.mutableStateOf
import androidx.compose.ui.Modifier
import androidx.compose.ui.layout.LayoutModifier
import androidx.compose.ui.layout.Measurable
import androidx.compose.ui.layout.MeasureResult
import androidx.compose.ui.layout.MeasureScope
import androidx.compose.ui.platform.InspectorInfo
import androidx.compose.ui.platform.InspectorValueInfo
import androidx.compose.ui.platform.debugInspectorInfo
import androidx.compose.ui.unit.Constraints
import androidx.compose.ui.unit.Density
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.IntOffset
import androidx.compose.ui.unit.dp
import kotlin.math.roundToInt
/**
* Offset the content by ([x] dp, [y] dp). The offsets can be positive as well as non-positive.
* Applying an offset only changes the position of the content, without interfering with
* its size measurement.
* This modifier will automatically adjust the horizontal offset according to the layout direction.
* For a modifier that offsets without considering layout direction, see [absoluteOffset].
*
* @see absoluteOffset
*
* Example usage:
* @sample androidx.compose.foundation.layout.samples.OffsetModifier
*/
@Stable
fun Modifier.offset(x: Dp = 0.dp, y: Dp = 0.dp) = this.then(
OffsetModifier(
x = x,
y = y,
rtlAware = true,
inspectorInfo = debugInspectorInfo {
name = "offset"
properties["x"] = x
properties["y"] = y
}
)
)
/**
* Offset the content by ([x] dp, [y] dp). The offsets can be positive as well as non-positive.
* Applying an offset only changes the position of the content, without interfering with
* its size measurement.
* This modifier will not consider layout direction when calculating the position of the content.
* For a modifier that does this, see [offset].
*
* @see offset
*
* Example usage:
* @sample androidx.compose.foundation.layout.samples.AbsoluteOffsetModifier
*/
@Stable
fun Modifier.absoluteOffset(x: Dp = 0.dp, y: Dp = 0.dp) = this.then(
OffsetModifier(
x = x,
y = y,
rtlAware = false,
inspectorInfo = debugInspectorInfo {
name = "absoluteOffset"
properties["x"] = x
properties["y"] = y
}
)
)
/**
* Offset the content by [offset] px. The offsets can be positive as well as non-positive.
* Applying an offset only changes the position of the content, without interfering with
* its size measurement.
* This modifier is designed to be used for offsets that change, possibly due to user interactions,
* the advantage being that it avoids recomposition when the offset is changing.
* Note that, even if for convenience the API is accepting [Float] values, these will be rounded
* to the closest integer value before applying the offset.
* This modifier will automatically adjust the horizontal offset according to the layout direction.
* For a modifier that offsets without considering layout direction, see [absoluteOffset].
*
* @see [absoluteOffset]
*
* Example usage:
* @sample androidx.compose.foundation.layout.samples.OffsetPxModifier
*/
fun Modifier.offset(offset: Density.() -> IntOffset) = this.then(
OffsetPxModifier(
offset = offset,
rtlAware = true,
inspectorInfo = debugInspectorInfo {
name = "offset"
properties["offset"] = offset
}
)
)
@Deprecated(
"offsetPx was deprecated. Please use offset with lambda parameters instead.",
ReplaceWith(
"offset({x.value}, {y.value})",
"androidx.compose.foundation.layout.offset",
"kotlin.math.roundToInt()"
)
)
@Suppress("ModifierInspectorInfo")
fun Modifier.offsetPx(
x: State<Float> = mutableStateOf(0f),
y: State<Float> = mutableStateOf(0f)
) = this.offset { IntOffset(x.value.roundToInt(), y.value.roundToInt()) }
/**
* Offset the content by [offset] px. The offsets can be positive as well as non-positive.
* Applying an offset only changes the position of the content, without interfering with
* its size measurement.
* This modifier is designed to be used for offsets that change, possibly due to user interactions,
* the advantage being that it avoids recomposition when the offset is changing.
* Note that, even if for convenience the API is accepting [Float] values, these will be rounded
* to the closest integer value before applying the offset.
* This modifier will not consider layout direction when calculating the position of the content.
* For a modifier that does this, see [offset].
*
* @see offset
*
* Example usage:
* @sample androidx.compose.foundation.layout.samples.AbsoluteOffsetPxModifier
*/
fun Modifier.absoluteOffset(
offset: Density.() -> IntOffset
) = this.then(
OffsetPxModifier(
offset = offset,
rtlAware = false,
inspectorInfo = debugInspectorInfo {
name = "absoluteOffset"
properties["offset"] = offset
}
)
)
@Deprecated(
"absoluteOffsetPx was deprecated. Please use absoluteOffset with lambda parameters instead.",
ReplaceWith(
"absoluteOffset({x.value.roundToInt()}, {y.value.roundToInt()})",
"androidx.compose.foundation.layout.absoluteOffset",
"kotlin.math.roundToInt"
)
)
@Suppress("ModifierInspectorInfo")
fun Modifier.absoluteOffsetPx(
x: State<Float> = mutableStateOf(0f),
y: State<Float> = mutableStateOf(0f)
) = this.absoluteOffset { IntOffset(x.value.roundToInt(), y.value.roundToInt()) }
private class OffsetModifier(
val x: Dp,
val y: Dp,
val rtlAware: Boolean,
inspectorInfo: InspectorInfo.() -> Unit
) : LayoutModifier, InspectorValueInfo(inspectorInfo) {
override fun MeasureScope.measure(
measurable: Measurable,
constraints: Constraints
): MeasureResult {
val placeable = measurable.measure(constraints)
return layout(placeable.width, placeable.height) {
if (rtlAware) {
placeable.placeRelative(x.toIntPx(), y.toIntPx())
} else {
placeable.place(x.toIntPx(), y.toIntPx())
}
}
}
override fun equals(other: Any?): Boolean {
if (this === other) return true
val otherModifier = other as? OffsetModifier ?: return false
return x == otherModifier.x &&
y == otherModifier.y &&
rtlAware == otherModifier.rtlAware
}
override fun hashCode(): Int {
var result = x.hashCode()
result = 31 * result + y.hashCode()
result = 31 * result + rtlAware.hashCode()
return result
}
override fun toString(): String = "OffsetModifier(x=$x, y=$y, rtlAware=$rtlAware)"
}
private class OffsetPxModifier(
val offset: Density.() -> IntOffset,
val rtlAware: Boolean,
inspectorInfo: InspectorInfo.() -> Unit
) : LayoutModifier, InspectorValueInfo(inspectorInfo) {
override fun MeasureScope.measure(
measurable: Measurable,
constraints: Constraints
): MeasureResult {
val placeable = measurable.measure(constraints)
return layout(placeable.width, placeable.height) {
val offsetValue = offset()
if (rtlAware) {
placeable.placeRelativeWithLayer(offsetValue.x, offsetValue.y)
} else {
placeable.placeWithLayer(offsetValue.x, offsetValue.y)
}
}
}
override fun equals(other: Any?): Boolean {
if (this === other) return true
val otherModifier = other as? OffsetPxModifier ?: return false
return offset == otherModifier.offset &&
rtlAware == otherModifier.rtlAware
}
override fun hashCode(): Int {
var result = offset.hashCode()
result = 31 * result + rtlAware.hashCode()
return result
}
override fun toString(): String = "OffsetPxModifier(offset=$offset, rtlAware=$rtlAware)"
}