godot.gen.godot.XROrigin3D.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of godot-library-debug Show documentation
Contains godot api as kotlin classes and jvm cpp interaction code.
There is a newer version: 0.10.0-4.3.0
// THIS FILE IS GENERATED! DO NOT EDIT IT MANUALLY!
@file:Suppress("PackageDirectoryMismatch", "unused", "FunctionName", "RedundantModalityModifier",
    "UNCHECKED_CAST", "JoinDeclarationAndAssignment", "USELESS_CAST",
    "RemoveRedundantQualifierName", "NOTHING_TO_INLINE", "NON_FINAL_MEMBER_IN_OBJECT",
    "RedundantVisibilityModifier", "RedundantUnitReturnType", "MemberVisibilityCanBePrivate")

package godot

import godot.`annotation`.GodotBaseType
import godot.core.TypeManager
import godot.core.VariantParser.BOOL
import godot.core.VariantParser.DOUBLE
import godot.core.VariantParser.NIL
import godot.core.memory.TransferContext
import godot.util.VoidPtr
import kotlin.Boolean
import kotlin.Double
import kotlin.Float
import kotlin.Int
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName

/**
 * This is a special node within the AR/VR system that maps the physical location of the center of
 * our tracking space to the virtual location within our game world.
 * Multiple origin points can be added to the scene tree, but only one can used at a time. All the
 * [XRCamera3D], [XRController3D], and [XRAnchor3D] nodes should be direct children of this node for
 * spatial tracking to work correctly.
 * It is the position of this node that you update when your character needs to move through your
 * game world while we're not moving in the real world. Movement in the real world is always in
 * relation to this origin point.
 * For example, if your character is driving a car, the [XROrigin3D] node should be a child node of
 * this car. Or, if you're implementing a teleport system to move your character, you should change the
 * position of this node.
 */
@GodotBaseType
public open class XROrigin3D : Node3D() {
  /**
   * The scale of the game world compared to the real world. This is the same as
   * [XRServer.worldScale]. By default, most AR/VR platforms assume that 1 game unit corresponds to 1
   * real world meter.
   */
  public final inline var worldScale: Float
    @JvmName("worldScaleProperty")
    get() = getWorldScale()
    @JvmName("worldScaleProperty")
    set(`value`) {
      setWorldScale(value)
    }

  /**
   * If `true`, this origin node is currently being used by the [XRServer]. Only one origin point
   * can be used at a time.
   */
  public final inline var current: Boolean
    @JvmName("currentProperty")
    get() = isCurrent()
    @JvmName("currentProperty")
    set(`value`) {
      setCurrent(value)
    }

  public override fun new(scriptIndex: Int): Unit {
    callConstructor(ENGINECLASS_XRORIGIN3D, scriptIndex)
  }

  public final fun setWorldScale(worldScale: Float): Unit {
    TransferContext.writeArguments(DOUBLE to worldScale.toDouble())
    TransferContext.callMethod(rawPtr, MethodBindings.setWorldScalePtr, NIL)
  }

  public final fun getWorldScale(): Float {
    TransferContext.writeArguments()
    TransferContext.callMethod(rawPtr, MethodBindings.getWorldScalePtr, DOUBLE)
    return (TransferContext.readReturnValue(DOUBLE) as Double).toFloat()
  }

  public final fun setCurrent(enabled: Boolean): Unit {
    TransferContext.writeArguments(BOOL to enabled)
    TransferContext.callMethod(rawPtr, MethodBindings.setCurrentPtr, NIL)
  }

  public final fun isCurrent(): Boolean {
    TransferContext.writeArguments()
    TransferContext.callMethod(rawPtr, MethodBindings.isCurrentPtr, BOOL)
    return (TransferContext.readReturnValue(BOOL) as Boolean)
  }

  public companion object

  internal object MethodBindings {
    public val setWorldScalePtr: VoidPtr =
        TypeManager.getMethodBindPtr("XROrigin3D", "set_world_scale", 373806689)

    public val getWorldScalePtr: VoidPtr =
        TypeManager.getMethodBindPtr("XROrigin3D", "get_world_scale", 1740695150)

    public val setCurrentPtr: VoidPtr =
        TypeManager.getMethodBindPtr("XROrigin3D", "set_current", 2586408642)

    public val isCurrentPtr: VoidPtr =
        TypeManager.getMethodBindPtr("XROrigin3D", "is_current", 36873697)
  }
}