Package-level declarations

Scope for Box3D's content

Depth alignment defines how an element is aligned along the depth axis (usually the Z-axis) of a three-dimensional coordinate system, and determines the offset applied to the element in that axis.

The 3D size of a layout.

The depth of this layout in the 3D coordinates space. when monitor the layout depth change, the depth will be updated. get the current depth in 3D coordinates space.

The 3D size of this layout in the 3D coordinates space. when monitor the layout size change, the size will be updated. get the current size in 3D coordinates space.

Modifier to align the element along the depth axis (usually the Z-axis) of a three-dimensional coordinate system. the default alignment is DepthAlignment.DepthCenter

A layout composable that arranges its children in a 3D space. The Box3D will size itself to fit the content, subject to the incoming constraints. For the alignments of the children layouts in the xy plane, you need to use the Box3DScope.align modifier. By default, the content will be measured without the Box3D's incoming min constraints, unless propagateMinConstraints is true. As an example, setting propagateMinConstraints to true can be useful when the Box3D has content on which modifiers cannot be specified directly and setting a min size on the content of the Box3D is needed. If propagateMinConstraints is set to true, the min size set on the Box3D will also be applied to the content, whereas otherwise the min size will only apply to the Box3D. When the content has more than one layout child, the layout children will be stacked one on top of the other (positioned as explained above) in the composition order.

Declare the preferred depth of the content to be exactly depthdp. The incoming measurement Constraints3D may override this value, forcing the content to be either smaller or larger.

Constrain the depth of the content to be between mindp and maxdp as permitted by the incoming measurement Constraints3D. If the incoming constraints are more restrictive the requested size will obey the incoming constraints and attempt to be as close as possible to the preferred size.

This is a convenience API of creating a custom LayoutModifierNode modifier which implements 3D measurement, without having to create a class or an object that implements the LayoutModifierNode interface.

Offset content by z dp

Apply all dp of additional space along each edge of the content, left, top, right, bottom, back and front. Padding is applied before content measurement and takes precedence; content may only be as large as the remaining space. Negative padding is not permitted — it will cause IllegalArgumentException. See Modifier.offset.

Apply horizontal dp space along the left and right edges of the content, and vertical dp space along the top and bottom edges, and thicknessPadding dp space along the back and front edges.

Apply additional space along each edge of the content in Dp: start, top, end, bottom, back, and front. The start and end edges will be determined by the current LayoutDirection. Padding is applied before content measurement and takes precedence; content may only be as large as the remaining space. Negative padding is not permitted — it will cause IllegalArgumentException. See Modifier.offset.

Declare the depth of the content to be exactly depthdp. The incoming measurement Constraints3D will not override this value. If the content chooses a size that does not satisfy the incoming Constraints3D, the parent layout will be reported a size coerced in the Constraints3D, and the position of the content will be automatically offset to be centered on the space assigned to the child by the parent layout under the assumption that Constraints3D were respected.

Constrain the depth of the content to be between mindp and maxdp. If the content chooses a size that does not satisfy the incoming Constraints3D, the parent layout will be reported a size coerced in the Constraints3D, and the position of the content will be automatically offset to be centered on the space assigned to the child by the parent layout under the assumption that Constraints3D were respected.

Offset content by offset px