divkit.dsl.Transform.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-json-builder Show documentation
DivKit is an open source Server-Driven UI (SDUI) framework. SDUI is a an emerging technique that leverage the server to build the user interfaces of their mobile app.
There is a newer version: 30.19.0
Show newest version
@file:Suppress(
    "unused",
    "UNUSED_PARAMETER",
)

package divkit.dsl

import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.annotation.JsonValue
import divkit.dsl.annotation.*
import divkit.dsl.core.*
import divkit.dsl.scope.*
import kotlin.Any
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map

/**
 * Transformation of the element.
 * 
 * Can be created using the method [transform].
 */
@Generated
class Transform internal constructor(
    @JsonIgnore
    val properties: Properties,
) {
    @JsonAnyGetter
    internal fun getJsonProperties(): Map = properties.mergeWith(emptyMap())

    operator fun plus(additive: Properties): Transform = Transform(
        Properties(
            pivotX = additive.pivotX ?: properties.pivotX,
            pivotY = additive.pivotY ?: properties.pivotY,
            rotation = additive.rotation ?: properties.rotation,
        )
    )

    class Properties internal constructor(
        /**
         * X coordinate of the rotation axis.
         * Default value: `{"type": "pivot-percentage","value":50}`.
         */
        val pivotX: Property?,
        /**
         * Y coordinate of the rotation axis.
         * Default value: `{"type": "pivot-percentage","value":50}`.
         */
        val pivotY: Property?,
        /**
         * Degrees of the element rotation. Positive values used for clockwise rotation.
         */
        val rotation: Property?,
    ) {
        internal fun mergeWith(properties: Map): Map {
            val result = mutableMapOf()
            result.putAll(properties)
            result.tryPutProperty("pivot_x", pivotX)
            result.tryPutProperty("pivot_y", pivotY)
            result.tryPutProperty("rotation", rotation)
            return result
        }
    }
}

/**
 * @param pivotX X coordinate of the rotation axis.
 * @param pivotY Y coordinate of the rotation axis.
 * @param rotation Degrees of the element rotation. Positive values used for clockwise rotation.
 */
@Generated
fun DivScope.transform(
    `use named arguments`: Guard = Guard.instance,
    pivotX: Pivot? = null,
    pivotY: Pivot? = null,
    rotation: Double? = null,
): Transform = Transform(
    Transform.Properties(
        pivotX = valueOrNull(pivotX),
        pivotY = valueOrNull(pivotY),
        rotation = valueOrNull(rotation),
    )
)

/**
 * @param pivotX X coordinate of the rotation axis.
 * @param pivotY Y coordinate of the rotation axis.
 * @param rotation Degrees of the element rotation. Positive values used for clockwise rotation.
 */
@Generated
fun DivScope.transformProps(
    `use named arguments`: Guard = Guard.instance,
    pivotX: Pivot? = null,
    pivotY: Pivot? = null,
    rotation: Double? = null,
) = Transform.Properties(
    pivotX = valueOrNull(pivotX),
    pivotY = valueOrNull(pivotY),
    rotation = valueOrNull(rotation),
)

/**
 * @param pivotX X coordinate of the rotation axis.
 * @param pivotY Y coordinate of the rotation axis.
 * @param rotation Degrees of the element rotation. Positive values used for clockwise rotation.
 */
@Generated
fun TemplateScope.transformRefs(
    `use named arguments`: Guard = Guard.instance,
    pivotX: ReferenceProperty? = null,
    pivotY: ReferenceProperty? = null,
    rotation: ReferenceProperty? = null,
) = Transform.Properties(
    pivotX = pivotX,
    pivotY = pivotY,
    rotation = rotation,
)

/**
 * @param pivotX X coordinate of the rotation axis.
 * @param pivotY Y coordinate of the rotation axis.
 * @param rotation Degrees of the element rotation. Positive values used for clockwise rotation.
 */
@Generated
fun Transform.override(
    `use named arguments`: Guard = Guard.instance,
    pivotX: Pivot? = null,
    pivotY: Pivot? = null,
    rotation: Double? = null,
): Transform = Transform(
    Transform.Properties(
        pivotX = valueOrNull(pivotX) ?: properties.pivotX,
        pivotY = valueOrNull(pivotY) ?: properties.pivotY,
        rotation = valueOrNull(rotation) ?: properties.rotation,
    )
)

/**
 * @param pivotX X coordinate of the rotation axis.
 * @param pivotY Y coordinate of the rotation axis.
 * @param rotation Degrees of the element rotation. Positive values used for clockwise rotation.
 */
@Generated
fun Transform.defer(
    `use named arguments`: Guard = Guard.instance,
    pivotX: ReferenceProperty? = null,
    pivotY: ReferenceProperty? = null,
    rotation: ReferenceProperty? = null,
): Transform = Transform(
    Transform.Properties(
        pivotX = pivotX ?: properties.pivotX,
        pivotY = pivotY ?: properties.pivotY,
        rotation = rotation ?: properties.rotation,
    )
)

/**
 * @param rotation Degrees of the element rotation. Positive values used for clockwise rotation.
 */
@Generated
fun Transform.evaluate(
    `use named arguments`: Guard = Guard.instance,
    rotation: ExpressionProperty? = null,
): Transform = Transform(
    Transform.Properties(
        pivotX = properties.pivotX,
        pivotY = properties.pivotY,
        rotation = rotation ?: properties.rotation,
    )
)

@Generated
fun Transform.asList() = listOf(this)