Struct gdnative::api::InterpolatedCamera

pub struct InterpolatedCamera { /* fields omitted */ }

core class InterpolatedCamera inherits Camera (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

InterpolatedCamera is a reference-only type. Persistent references can only exist in the unsafe Ref<InterpolatedCamera> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ptr::free, or Ptr::queue_free if it is a Node.

Class hierarchy

InterpolatedCamera inherits methods from:

• Camera
• Spatial
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl InterpolatedCamera

pub fn new() -> Ref<InterpolatedCamera, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ptr::free, or preferably Ptr::queue_free if it is a Node.

pub fn speed(&self) -> f64

pub fn target_path(&self) -> NodePath

pub fn is_interpolation_enabled(&self) -> bool

pub fn set_interpolation_enabled(&self, target_path: bool)

pub fn set_speed(&self, speed: f64)

pub fn set_target(&self, target: impl AsArg<Object>)

pub fn set_target_path(&self, target_path: impl Into<NodePath>)

Methods from Deref<Target = Camera>

pub const DOPPLER_TRACKING_DISABLED: i64

pub const DOPPLER_TRACKING_IDLE_STEP: i64

pub const DOPPLER_TRACKING_PHYSICS_STEP: i64

pub const KEEP_HEIGHT: i64

pub const KEEP_WIDTH: i64

pub const PROJECTION_FRUSTUM: i64

pub const PROJECTION_ORTHOGONAL: i64

pub const PROJECTION_PERSPECTIVE: i64

pub fn clear_current(&self, enable_next: bool)

pub fn get_camera_rid(&self) -> Rid

pub fn get_camera_transform(&self) -> Transform

pub fn cull_mask(&self) -> i64

pub fn get_cull_mask_bit(&self, layer: i64) -> bool

pub fn doppler_tracking(&self) -> DopplerTracking

pub fn environment(&self) -> Option<Ref<Environment, Shared>>

pub fn fov(&self) -> f64

pub fn get_frustum(&self) -> VariantArray<Shared>

pub fn frustum_offset(&self) -> Vector2D<f32, UnknownUnit>

pub fn h_offset(&self) -> f64

pub fn keep_aspect_mode(&self) -> KeepAspect

pub fn projection(&self) -> Projection

pub fn size(&self) -> f64

pub fn v_offset(&self) -> f64

pub fn zfar(&self) -> f64

pub fn znear(&self) -> f64

pub fn is_current(&self) -> bool

pub fn is_position_behind(
    &self,
    world_point: Vector3D<f32, UnknownUnit>
) -> bool

pub fn make_current(&self)

pub fn project_local_ray_normal(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub fn project_position(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>,
    z_depth: f64
) -> Vector3D<f32, UnknownUnit>

pub fn project_ray_normal(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub fn project_ray_origin(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub fn set_cull_mask(&self, mask: i64)

pub fn set_cull_mask_bit(&self, layer: i64, enable: bool)

pub fn set_current(&self, arg0: bool)

pub fn set_doppler_tracking(&self, mode: i64)

pub fn set_environment(&self, env: impl AsArg<Environment>)

pub fn set_fov(&self, arg0: f64)

pub fn set_frustum(
    &self,
    size: f64,
    offset: Vector2D<f32, UnknownUnit>,
    z_near: f64,
    z_far: f64
)

pub fn set_frustum_offset(&self, arg0: Vector2D<f32, UnknownUnit>)

pub fn set_h_offset(&self, ofs: f64)

pub fn set_keep_aspect_mode(&self, mode: i64)

pub fn set_orthogonal(&self, size: f64, z_near: f64, z_far: f64)

pub fn set_perspective(&self, fov: f64, z_near: f64, z_far: f64)

pub fn set_projection(&self, arg0: i64)

pub fn set_size(&self, arg0: f64)

pub fn set_v_offset(&self, ofs: f64)

pub fn set_zfar(&self, arg0: f64)

pub fn set_znear(&self, arg0: f64)

pub fn unproject_position(
    &self,
    world_point: Vector3D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

Trait Implementations

impl Debug for InterpolatedCamera

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for InterpolatedCamera

type Target = Camera

The resulting type after dereferencing.

fn deref(&self) -> &Camera

Dereferences the value.

impl DerefMut for InterpolatedCamera

fn deref_mut(&mut self) -> &mut Camera

Mutably dereferences the value.

impl GodotObject for InterpolatedCamera

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for InterpolatedCamera

fn construct() -> Ref<InterpolatedCamera, Unique>

impl QueueFree for InterpolatedCamera

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<Camera> for InterpolatedCamera

impl SubClass<Node> for InterpolatedCamera

impl SubClass<Object> for InterpolatedCamera

impl SubClass<Spatial> for InterpolatedCamera