Struct gdnative_bindings::GridMap

pub struct GridMap { /* fields omitted */ }

core class GridMap inherits Spatial (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.

GridMap is an unsafe pointer, and all of its methods are unsafe.

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 GridMap::free.

Class hierarchy

GridMap inherits methods from:

• Spatial
• Node
• Object

Methods

impl GridMap

Constants

pub const INVALID_CELL_ITEM: i64

impl GridMap

pub fn new() -> Self

Constructor.

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 GridMap::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _update_octants_callback(&mut self)

pub unsafe fn clear(&mut self)

pub unsafe fn clear_baked_meshes(&mut self)

pub unsafe fn get_bake_mesh_instance(&mut self, idx: i64) -> Rid

pub unsafe fn get_bake_meshes(&mut self) -> VariantArray

pub unsafe fn get_cell_item(&self, x: i64, y: i64, z: i64) -> i64

pub unsafe fn get_cell_item_orientation(&self, x: i64, y: i64, z: i64) -> i64

pub unsafe fn get_cell_scale(&self) -> f64

pub unsafe fn get_cell_size(&self) -> Vector3

pub unsafe fn get_center_x(&self) -> bool

pub unsafe fn get_center_y(&self) -> bool

pub unsafe fn get_center_z(&self) -> bool

pub unsafe fn get_collision_layer(&self) -> i64

pub unsafe fn get_collision_layer_bit(&self, bit: i64) -> bool

pub unsafe fn get_collision_mask(&self) -> i64

pub unsafe fn get_collision_mask_bit(&self, bit: i64) -> bool

pub unsafe fn get_mesh_library(&self) -> Option<MeshLibrary>

pub unsafe fn get_meshes(&mut self) -> VariantArray

pub unsafe fn get_octant_size(&self) -> i64

pub unsafe fn get_theme(&self) -> Option<MeshLibrary>

pub unsafe fn get_used_cells(&self) -> VariantArray

pub unsafe fn make_baked_meshes(
    &mut self,
    gen_lightmap_uv: bool,
    lightmap_uv_texel_size: f64
)

pub unsafe fn map_to_world(&self, x: i64, y: i64, z: i64) -> Vector3

pub unsafe fn resource_changed(&mut self, resource: Option<Resource>)

pub unsafe fn set_cell_item(
    &mut self,
    x: i64,
    y: i64,
    z: i64,
    item: i64,
    orientation: i64
)

pub unsafe fn set_cell_scale(&mut self, scale: f64)

pub unsafe fn set_cell_size(&mut self, size: Vector3)

pub unsafe fn set_center_x(&mut self, enable: bool)

pub unsafe fn set_center_y(&mut self, enable: bool)

pub unsafe fn set_center_z(&mut self, enable: bool)

pub unsafe fn set_clip(
    &mut self,
    enabled: bool,
    clipabove: bool,
    floor: i64,
    axis: i64
)

pub unsafe fn set_collision_layer(&mut self, layer: i64)

pub unsafe fn set_collision_layer_bit(&mut self, bit: i64, value: bool)

pub unsafe fn set_collision_mask(&mut self, mask: i64)

pub unsafe fn set_collision_mask_bit(&mut self, bit: i64, value: bool)

pub unsafe fn set_mesh_library(&mut self, mesh_library: Option<MeshLibrary>)

pub unsafe fn set_octant_size(&mut self, size: i64)

pub unsafe fn set_theme(&mut self, theme: Option<MeshLibrary>)

pub unsafe fn world_to_map(&self, pos: Vector3) -> Vector3

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Methods from Deref<Target = Spatial>

pub const NOTIFICATION_ENTER_WORLD: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_EXIT_WORLD: i64

pub unsafe fn _update_gizmo(&mut self)

pub unsafe fn force_update_transform(&mut self)

pub unsafe fn get_gizmo(&self) -> Option<SpatialGizmo>

pub unsafe fn get_global_transform(&self) -> Transform

pub unsafe fn get_parent_spatial(&self) -> Option<Spatial>

pub unsafe fn get_rotation(&self) -> Vector3

pub unsafe fn get_rotation_degrees(&self) -> Vector3

pub unsafe fn get_scale(&self) -> Vector3

pub unsafe fn get_transform(&self) -> Transform

pub unsafe fn get_translation(&self) -> Vector3

pub unsafe fn get_world(&self) -> Option<World>

pub unsafe fn global_rotate(&mut self, axis: Vector3, angle: f64)

pub unsafe fn global_scale(&mut self, scale: Vector3)

pub unsafe fn global_translate(&mut self, offset: Vector3)

pub unsafe fn hide(&mut self)

pub unsafe fn is_local_transform_notification_enabled(&self) -> bool

pub unsafe fn is_scale_disabled(&self) -> bool

pub unsafe fn is_set_as_toplevel(&self) -> bool

pub unsafe fn is_transform_notification_enabled(&self) -> bool

pub unsafe fn is_visible(&self) -> bool

pub unsafe fn is_visible_in_tree(&self) -> bool

pub unsafe fn look_at(&mut self, target: Vector3, up: Vector3)

pub unsafe fn look_at_from_position(
    &mut self,
    position: Vector3,
    target: Vector3,
    up: Vector3
)

pub unsafe fn orthonormalize(&mut self)

pub unsafe fn rotate(&mut self, axis: Vector3, angle: f64)

pub unsafe fn rotate_object_local(&mut self, axis: Vector3, angle: f64)

pub unsafe fn rotate_x(&mut self, angle: f64)

pub unsafe fn rotate_y(&mut self, angle: f64)

pub unsafe fn rotate_z(&mut self, angle: f64)

pub unsafe fn scale_object_local(&mut self, scale: Vector3)

pub unsafe fn set_as_toplevel(&mut self, enable: bool)

pub unsafe fn set_disable_scale(&mut self, disable: bool)

pub unsafe fn set_gizmo(&mut self, gizmo: Option<SpatialGizmo>)

pub unsafe fn set_global_transform(&mut self, global: Transform)

pub unsafe fn set_identity(&mut self)

pub unsafe fn set_ignore_transform_notification(&mut self, enabled: bool)

pub unsafe fn set_notify_local_transform(&mut self, enable: bool)

pub unsafe fn set_notify_transform(&mut self, enable: bool)

pub unsafe fn set_rotation(&mut self, euler: Vector3)

pub unsafe fn set_rotation_degrees(&mut self, euler_degrees: Vector3)

pub unsafe fn set_scale(&mut self, scale: Vector3)

pub unsafe fn set_transform(&mut self, local: Transform)

pub unsafe fn set_translation(&mut self, translation: Vector3)

pub unsafe fn set_visible(&mut self, visible: bool)

pub unsafe fn show(&mut self)

pub unsafe fn to_global(&self, local_point: Vector3) -> Vector3

pub unsafe fn to_local(&self, global_point: Vector3) -> Vector3

pub unsafe fn translate(&mut self, offset: Vector3)

pub unsafe fn translate_object_local(&mut self, offset: Vector3)

pub unsafe fn update_gizmo(&mut self)

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for GridMap

fn clone(&self) -> GridMap

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for GridMap

impl Debug for GridMap

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

Formats the value using the given formatter.

impl Deref for GridMap

type Target = Spatial

The resulting type after dereferencing.

fn deref(&self) -> &Spatial

Dereferences the value.

impl DerefMut for GridMap

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

Mutably dereferences the value.

impl Free for GridMap

unsafe fn godot_free(self)

impl FromVariant for GridMap

fn from_variant(variant: &Variant) -> Option<Self>

impl GodotObject for GridMap

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Instanciable for GridMap

fn construct() -> Self

impl QueueFree for GridMap

unsafe fn godot_queue_free(&mut self)

impl ToVariant for GridMap

fn to_variant(&self) -> Variant