Struct gdnative::Control
[−]
[src]
pub struct Control { /* fields omitted */ }
core class Control : CanvasItem
(manually managed)
Base class
Control inherits CanvasItem and all of its methods.
Memory management
Non reference counted objects such as the ones of this type are usually owned by the engine.
In the cases where Rust code owns an object of this type, ownership should be either passed
to the engine or the object must be manually destroyed using Control::free
.
Methods
impl Control
[src]
pub fn as_canvas_item(&self) -> CanvasItem
[src]
Up-cast.
pub fn new() -> Self
[src]
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 Control::free
.
pub unsafe fn free(self)
[src]
Manually deallocate the object.
pub fn _gui_input(&mut self, event: Option<InputEvent>)
[src]
pub fn _get_minimum_size(&mut self) -> Vector2
[src]
pub fn get_drag_data(&mut self, position: Vector2) -> Option<Object>
[src]
pub fn can_drop_data(&mut self, position: Vector2, data: Variant) -> bool
[src]
pub fn drop_data(&mut self, position: Vector2, data: Variant)
[src]
pub fn has_point(&mut self, point: Vector2) -> bool
[src]
pub fn _size_changed(&mut self)
[src]
pub fn _update_minimum_size(&mut self)
[src]
pub fn accept_event(&mut self)
[src]
pub fn get_minimum_size(&self) -> Vector2
[src]
pub fn get_combined_minimum_size(&self) -> Vector2
[src]
pub fn set_anchors_preset(&mut self, preset: i64, keep_margin: bool)
[src]
pub fn set_margins_preset(&mut self, preset: i64, resize_mode: i64, margin: i64)
[src]
pub fn set_anchors_and_margins_preset(
&mut self,
preset: i64,
resize_mode: i64,
margin: i64
)
[src]
&mut self,
preset: i64,
resize_mode: i64,
margin: i64
)
pub fn set_anchor(
&mut self,
margin: i64,
anchor: f64,
keep_margin: bool,
push_opposite_anchor: bool
)
[src]
&mut self,
margin: i64,
anchor: f64,
keep_margin: bool,
push_opposite_anchor: bool
)
pub fn _set_anchor(&mut self, margin: i64, anchor: f64)
[src]
pub fn get_anchor(&self, margin: i64) -> f64
[src]
pub fn set_margin(&mut self, margin: i64, offset: f64)
[src]
pub fn set_anchor_and_margin(
&mut self,
margin: i64,
anchor: f64,
offset: f64,
push_opposite_anchor: bool
)
[src]
&mut self,
margin: i64,
anchor: f64,
offset: f64,
push_opposite_anchor: bool
)
pub fn set_begin(&mut self, position: Vector2)
[src]
pub fn set_end(&mut self, position: Vector2)
[src]
pub fn set_position(&mut self, position: Vector2)
[src]
pub fn set_size(&mut self, size: Vector2)
[src]
pub fn set_custom_minimum_size(&mut self, size: Vector2)
[src]
pub fn set_global_position(&mut self, position: Vector2)
[src]
pub fn set_rotation(&mut self, radians: f64)
[src]
pub fn set_rotation_degrees(&mut self, degrees: f64)
[src]
pub fn set_scale(&mut self, scale: Vector2)
[src]
pub fn set_pivot_offset(&mut self, pivot_offset: Vector2)
[src]
pub fn get_margin(&self, margin: i64) -> f64
[src]
pub fn get_begin(&self) -> Vector2
[src]
pub fn get_end(&self) -> Vector2
[src]
pub fn get_position(&self) -> Vector2
[src]
pub fn get_size(&self) -> Vector2
[src]
pub fn get_rotation(&self) -> f64
[src]
pub fn get_rotation_degrees(&self) -> f64
[src]
pub fn get_scale(&self) -> Vector2
[src]
pub fn get_pivot_offset(&self) -> Vector2
[src]
pub fn get_custom_minimum_size(&self) -> Vector2
[src]
pub fn get_parent_area_size(&self) -> Vector2
[src]
pub fn get_global_position(&self) -> Vector2
[src]
pub fn get_rect(&self) -> Rect2
[src]
pub fn get_global_rect(&self) -> Rect2
[src]
pub fn show_modal(&mut self, exclusive: bool)
[src]
pub fn set_focus_mode(&mut self, mode: i64)
[src]
pub fn has_focus(&self) -> bool
[src]
pub fn grab_focus(&mut self)
[src]
pub fn release_focus(&mut self)
[src]
pub fn get_focus_owner(&self) -> Option<Control>
[src]
pub fn set_h_size_flags(&mut self, flags: i64)
[src]
pub fn get_h_size_flags(&self) -> i64
[src]
pub fn set_stretch_ratio(&mut self, ratio: f64)
[src]
pub fn get_stretch_ratio(&self) -> f64
[src]
pub fn set_v_size_flags(&mut self, flags: i64)
[src]
pub fn get_v_size_flags(&self) -> i64
[src]
pub fn set_theme(&mut self, theme: Option<Theme>)
[src]
pub fn get_theme(&self) -> Option<Theme>
[src]
pub fn add_icon_override(&mut self, name: GodotString, texture: Option<Texture>)
[src]
pub fn add_shader_override(&mut self, name: GodotString, shader: Option<Shader>)
[src]
pub fn add_stylebox_override(
&mut self,
name: GodotString,
stylebox: Option<StyleBox>
)
[src]
&mut self,
name: GodotString,
stylebox: Option<StyleBox>
)
pub fn add_font_override(&mut self, name: GodotString, font: Option<Font>)
[src]
pub fn add_color_override(&mut self, name: GodotString, color: Color)
[src]
pub fn add_constant_override(&mut self, name: GodotString, constant: i64)
[src]
pub fn get_icon(&self, name: GodotString, _type: GodotString) -> Option<Texture>
[src]
pub fn get_stylebox(
&self,
name: GodotString,
_type: GodotString
) -> Option<StyleBox>
[src]
&self,
name: GodotString,
_type: GodotString
) -> Option<StyleBox>
pub fn get_font(&self, name: GodotString, _type: GodotString) -> Option<Font>
[src]
pub fn get_color(&self, name: GodotString, _type: GodotString) -> Color
[src]
pub fn get_constant(&self, name: GodotString, _type: GodotString) -> i64
[src]
pub fn has_icon_override(&self, name: GodotString) -> bool
[src]
pub fn has_shader_override(&self, name: GodotString) -> bool
[src]
pub fn has_stylebox_override(&self, name: GodotString) -> bool
[src]
pub fn has_font_override(&self, name: GodotString) -> bool
[src]
pub fn has_color_override(&self, name: GodotString) -> bool
[src]
pub fn has_constant_override(&self, name: GodotString) -> bool
[src]
pub fn has_icon(&self, name: GodotString, _type: GodotString) -> bool
[src]
pub fn has_stylebox(&self, name: GodotString, _type: GodotString) -> bool
[src]
pub fn has_font(&self, name: GodotString, _type: GodotString) -> bool
[src]
pub fn has_color(&self, name: GodotString, _type: GodotString) -> bool
[src]
pub fn has_constant(&self, name: GodotString, _type: GodotString) -> bool
[src]
pub fn get_parent_control(&self) -> Option<Control>
[src]
pub fn set_h_grow_direction(&mut self, direction: i64)
[src]
pub fn set_v_grow_direction(&mut self, direction: i64)
[src]
pub fn set_tooltip(&mut self, tooltip: GodotString)
[src]
pub fn get_tooltip(&self, at_position: Vector2) -> GodotString
[src]
pub fn _get_tooltip(&self) -> GodotString
[src]
pub fn set_default_cursor_shape(&mut self, shape: i64)
[src]
pub fn set_focus_neighbour(&mut self, margin: i64, neighbour: NodePath)
[src]
pub fn get_focus_neighbour(&self, margin: i64) -> NodePath
[src]
pub fn set_focus_next(&mut self, next: NodePath)
[src]
pub fn get_focus_next(&self) -> NodePath
[src]
pub fn set_focus_previous(&mut self, previous: NodePath)
[src]
pub fn get_focus_previous(&self) -> NodePath
[src]
pub fn force_drag(&mut self, data: Variant, preview: Option<Object>)
[src]
pub fn set_mouse_filter(&mut self, filter: i64)
[src]
pub fn set_clip_contents(&mut self, enable: bool)
[src]
pub fn is_clipping_contents(&mut self) -> bool
[src]
pub fn grab_click_focus(&mut self)
[src]
pub fn set_drag_forwarding(&mut self, target: Option<Object>)
[src]
pub fn set_drag_preview(&mut self, control: Option<Object>)
[src]
pub fn warp_mouse(&mut self, to_position: Vector2)
[src]
pub fn minimum_size_changed(&mut self)
[src]
pub fn _theme_changed(&mut self)
[src]
pub fn _font_changed(&mut self)
[src]
pub fn cast<T: GodotObject>(&self) -> Option<T>
[src]
Methods from Deref<Target = CanvasItem>
pub fn as_node(&self) -> Node
[src]
Up-cast.
pub fn _draw(&mut self)
[src]
pub fn _toplevel_raise_self(&mut self)
[src]
pub fn _update_callback(&mut self)
[src]
pub fn _edit_set_state(&mut self, state: Dictionary)
[src]
pub fn _edit_get_state(&self) -> Dictionary
[src]
pub fn _edit_set_position(&mut self, position: Vector2)
[src]
pub fn _edit_get_position(&self) -> Vector2
[src]
pub fn _edit_use_position(&self) -> bool
[src]
pub fn _edit_set_rect(&mut self, rect: Rect2)
[src]
pub fn _edit_get_rect(&self) -> Rect2
[src]
pub fn _edit_use_rect(&self) -> bool
[src]
pub fn _edit_get_item_and_children_rect(&self) -> Rect2
[src]
pub fn _edit_set_rotation(&mut self, degrees: f64)
[src]
pub fn _edit_get_rotation(&self) -> f64
[src]
pub fn _edit_use_rotation(&self) -> bool
[src]
pub fn _edit_set_pivot(&mut self, pivot: Vector2)
[src]
pub fn _edit_get_pivot(&self) -> Vector2
[src]
pub fn _edit_use_pivot(&self) -> bool
[src]
pub fn get_canvas_item(&self) -> Rid
[src]
pub fn set_visible(&mut self, visible: bool)
[src]
pub fn is_visible(&self) -> bool
[src]
pub fn is_visible_in_tree(&self) -> bool
[src]
pub fn show(&mut self)
[src]
pub fn hide(&mut self)
[src]
pub fn update(&mut self)
[src]
pub fn set_as_toplevel(&mut self, enable: bool)
[src]
pub fn is_set_as_toplevel(&self) -> bool
[src]
pub fn set_light_mask(&mut self, light_mask: i64)
[src]
pub fn get_light_mask(&self) -> i64
[src]
pub fn set_modulate(&mut self, modulate: Color)
[src]
pub fn get_modulate(&self) -> Color
[src]
pub fn set_self_modulate(&mut self, self_modulate: Color)
[src]
pub fn get_self_modulate(&self) -> Color
[src]
pub fn set_draw_behind_parent(&mut self, enable: bool)
[src]
pub fn is_draw_behind_parent_enabled(&self) -> bool
[src]
pub fn _set_on_top(&mut self, on_top: bool)
[src]
pub fn _is_on_top(&self) -> bool
[src]
pub fn draw_line(
&mut self,
from: Vector2,
to: Vector2,
color: Color,
width: f64,
antialiased: bool
)
[src]
&mut self,
from: Vector2,
to: Vector2,
color: Color,
width: f64,
antialiased: bool
)
pub fn draw_polyline(
&mut self,
points: Vector2Array,
color: Color,
width: f64,
antialiased: bool
)
[src]
&mut self,
points: Vector2Array,
color: Color,
width: f64,
antialiased: bool
)
pub fn draw_polyline_colors(
&mut self,
points: Vector2Array,
colors: ColorArray,
width: f64,
antialiased: bool
)
[src]
&mut self,
points: Vector2Array,
colors: ColorArray,
width: f64,
antialiased: bool
)
pub fn draw_multiline(
&mut self,
points: Vector2Array,
color: Color,
width: f64,
antialiased: bool
)
[src]
&mut self,
points: Vector2Array,
color: Color,
width: f64,
antialiased: bool
)
pub fn draw_multiline_colors(
&mut self,
points: Vector2Array,
colors: ColorArray,
width: f64,
antialiased: bool
)
[src]
&mut self,
points: Vector2Array,
colors: ColorArray,
width: f64,
antialiased: bool
)
pub fn draw_rect(&mut self, rect: Rect2, color: Color, filled: bool)
[src]
pub fn draw_circle(&mut self, position: Vector2, radius: f64, color: Color)
[src]
pub fn draw_texture(
&mut self,
texture: Option<Texture>,
position: Vector2,
modulate: Color,
normal_map: Option<Texture>
)
[src]
&mut self,
texture: Option<Texture>,
position: Vector2,
modulate: Color,
normal_map: Option<Texture>
)
pub fn draw_texture_rect(
&mut self,
texture: Option<Texture>,
rect: Rect2,
tile: bool,
modulate: Color,
transpose: bool,
normal_map: Option<Texture>
)
[src]
&mut self,
texture: Option<Texture>,
rect: Rect2,
tile: bool,
modulate: Color,
transpose: bool,
normal_map: Option<Texture>
)
pub fn draw_texture_rect_region(
&mut self,
texture: Option<Texture>,
rect: Rect2,
src_rect: Rect2,
modulate: Color,
transpose: bool,
normal_map: Option<Texture>,
clip_uv: bool
)
[src]
&mut self,
texture: Option<Texture>,
rect: Rect2,
src_rect: Rect2,
modulate: Color,
transpose: bool,
normal_map: Option<Texture>,
clip_uv: bool
)
pub fn draw_style_box(&mut self, style_box: Option<StyleBox>, rect: Rect2)
[src]
pub fn draw_primitive(
&mut self,
points: Vector2Array,
colors: ColorArray,
uvs: Vector2Array,
texture: Option<Texture>,
width: f64,
normal_map: Option<Texture>
)
[src]
&mut self,
points: Vector2Array,
colors: ColorArray,
uvs: Vector2Array,
texture: Option<Texture>,
width: f64,
normal_map: Option<Texture>
)
pub fn draw_polygon(
&mut self,
points: Vector2Array,
colors: ColorArray,
uvs: Vector2Array,
texture: Option<Texture>,
normal_map: Option<Texture>,
antialiased: bool
)
[src]
&mut self,
points: Vector2Array,
colors: ColorArray,
uvs: Vector2Array,
texture: Option<Texture>,
normal_map: Option<Texture>,
antialiased: bool
)
pub fn draw_colored_polygon(
&mut self,
points: Vector2Array,
color: Color,
uvs: Vector2Array,
texture: Option<Texture>,
normal_map: Option<Texture>,
antialiased: bool
)
[src]
&mut self,
points: Vector2Array,
color: Color,
uvs: Vector2Array,
texture: Option<Texture>,
normal_map: Option<Texture>,
antialiased: bool
)
pub fn draw_string(
&mut self,
font: Option<Font>,
position: Vector2,
text: GodotString,
modulate: Color,
clip_w: i64
)
[src]
&mut self,
font: Option<Font>,
position: Vector2,
text: GodotString,
modulate: Color,
clip_w: i64
)
pub fn draw_char(
&mut self,
font: Option<Font>,
position: Vector2,
char: GodotString,
next: GodotString,
modulate: Color
) -> f64
[src]
&mut self,
font: Option<Font>,
position: Vector2,
char: GodotString,
next: GodotString,
modulate: Color
) -> f64
pub fn draw_set_transform(
&mut self,
position: Vector2,
rotation: f64,
scale: Vector2
)
[src]
&mut self,
position: Vector2,
rotation: f64,
scale: Vector2
)
pub fn draw_set_transform_matrix(&mut self, xform: Transform2D)
[src]
pub fn get_transform(&self) -> Transform2D
[src]
pub fn get_global_transform(&self) -> Transform2D
[src]
pub fn get_global_transform_with_canvas(&self) -> Transform2D
[src]
pub fn get_viewport_transform(&self) -> Transform2D
[src]
pub fn get_viewport_rect(&self) -> Rect2
[src]
pub fn get_canvas_transform(&self) -> Transform2D
[src]
pub fn get_local_mouse_position(&self) -> Vector2
[src]
pub fn get_global_mouse_position(&self) -> Vector2
[src]
pub fn get_canvas(&self) -> Rid
[src]
pub fn get_world_2d(&self) -> Option<World2D>
[src]
pub fn set_material(&mut self, material: Option<Material>)
[src]
pub fn get_material(&self) -> Option<Material>
[src]
pub fn set_use_parent_material(&mut self, enable: bool)
[src]
pub fn get_use_parent_material(&self) -> bool
[src]
pub fn set_notify_local_transform(&mut self, enable: bool)
[src]
pub fn is_local_transform_notification_enabled(&self) -> bool
[src]
pub fn set_notify_transform(&mut self, enable: bool)
[src]
pub fn is_transform_notification_enabled(&self) -> bool
[src]
pub fn make_canvas_position_local(&self, screen_point: Vector2) -> Vector2
[src]
pub fn make_input_local(&self, event: Option<InputEvent>) -> Option<InputEvent>
[src]
pub fn cast<T: GodotObject>(&self) -> Option<T>
[src]
Trait Implementations
impl GodotObject for Control
[src]
fn class_name() -> &'static str
[src]
unsafe fn from_sys(obj: *mut godot_object) -> Self
[src]
unsafe fn to_sys(&self) -> *mut godot_object
[src]
impl Deref for Control
[src]
type Target = CanvasItem
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
Dereferences the value.