godot.gen.godot.Camera3D.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
Show all versions of godot-library-debug Show documentation
Contains godot api as kotlin classes and jvm cpp interaction code.
// 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`.CoreTypeHelper
import godot.`annotation`.CoreTypeLocalCopy
import godot.`annotation`.GodotBaseType
import godot.core.Plane
import godot.core.Projection
import godot.core.RID
import godot.core.Transform3D
import godot.core.TypeManager
import godot.core.VariantArray
import godot.core.VariantParser.ARRAY
import godot.core.VariantParser.BOOL
import godot.core.VariantParser.DOUBLE
import godot.core.VariantParser.LONG
import godot.core.VariantParser.NIL
import godot.core.VariantParser.OBJECT
import godot.core.VariantParser.PROJECTION
import godot.core.VariantParser.TRANSFORM3D
import godot.core.VariantParser.VECTOR2
import godot.core.VariantParser.VECTOR3
import godot.core.VariantParser._RID
import godot.core.Vector2
import godot.core.Vector3
import godot.core.memory.TransferContext
import godot.util.VoidPtr
import kotlin.Boolean
import kotlin.Double
import kotlin.Float
import kotlin.Int
import kotlin.Long
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName
import kotlin.jvm.JvmOverloads
/**
* [Camera3D] is a special node that displays what is visible from its current location. Cameras
* register themselves in the nearest [Viewport] node (when ascending the tree). Only one camera can be
* active per viewport. If no viewport is available ascending the tree, the camera will register in the
* global viewport. In other words, a camera just provides 3D display capabilities to a [Viewport],
* and, without one, a scene registered in that [Viewport] (or higher viewports) can't be displayed.
*/
@GodotBaseType
public open class Camera3D : Node3D() {
/**
* The axis to lock during [fov]/[size] adjustments. Can be either [KEEP_WIDTH] or [KEEP_HEIGHT].
*/
public final inline var keepAspect: KeepAspect
@JvmName("keepAspectProperty")
get() = getKeepAspectMode()
@JvmName("keepAspectProperty")
set(`value`) {
setKeepAspectMode(value)
}
/**
* The culling mask that describes which [VisualInstance3D.layers] are rendered by this camera. By
* default, all 20 user-visible layers are rendered.
* **Note:** Since the [cullMask] allows for 32 layers to be stored in total, there are an
* additional 12 layers that are only used internally by the engine and aren't exposed in the editor.
* Setting [cullMask] using a script allows you to toggle those reserved layers, which can be useful
* for editor plugins.
* To adjust [cullMask] more easily using a script, use [getCullMaskValue] and [setCullMaskValue].
* **Note:** [VoxelGI], SDFGI and [LightmapGI] will always take all layers into account to
* determine what contributes to global illumination. If this is an issue, set
* [GeometryInstance3D.giMode] to [GeometryInstance3D.GI_MODE_DISABLED] for meshes and
* [Light3D.lightBakeMode] to [Light3D.BAKE_DISABLED] for lights to exclude them from global
* illumination.
*/
public final inline var cullMask: Long
@JvmName("cullMaskProperty")
get() = getCullMask()
@JvmName("cullMaskProperty")
set(`value`) {
setCullMask(value)
}
/**
* The [Environment] to use for this camera.
*/
public final inline var environment: Environment?
@JvmName("environmentProperty")
get() = getEnvironment()
@JvmName("environmentProperty")
set(`value`) {
setEnvironment(value)
}
/**
* The [CameraAttributes] to use for this camera.
*/
public final inline var attributes: CameraAttributes?
@JvmName("attributesProperty")
get() = getAttributes()
@JvmName("attributesProperty")
set(`value`) {
setAttributes(value)
}
/**
* The [Compositor] to use for this camera.
*/
public final inline var compositor: Compositor?
@JvmName("compositorProperty")
get() = getCompositor()
@JvmName("compositorProperty")
set(`value`) {
setCompositor(value)
}
/**
* The horizontal (X) offset of the camera viewport.
*/
public final inline var hOffset: Float
@JvmName("hOffsetProperty")
get() = getHOffset()
@JvmName("hOffsetProperty")
set(`value`) {
setHOffset(value)
}
/**
* The vertical (Y) offset of the camera viewport.
*/
public final inline var vOffset: Float
@JvmName("vOffsetProperty")
get() = getVOffset()
@JvmName("vOffsetProperty")
set(`value`) {
setVOffset(value)
}
/**
* If not [DOPPLER_TRACKING_DISABLED], this camera will simulate the
* [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] for objects changed in
* particular `_process` methods. See [DopplerTracking] for possible values.
*/
public final inline var dopplerTracking: DopplerTracking
@JvmName("dopplerTrackingProperty")
get() = getDopplerTracking()
@JvmName("dopplerTrackingProperty")
set(`value`) {
setDopplerTracking(value)
}
/**
* The camera's projection mode. In [PROJECTION_PERSPECTIVE] mode, objects' Z distance from the
* camera's local space scales their perceived size.
*/
public final inline var projection: ProjectionType
@JvmName("projectionProperty")
get() = getProjection()
@JvmName("projectionProperty")
set(`value`) {
setProjection(value)
}
/**
* If `true`, the ancestor [Viewport] is currently using this camera.
* If multiple cameras are in the scene, one will always be made current. For example, if two
* [Camera3D] nodes are present in the scene and only one is current, setting one camera's [current]
* to `false` will cause the other camera to be made current.
*/
public final inline var current: Boolean
@JvmName("currentProperty")
get() = isCurrent()
@JvmName("currentProperty")
set(`value`) {
setCurrent(value)
}
/**
* The camera's field of view angle (in degrees). Only applicable in perspective mode. Since
* [keepAspect] locks one axis, [fov] sets the other axis' field of view angle.
* For reference, the default vertical field of view value (`75.0`) is equivalent to a horizontal
* FOV of:
* - ~91.31 degrees in a 4:3 viewport
* - ~101.67 degrees in a 16:10 viewport
* - ~107.51 degrees in a 16:9 viewport
* - ~121.63 degrees in a 21:9 viewport
*/
public final inline var fov: Float
@JvmName("fovProperty")
get() = getFov()
@JvmName("fovProperty")
set(`value`) {
setFov(value)
}
/**
* The camera's size in meters measured as the diameter of the width or height, depending on
* [keepAspect]. Only applicable in orthogonal and frustum modes.
*/
public final inline var size: Float
@JvmName("sizeProperty")
get() = getSize()
@JvmName("sizeProperty")
set(`value`) {
setSize(value)
}
/**
* The camera's frustum offset. This can be changed from the default to create "tilted frustum"
* effects such as [url=https://zdoom.org/wiki/Y-shearing]Y-shearing[/url].
* **Note:** Only effective if [projection] is [PROJECTION_FRUSTUM].
*/
@CoreTypeLocalCopy
public final inline var frustumOffset: Vector2
@JvmName("frustumOffsetProperty")
get() = getFrustumOffset()
@JvmName("frustumOffsetProperty")
set(`value`) {
setFrustumOffset(value)
}
/**
* The distance to the near culling boundary for this camera relative to its local Z axis. Lower
* values allow the camera to see objects more up close to its origin, at the cost of lower precision
* across the *entire* range. Values lower than the default can lead to increased Z-fighting.
*/
public final inline var near: Float
@JvmName("nearProperty")
get() = getNear()
@JvmName("nearProperty")
set(`value`) {
setNear(value)
}
/**
* The distance to the far culling boundary for this camera relative to its local Z axis. Higher
* values allow the camera to see further away, while decreasing [far] can improve performance if it
* results in objects being partially or fully culled.
*/
public final inline var far: Float
@JvmName("farProperty")
get() = getFar()
@JvmName("farProperty")
set(`value`) {
setFar(value)
}
public override fun new(scriptIndex: Int): Unit {
callConstructor(ENGINECLASS_CAMERA3D, scriptIndex)
}
/**
* The camera's frustum offset. This can be changed from the default to create "tilted frustum"
* effects such as [url=https://zdoom.org/wiki/Y-shearing]Y-shearing[/url].
* **Note:** Only effective if [projection] is [PROJECTION_FRUSTUM].
*
* This is a helper function to make dealing with local copies easier.
*
* For more information, see our
* [documentation](https://godot-kotl.in/en/stable/user-guide/api-differences/#core-types).
*
* Allow to directly modify the local copy of the property and assign it back to the Object.
*
* Prefer that over writing:
* ``````
* val myCoreType = camera3d.frustumOffset
* //Your changes
* camera3d.frustumOffset = myCoreType
* ``````
*/
@CoreTypeHelper
public final fun frustumOffsetMutate(block: Vector2.() -> Unit): Vector2 = frustumOffset.apply{
block(this)
frustumOffset = this
}
/**
* Returns a normal vector in world space, that is the result of projecting a point on the
* [Viewport] rectangle by the inverse camera projection. This is useful for casting rays in the form
* of (origin, normal) for object intersection or picking.
*/
public final fun projectRayNormal(screenPoint: Vector2): Vector3 {
TransferContext.writeArguments(VECTOR2 to screenPoint)
TransferContext.callMethod(rawPtr, MethodBindings.projectRayNormalPtr, VECTOR3)
return (TransferContext.readReturnValue(VECTOR3) as Vector3)
}
/**
* Returns a normal vector from the screen point location directed along the camera. Orthogonal
* cameras are normalized. Perspective cameras account for perspective, screen width/height, etc.
*/
public final fun projectLocalRayNormal(screenPoint: Vector2): Vector3 {
TransferContext.writeArguments(VECTOR2 to screenPoint)
TransferContext.callMethod(rawPtr, MethodBindings.projectLocalRayNormalPtr, VECTOR3)
return (TransferContext.readReturnValue(VECTOR3) as Vector3)
}
/**
* Returns a 3D position in world space, that is the result of projecting a point on the
* [Viewport] rectangle by the inverse camera projection. This is useful for casting rays in the form
* of (origin, normal) for object intersection or picking.
*/
public final fun projectRayOrigin(screenPoint: Vector2): Vector3 {
TransferContext.writeArguments(VECTOR2 to screenPoint)
TransferContext.callMethod(rawPtr, MethodBindings.projectRayOriginPtr, VECTOR3)
return (TransferContext.readReturnValue(VECTOR3) as Vector3)
}
/**
* Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in world
* space.
* **Note:** When using this to position GUI elements over a 3D viewport, use [isPositionBehind]
* to prevent them from appearing if the 3D point is behind the camera:
* [codeblock]
* # This code block is part of a script that inherits from Node3D.
* # `control` is a reference to a node inheriting from Control.
* control.visible = not
* get_viewport().get_camera_3d().is_position_behind(global_transform.origin)
* control.position = get_viewport().get_camera_3d().unproject_position(global_transform.origin)
* [/codeblock]
*/
public final fun unprojectPosition(worldPoint: Vector3): Vector2 {
TransferContext.writeArguments(VECTOR3 to worldPoint)
TransferContext.callMethod(rawPtr, MethodBindings.unprojectPositionPtr, VECTOR2)
return (TransferContext.readReturnValue(VECTOR2) as Vector2)
}
/**
* Returns `true` if the given position is behind the camera (the blue part of the linked
* diagram).
* [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See
* this diagram[/url] for an overview of position query methods.
* **Note:** A position which returns `false` may still be outside the camera's field of view.
*/
public final fun isPositionBehind(worldPoint: Vector3): Boolean {
TransferContext.writeArguments(VECTOR3 to worldPoint)
TransferContext.callMethod(rawPtr, MethodBindings.isPositionBehindPtr, BOOL)
return (TransferContext.readReturnValue(BOOL) as Boolean)
}
/**
* Returns the 3D point in world space that maps to the given 2D coordinate in the [Viewport]
* rectangle on a plane that is the given [zDepth] distance into the scene away from the camera.
*/
public final fun projectPosition(screenPoint: Vector2, zDepth: Float): Vector3 {
TransferContext.writeArguments(VECTOR2 to screenPoint, DOUBLE to zDepth.toDouble())
TransferContext.callMethod(rawPtr, MethodBindings.projectPositionPtr, VECTOR3)
return (TransferContext.readReturnValue(VECTOR3) as Vector3)
}
/**
* Sets the camera projection to perspective mode (see [PROJECTION_PERSPECTIVE]), by specifying a
* [fov] (field of view) angle in degrees, and the [zNear] and [zFar] clip planes in world space
* units.
*/
public final fun setPerspective(
fov: Float,
zNear: Float,
zFar: Float,
): Unit {
TransferContext.writeArguments(DOUBLE to fov.toDouble(), DOUBLE to zNear.toDouble(), DOUBLE to zFar.toDouble())
TransferContext.callMethod(rawPtr, MethodBindings.setPerspectivePtr, NIL)
}
/**
* Sets the camera projection to orthogonal mode (see [PROJECTION_ORTHOGONAL]), by specifying a
* [size], and the [zNear] and [zFar] clip planes in world space units. (As a hint, 2D games often
* use this projection, with values specified in pixels.)
*/
public final fun setOrthogonal(
size: Float,
zNear: Float,
zFar: Float,
): Unit {
TransferContext.writeArguments(DOUBLE to size.toDouble(), DOUBLE to zNear.toDouble(), DOUBLE to zFar.toDouble())
TransferContext.callMethod(rawPtr, MethodBindings.setOrthogonalPtr, NIL)
}
/**
* Sets the camera projection to frustum mode (see [PROJECTION_FRUSTUM]), by specifying a [size],
* an [offset], and the [zNear] and [zFar] clip planes in world space units. See also
* [frustumOffset].
*/
public final fun setFrustum(
size: Float,
offset: Vector2,
zNear: Float,
zFar: Float,
): Unit {
TransferContext.writeArguments(DOUBLE to size.toDouble(), VECTOR2 to offset, DOUBLE to zNear.toDouble(), DOUBLE to zFar.toDouble())
TransferContext.callMethod(rawPtr, MethodBindings.setFrustumPtr, NIL)
}
/**
* Makes this camera the current camera for the [Viewport] (see class description). If the camera
* node is outside the scene tree, it will attempt to become current once it's added.
*/
public final fun makeCurrent(): Unit {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.makeCurrentPtr, NIL)
}
/**
* If this is the current camera, remove it from being current. If [enableNext] is `true`, request
* to make the next camera current, if any.
*/
@JvmOverloads
public final fun clearCurrent(enableNext: Boolean = true): Unit {
TransferContext.writeArguments(BOOL to enableNext)
TransferContext.callMethod(rawPtr, MethodBindings.clearCurrentPtr, NIL)
}
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)
}
/**
* Returns the transform of the camera plus the vertical ([vOffset]) and horizontal ([hOffset])
* offsets; and any other adjustments made to the position and orientation of the camera by
* subclassed cameras such as [XRCamera3D].
*/
public final fun getCameraTransform(): Transform3D {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getCameraTransformPtr, TRANSFORM3D)
return (TransferContext.readReturnValue(TRANSFORM3D) as Transform3D)
}
/**
* Returns the projection matrix that this camera uses to render to its associated viewport. The
* camera must be part of the scene tree to function.
*/
public final fun getCameraProjection(): Projection {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getCameraProjectionPtr, PROJECTION)
return (TransferContext.readReturnValue(PROJECTION) as Projection)
}
public final fun getFov(): Float {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getFovPtr, DOUBLE)
return (TransferContext.readReturnValue(DOUBLE) as Double).toFloat()
}
public final fun getFrustumOffset(): Vector2 {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getFrustumOffsetPtr, VECTOR2)
return (TransferContext.readReturnValue(VECTOR2) as Vector2)
}
public final fun getSize(): Float {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getSizePtr, DOUBLE)
return (TransferContext.readReturnValue(DOUBLE) as Double).toFloat()
}
public final fun getFar(): Float {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getFarPtr, DOUBLE)
return (TransferContext.readReturnValue(DOUBLE) as Double).toFloat()
}
public final fun getNear(): Float {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getNearPtr, DOUBLE)
return (TransferContext.readReturnValue(DOUBLE) as Double).toFloat()
}
public final fun setFov(fov: Float): Unit {
TransferContext.writeArguments(DOUBLE to fov.toDouble())
TransferContext.callMethod(rawPtr, MethodBindings.setFovPtr, NIL)
}
public final fun setFrustumOffset(offset: Vector2): Unit {
TransferContext.writeArguments(VECTOR2 to offset)
TransferContext.callMethod(rawPtr, MethodBindings.setFrustumOffsetPtr, NIL)
}
public final fun setSize(size: Float): Unit {
TransferContext.writeArguments(DOUBLE to size.toDouble())
TransferContext.callMethod(rawPtr, MethodBindings.setSizePtr, NIL)
}
public final fun setFar(far: Float): Unit {
TransferContext.writeArguments(DOUBLE to far.toDouble())
TransferContext.callMethod(rawPtr, MethodBindings.setFarPtr, NIL)
}
public final fun setNear(near: Float): Unit {
TransferContext.writeArguments(DOUBLE to near.toDouble())
TransferContext.callMethod(rawPtr, MethodBindings.setNearPtr, NIL)
}
public final fun getProjection(): ProjectionType {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getProjectionPtr, LONG)
return Camera3D.ProjectionType.from(TransferContext.readReturnValue(LONG) as Long)
}
public final fun setProjection(mode: ProjectionType): Unit {
TransferContext.writeArguments(LONG to mode.id)
TransferContext.callMethod(rawPtr, MethodBindings.setProjectionPtr, NIL)
}
public final fun setHOffset(offset: Float): Unit {
TransferContext.writeArguments(DOUBLE to offset.toDouble())
TransferContext.callMethod(rawPtr, MethodBindings.setHOffsetPtr, NIL)
}
public final fun getHOffset(): Float {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getHOffsetPtr, DOUBLE)
return (TransferContext.readReturnValue(DOUBLE) as Double).toFloat()
}
public final fun setVOffset(offset: Float): Unit {
TransferContext.writeArguments(DOUBLE to offset.toDouble())
TransferContext.callMethod(rawPtr, MethodBindings.setVOffsetPtr, NIL)
}
public final fun getVOffset(): Float {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getVOffsetPtr, DOUBLE)
return (TransferContext.readReturnValue(DOUBLE) as Double).toFloat()
}
public final fun setCullMask(mask: Long): Unit {
TransferContext.writeArguments(LONG to mask)
TransferContext.callMethod(rawPtr, MethodBindings.setCullMaskPtr, NIL)
}
public final fun getCullMask(): Long {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getCullMaskPtr, LONG)
return (TransferContext.readReturnValue(LONG) as Long)
}
public final fun setEnvironment(env: Environment?): Unit {
TransferContext.writeArguments(OBJECT to env)
TransferContext.callMethod(rawPtr, MethodBindings.setEnvironmentPtr, NIL)
}
public final fun getEnvironment(): Environment? {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getEnvironmentPtr, OBJECT)
return (TransferContext.readReturnValue(OBJECT) as Environment?)
}
public final fun setAttributes(env: CameraAttributes?): Unit {
TransferContext.writeArguments(OBJECT to env)
TransferContext.callMethod(rawPtr, MethodBindings.setAttributesPtr, NIL)
}
public final fun getAttributes(): CameraAttributes? {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getAttributesPtr, OBJECT)
return (TransferContext.readReturnValue(OBJECT) as CameraAttributes?)
}
public final fun setCompositor(compositor: Compositor?): Unit {
TransferContext.writeArguments(OBJECT to compositor)
TransferContext.callMethod(rawPtr, MethodBindings.setCompositorPtr, NIL)
}
public final fun getCompositor(): Compositor? {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getCompositorPtr, OBJECT)
return (TransferContext.readReturnValue(OBJECT) as Compositor?)
}
public final fun setKeepAspectMode(mode: KeepAspect): Unit {
TransferContext.writeArguments(LONG to mode.id)
TransferContext.callMethod(rawPtr, MethodBindings.setKeepAspectModePtr, NIL)
}
public final fun getKeepAspectMode(): KeepAspect {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getKeepAspectModePtr, LONG)
return Camera3D.KeepAspect.from(TransferContext.readReturnValue(LONG) as Long)
}
public final fun setDopplerTracking(mode: DopplerTracking): Unit {
TransferContext.writeArguments(LONG to mode.id)
TransferContext.callMethod(rawPtr, MethodBindings.setDopplerTrackingPtr, NIL)
}
public final fun getDopplerTracking(): DopplerTracking {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getDopplerTrackingPtr, LONG)
return Camera3D.DopplerTracking.from(TransferContext.readReturnValue(LONG) as Long)
}
/**
* Returns the camera's frustum planes in world space units as an array of [Plane]s in the
* following order: near, far, left, top, right, bottom. Not to be confused with [frustumOffset].
*/
public final fun getFrustum(): VariantArray {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getFrustumPtr, ARRAY)
return (TransferContext.readReturnValue(ARRAY) as VariantArray)
}
/**
* Returns `true` if the given position is inside the camera's frustum (the green part of the
* linked diagram).
* [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See
* this diagram[/url] for an overview of position query methods.
*/
public final fun isPositionInFrustum(worldPoint: Vector3): Boolean {
TransferContext.writeArguments(VECTOR3 to worldPoint)
TransferContext.callMethod(rawPtr, MethodBindings.isPositionInFrustumPtr, BOOL)
return (TransferContext.readReturnValue(BOOL) as Boolean)
}
/**
* Returns the camera's RID from the [RenderingServer].
*/
public final fun getCameraRid(): RID {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getCameraRidPtr, _RID)
return (TransferContext.readReturnValue(_RID) as RID)
}
/**
* Returns the RID of a pyramid shape encompassing the camera's view frustum, ignoring the
* camera's near plane. The tip of the pyramid represents the position of the camera.
*/
public final fun getPyramidShapeRid(): RID {
TransferContext.writeArguments()
TransferContext.callMethod(rawPtr, MethodBindings.getPyramidShapeRidPtr, _RID)
return (TransferContext.readReturnValue(_RID) as RID)
}
/**
* Based on [value], enables or disables the specified layer in the [cullMask], given a
* [layerNumber] between 1 and 20.
*/
public final fun setCullMaskValue(layerNumber: Int, `value`: Boolean): Unit {
TransferContext.writeArguments(LONG to layerNumber.toLong(), BOOL to value)
TransferContext.callMethod(rawPtr, MethodBindings.setCullMaskValuePtr, NIL)
}
/**
* Returns whether or not the specified layer of the [cullMask] is enabled, given a [layerNumber]
* between 1 and 20.
*/
public final fun getCullMaskValue(layerNumber: Int): Boolean {
TransferContext.writeArguments(LONG to layerNumber.toLong())
TransferContext.callMethod(rawPtr, MethodBindings.getCullMaskValuePtr, BOOL)
return (TransferContext.readReturnValue(BOOL) as Boolean)
}
public enum class ProjectionType(
id: Long,
) {
/**
* Perspective projection. Objects on the screen becomes smaller when they are far away.
*/
PROJECTION_PERSPECTIVE(0),
/**
* Orthogonal projection, also known as orthographic projection. Objects remain the same size on
* the screen no matter how far away they are.
*/
PROJECTION_ORTHOGONAL(1),
/**
* Frustum projection. This mode allows adjusting [frustumOffset] to create "tilted frustum"
* effects.
*/
PROJECTION_FRUSTUM(2),
;
public val id: Long
init {
this.id = id
}
public companion object {
public fun from(`value`: Long): ProjectionType = entries.single { it.id == `value` }
}
}
public enum class KeepAspect(
id: Long,
) {
/**
* Preserves the horizontal aspect ratio; also known as Vert- scaling. This is usually the best
* option for projects running in portrait mode, as taller aspect ratios will benefit from a wider
* vertical FOV.
*/
KEEP_WIDTH(0),
/**
* Preserves the vertical aspect ratio; also known as Hor+ scaling. This is usually the best
* option for projects running in landscape mode, as wider aspect ratios will automatically benefit
* from a wider horizontal FOV.
*/
KEEP_HEIGHT(1),
;
public val id: Long
init {
this.id = id
}
public companion object {
public fun from(`value`: Long): KeepAspect = entries.single { it.id == `value` }
}
}
public enum class DopplerTracking(
id: Long,
) {
/**
* Disables [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] simulation
* (default).
*/
DOPPLER_TRACKING_DISABLED(0),
/**
* Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking
* positions of objects that are changed in `_process`. Changes in the relative velocity of this
* camera compared to those objects affect how audio is perceived (changing the audio's
* [AudioStreamPlayer3D.pitchScale]).
*/
DOPPLER_TRACKING_IDLE_STEP(1),
/**
* Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking
* positions of objects that are changed in `_physics_process`. Changes in the relative velocity of
* this camera compared to those objects affect how audio is perceived (changing the audio's
* [AudioStreamPlayer3D.pitchScale]).
*/
DOPPLER_TRACKING_PHYSICS_STEP(2),
;
public val id: Long
init {
this.id = id
}
public companion object {
public fun from(`value`: Long): DopplerTracking = entries.single { it.id == `value` }
}
}
public companion object
internal object MethodBindings {
public val projectRayNormalPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "project_ray_normal", 1718073306)
public val projectLocalRayNormalPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "project_local_ray_normal", 1718073306)
public val projectRayOriginPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "project_ray_origin", 1718073306)
public val unprojectPositionPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "unproject_position", 3758901831)
public val isPositionBehindPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "is_position_behind", 3108956480)
public val projectPositionPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "project_position", 2171975744)
public val setPerspectivePtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_perspective", 2385087082)
public val setOrthogonalPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_orthogonal", 2385087082)
public val setFrustumPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_frustum", 354890663)
public val makeCurrentPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "make_current", 3218959716)
public val clearCurrentPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "clear_current", 3216645846)
public val setCurrentPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_current", 2586408642)
public val isCurrentPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "is_current", 36873697)
public val getCameraTransformPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_camera_transform", 3229777777)
public val getCameraProjectionPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_camera_projection", 2910717950)
public val getFovPtr: VoidPtr = TypeManager.getMethodBindPtr("Camera3D", "get_fov", 1740695150)
public val getFrustumOffsetPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_frustum_offset", 3341600327)
public val getSizePtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_size", 1740695150)
public val getFarPtr: VoidPtr = TypeManager.getMethodBindPtr("Camera3D", "get_far", 1740695150)
public val getNearPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_near", 1740695150)
public val setFovPtr: VoidPtr = TypeManager.getMethodBindPtr("Camera3D", "set_fov", 373806689)
public val setFrustumOffsetPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_frustum_offset", 743155724)
public val setSizePtr: VoidPtr = TypeManager.getMethodBindPtr("Camera3D", "set_size", 373806689)
public val setFarPtr: VoidPtr = TypeManager.getMethodBindPtr("Camera3D", "set_far", 373806689)
public val setNearPtr: VoidPtr = TypeManager.getMethodBindPtr("Camera3D", "set_near", 373806689)
public val getProjectionPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_projection", 2624185235)
public val setProjectionPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_projection", 4218540108)
public val setHOffsetPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_h_offset", 373806689)
public val getHOffsetPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_h_offset", 1740695150)
public val setVOffsetPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_v_offset", 373806689)
public val getVOffsetPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_v_offset", 1740695150)
public val setCullMaskPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_cull_mask", 1286410249)
public val getCullMaskPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_cull_mask", 3905245786)
public val setEnvironmentPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_environment", 4143518816)
public val getEnvironmentPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_environment", 3082064660)
public val setAttributesPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_attributes", 2817810567)
public val getAttributesPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_attributes", 3921283215)
public val setCompositorPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_compositor", 1586754307)
public val getCompositorPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_compositor", 3647707413)
public val setKeepAspectModePtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_keep_aspect_mode", 1740651252)
public val getKeepAspectModePtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_keep_aspect_mode", 2790278316)
public val setDopplerTrackingPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_doppler_tracking", 3109431270)
public val getDopplerTrackingPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_doppler_tracking", 1584483649)
public val getFrustumPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_frustum", 3995934104)
public val isPositionInFrustumPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "is_position_in_frustum", 3108956480)
public val getCameraRidPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_camera_rid", 2944877500)
public val getPyramidShapeRidPtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_pyramid_shape_rid", 529393457)
public val setCullMaskValuePtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "set_cull_mask_value", 300928843)
public val getCullMaskValuePtr: VoidPtr =
TypeManager.getMethodBindPtr("Camera3D", "get_cull_mask_value", 1116898809)
}
}