graphics.scenery.controls.behaviours.MouseRotate.kt Maven / Gradle / Ivy

Go to download
package graphics.scenery.controls.behaviours

import graphics.scenery.BoundingGrid
import graphics.scenery.Camera
import graphics.scenery.Node
import graphics.scenery.utils.lazyLogger
import org.joml.Quaternionf
import org.scijava.ui.behaviour.DragBehaviour

/**
 * Control behavior for rotating a Node
 *
 * @author Vladimir Ulman
 * @author Jan Tiemann
 */
open class MouseRotate(
    protected val name: String,
    camera: () -> Camera?,
    protected val alternativeTargetNode: (() -> Node?)? = null,
    protected var debugRaycast: Boolean = false,
    protected var ignoredObjects: List> = listOf>(BoundingGrid::class.java),
    protected val mouseSpeed: () -> Float = { 0.25f }
) : DragBehaviour, WithCameraDelegateBase(camera) {

    protected val logger by lazyLogger()

    protected var currentNode: Node? = null
    private var lastX = 0
    private var lastY = 0


    /**
     * This function is called upon mouse down and initializes the camera control
     * with the current window size.
     *
     * x position in window
     * y position in window
     */
    override fun init(x: Int, y: Int) {
        if (alternativeTargetNode != null) {
            currentNode = alternativeTargetNode.invoke()
        } else {
            cam?.let { cam ->
                val matches = cam.getNodesForScreenSpacePosition(x, y, ignoredObjects, debugRaycast)
                currentNode = matches.matches.firstOrNull()?.node
            }
        }

        lastX = x
        lastY = y
    }

    override fun drag(x: Int, y: Int) {
        val targetedNode = currentNode

        cam?.let {
            if (targetedNode == null || !targetedNode.lock.tryLock()) return

            val frameYaw = mouseSpeed() * (x - lastX) * 0.0174533f // 0.017 = PI/180
            val framePitch = mouseSpeed() * (y - lastY) * 0.0174533f

            targetedNode.ifSpatial {
                Quaternionf().rotateAxis(frameYaw, it.up)
                    .mul(rotation, rotation)
                    .normalize()
                Quaternionf().rotateAxis(framePitch, it.right)
                    .mul(rotation, rotation)
                    .normalize()
                needsUpdate = true
            }

            targetedNode.lock.unlock()

            lastX = x
            lastY = y
        }
    }

    override fun end(x: Int, y: Int) {
        // intentionally empty. A new click will overwrite the running variables.
    }
}