# {py:mod}`simvx.core.ui.scene_host`

```{py:module} simvx.core.ui.scene_host
```

```{autodoc2-docstring} simvx.core.ui.scene_host
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`SceneHost <simvx.core.ui.scene_host.SceneHost>`
  - ```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <simvx.core.ui.scene_host.__all__>`
  - ```{autodoc2-docstring} simvx.core.ui.scene_host.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.ui.scene_host.__all__
:value: >
   ['SceneHost']

```{autodoc2-docstring} simvx.core.ui.scene_host.__all__
```

````

`````{py:class} SceneHost(guest: simvx.core.scene_tree.SceneTree | simvx.core.node.Node | None = None, **kwargs: typing.Any)
:canonical: simvx.core.ui.scene_host.SceneHost

Bases: {py:obj}`simvx.core.ui.core.Control`

```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost.__init__
```

````{py:attribute} pointer_filter
:canonical: simvx.core.ui.scene_host.SceneHost.pointer_filter
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost.pointer_filter
```

````

````{py:attribute} accepts_pointers
:canonical: simvx.core.ui.scene_host.SceneHost.accepts_pointers
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost.accepts_pointers
```

````

````{py:attribute} focus_mode
:canonical: simvx.core.ui.scene_host.SceneHost.focus_mode
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost.focus_mode
```

````

````{py:attribute} forwarding
:canonical: simvx.core.ui.scene_host.SceneHost.forwarding
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost.forwarding
```

````

````{py:property} guest
:canonical: simvx.core.ui.scene_host.SceneHost.guest
:type: simvx.core.scene_tree.SceneTree | None

```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost.guest
```

````

````{py:method} to_guest(point) -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.scene_host.SceneHost.to_guest

```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost.to_guest
```

````

````{py:method} to_host(point) -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.scene_host.SceneHost.to_host

```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost.to_host
```

````

````{py:method} on_update(dt: float) -> None
:canonical: simvx.core.ui.scene_host.SceneHost.on_update

```{autodoc2-docstring} simvx.core.ui.scene_host.SceneHost.on_update
```

````

````{py:attribute} size_x
:canonical: simvx.core.ui.scene_host.SceneHost.size_x
:value: >
   'Property(...)'

````

````{py:attribute} size_y
:canonical: simvx.core.ui.scene_host.SceneHost.size_y
:value: >
   'Property(...)'

````

````{py:attribute} min_size_x
:canonical: simvx.core.ui.scene_host.SceneHost.min_size_x
:value: >
   'Property(...)'

````

````{py:attribute} min_size_y
:canonical: simvx.core.ui.scene_host.SceneHost.min_size_y
:value: >
   'Property(...)'

````

````{py:attribute} anchor_left
:canonical: simvx.core.ui.scene_host.SceneHost.anchor_left
:value: >
   'Property(...)'

````

````{py:attribute} anchor_top
:canonical: simvx.core.ui.scene_host.SceneHost.anchor_top
:value: >
   'Property(...)'

````

````{py:attribute} anchor_right
:canonical: simvx.core.ui.scene_host.SceneHost.anchor_right
:value: >
   'Property(...)'

````

````{py:attribute} anchor_bottom
:canonical: simvx.core.ui.scene_host.SceneHost.anchor_bottom
:value: >
   'Property(...)'

````

````{py:attribute} margin_left
:canonical: simvx.core.ui.scene_host.SceneHost.margin_left
:value: >
   'Property(...)'

````

````{py:attribute} margin_top
:canonical: simvx.core.ui.scene_host.SceneHost.margin_top
:value: >
   'Property(...)'

````

````{py:attribute} margin_right
:canonical: simvx.core.ui.scene_host.SceneHost.margin_right
:value: >
   'Property(...)'

````

````{py:attribute} margin_bottom
:canonical: simvx.core.ui.scene_host.SceneHost.margin_bottom
:value: >
   'Property(...)'

````

````{py:attribute} anchor
:canonical: simvx.core.ui.scene_host.SceneHost.anchor
:value: >
   'Property(...)'

````

````{py:attribute} inset
:canonical: simvx.core.ui.scene_host.SceneHost.inset
:value: >
   'Property(...)'

````

````{py:attribute} dismiss_on_outside_click
:canonical: simvx.core.ui.scene_host.SceneHost.dismiss_on_outside_click
:value: >
   'Property(...)'

````

````{py:attribute} clip_contents
:canonical: simvx.core.ui.scene_host.SceneHost.clip_contents
:value: >
   'Property(...)'

````

````{py:attribute} tooltip
:canonical: simvx.core.ui.scene_host.SceneHost.tooltip
:value: >
   'Property(...)'

````

````{py:attribute} cursor_shape
:canonical: simvx.core.ui.scene_host.SceneHost.cursor_shape
:value: >
   'Property(...)'

````

````{py:attribute} pointer_types
:canonical: simvx.core.ui.scene_host.SceneHost.pointer_types
:type: frozenset[simvx.core.input.enums.PointerType] | None
:value: >
   None

````

````{py:attribute} touch_target
:canonical: simvx.core.ui.scene_host.SceneHost.touch_target
:type: bool
:value: >
   False

````

````{py:attribute} wants_text_input
:canonical: simvx.core.ui.scene_host.SceneHost.wants_text_input
:type: bool
:value: >
   False

````

````{py:attribute} size_flags_horizontal
:canonical: simvx.core.ui.scene_host.SceneHost.size_flags_horizontal
:value: >
   'Property(...)'

````

````{py:attribute} size_flags_vertical
:canonical: simvx.core.ui.scene_host.SceneHost.size_flags_vertical
:value: >
   'Property(...)'

````

````{py:attribute} stretch_ratio
:canonical: simvx.core.ui.scene_host.SceneHost.stretch_ratio
:value: >
   'Property(...)'

````

````{py:attribute} max_size
:canonical: simvx.core.ui.scene_host.SceneHost.max_size
:value: >
   'Property(...)'

````

````{py:property} size
:canonical: simvx.core.ui.scene_host.SceneHost.size
:type: simvx.core.math.types.Vec2

````

````{py:property} min_size
:canonical: simvx.core.ui.scene_host.SceneHost.min_size
:type: simvx.core.math.types.Vec2

````

````{py:method} content_signature() -> object
:canonical: simvx.core.ui.scene_host.SceneHost.content_signature

````

````{py:method} content_uses(chars: str) -> bool
:canonical: simvx.core.ui.scene_host.SceneHost.content_uses

````

````{py:method} autosize_to_content() -> None
:canonical: simvx.core.ui.scene_host.SceneHost.autosize_to_content

````

````{py:property} theme
:canonical: simvx.core.ui.scene_host.SceneHost.theme
:type: simvx.core.ui.types.Theme | None

````

````{py:property} mouse_over
:canonical: simvx.core.ui.scene_host.SceneHost.mouse_over
:type: bool

````

````{py:property} disabled
:canonical: simvx.core.ui.scene_host.SceneHost.disabled
:type: bool

````

````{py:method} get_theme() -> simvx.core.ui.types.Theme
:canonical: simvx.core.ui.scene_host.SceneHost.get_theme

````

````{py:property} viewport_size
:canonical: simvx.core.ui.scene_host.SceneHost.viewport_size
:type: simvx.core.math.types.Vec2

````

````{py:property} viewport_insets
:canonical: simvx.core.ui.scene_host.SceneHost.viewport_insets
:type: tuple[float, float, float, float]

````

````{py:method} queue_redraw()
:canonical: simvx.core.ui.scene_host.SceneHost.queue_redraw

````

````{py:method} size_floor() -> tuple[float, float]
:canonical: simvx.core.ui.scene_host.SceneHost.size_floor

````

````{py:method} get_minimum_size() -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.scene_host.SceneHost.get_minimum_size

````

````{py:method} add_child(node: simvx.core.node.T) -> simvx.core.node.T
:canonical: simvx.core.ui.scene_host.SceneHost.add_child

````

````{py:method} get_rect() -> tuple[float, float, float, float]
:canonical: simvx.core.ui.scene_host.SceneHost.get_rect

````

````{py:method} get_global_rect() -> tuple[float, float, float, float]
:canonical: simvx.core.ui.scene_host.SceneHost.get_global_rect

````

````{py:property} focus_rect
:canonical: simvx.core.ui.scene_host.SceneHost.focus_rect
:type: tuple[float, float, float, float] | None

````

````{py:method} is_point_inside(point) -> bool
:canonical: simvx.core.ui.scene_host.SceneHost.is_point_inside

````

````{py:method} is_hit(event: simvx.core.input.events.PointerEvent) -> bool
:canonical: simvx.core.ui.scene_host.SceneHost.is_hit

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.ui.scene_host.SceneHost.__init_subclass__
:classmethod:

````

````{py:method} activate() -> bool
:canonical: simvx.core.ui.scene_host.SceneHost.activate

````

````{py:method} set_focus()
:canonical: simvx.core.ui.scene_host.SceneHost.set_focus

````

````{py:method} focus_next_control()
:canonical: simvx.core.ui.scene_host.SceneHost.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.core.ui.scene_host.SceneHost.focus_previous_control

````

````{py:method} set_drag_preview(control: simvx.core.ui.core.Control)
:canonical: simvx.core.ui.scene_host.SceneHost.set_drag_preview

````

````{py:property} is_overlay_open
:canonical: simvx.core.ui.scene_host.SceneHost.is_overlay_open
:type: bool

````

````{py:method} show_overlay(modality: str = 'light', *, dim: bool | None = None, dismiss: bool | None = None, inert: bool | None = None, owner: simvx.core.ui.core.Control | None = None, initial_focus: simvx.core.ui.core.Control | None = None) -> None
:canonical: simvx.core.ui.scene_host.SceneHost.show_overlay

````

````{py:method} close_overlay() -> None
:canonical: simvx.core.ui.scene_host.SceneHost.close_overlay

````

````{py:attribute} position
:canonical: simvx.core.ui.scene_host.SceneHost.position
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} rotation
:canonical: simvx.core.ui.scene_host.SceneHost.rotation
:value: >
   'Property(...)'

````

````{py:attribute} scale
:canonical: simvx.core.ui.scene_host.SceneHost.scale
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} top_level
:canonical: simvx.core.ui.scene_host.SceneHost.top_level
:value: >
   'Property(...)'

````

````{py:attribute} z_index
:canonical: simvx.core.ui.scene_host.SceneHost.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.ui.scene_host.SceneHost.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.ui.scene_host.SceneHost.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.ui.scene_host.SceneHost.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.ui.scene_host.SceneHost.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.core.ui.scene_host.SceneHost.absolute_z_index
:type: int

````

````{py:property} rotation_degrees
:canonical: simvx.core.ui.scene_host.SceneHost.rotation_degrees
:type: float

````

````{py:property} world_position
:canonical: simvx.core.ui.scene_host.SceneHost.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.core.ui.scene_host.SceneHost.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.core.ui.scene_host.SceneHost.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_transform
:canonical: simvx.core.ui.scene_host.SceneHost.world_transform
:type: tuple[simvx.core.math.types.Vec2, simvx.core.math.types.Vec2, float]

````

````{py:property} forward
:canonical: simvx.core.ui.scene_host.SceneHost.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.ui.scene_host.SceneHost.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.ui.scene_host.SceneHost.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.ui.scene_host.SceneHost.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.ui.scene_host.SceneHost.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.ui.scene_host.SceneHost.look_at

````

````{py:method} to_global(point) -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.scene_host.SceneHost.to_global

````

````{py:method} to_local(point) -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.scene_host.SceneHost.to_local

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.ui.scene_host.SceneHost.transform_points

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.ui.scene_host.SceneHost.wrap_screen

````

````{py:attribute} post_processed
:canonical: simvx.core.ui.scene_host.SceneHost.post_processed
:value: >
   'Property(...)'

````

````{py:property} transform_render_dirty
:canonical: simvx.core.ui.scene_host.SceneHost.transform_render_dirty
:type: bool

````

````{py:attribute} strict_errors
:canonical: simvx.core.ui.scene_host.SceneHost.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} dev_checks
:canonical: simvx.core.ui.scene_host.SceneHost.dev_checks
:type: typing.ClassVar[bool]
:value: >
   None

````

````{py:attribute} dev_warnings
:canonical: simvx.core.ui.scene_host.SceneHost.dev_warnings
:type: typing.ClassVar[bool]
:value: >
   None

````

````{py:attribute} freeze_check_interval
:canonical: simvx.core.ui.scene_host.SceneHost.freeze_check_interval
:type: typing.ClassVar[float]
:value: >
   1.0

````

````{py:attribute} script_error_raised
:canonical: simvx.core.ui.scene_host.SceneHost.script_error_raised
:value: >
   'Signal(...)'

````

````{py:attribute} dynamic
:canonical: simvx.core.ui.scene_host.SceneHost.dynamic
:type: bool
:value: >
   False

````

````{py:attribute} visible
:canonical: simvx.core.ui.scene_host.SceneHost.visible
:value: >
   'Property(...)'

````

````{py:attribute} update_mode
:canonical: simvx.core.ui.scene_host.SceneHost.update_mode
:value: >
   'Property(...)'

````

````{py:attribute} drag_threshold
:canonical: simvx.core.ui.scene_host.SceneHost.drag_threshold
:value: >
   'Property(...)'

````

````{py:attribute} focus_entered
:canonical: simvx.core.ui.scene_host.SceneHost.focus_entered
:value: >
   'Signal(...)'

````

````{py:attribute} focus_exited
:canonical: simvx.core.ui.scene_host.SceneHost.focus_exited
:value: >
   'Signal(...)'

````

````{py:attribute} __properties__
:canonical: simvx.core.ui.scene_host.SceneHost.__properties__
:type: typing.ClassVar[dict[str, simvx.core.descriptors.Property]]
:value: >
   None

````

````{py:property} name
:canonical: simvx.core.ui.scene_host.SceneHost.name
:type: str

````

````{py:property} visible_in_tree
:canonical: simvx.core.ui.scene_host.SceneHost.visible_in_tree
:type: bool

````

````{py:property} input_player
:canonical: simvx.core.ui.scene_host.SceneHost.input_player
:type: simvx.core.input.players.InputPlayer

````

````{py:property} input_context
:canonical: simvx.core.ui.scene_host.SceneHost.input_context
:type: simvx.core.input.contexts.InputContext | None

````

````{py:method} reset_error() -> None
:canonical: simvx.core.ui.scene_host.SceneHost.reset_error

````

````{py:method} remove_child(node: simvx.core.node.Node) -> None
:canonical: simvx.core.ui.scene_host.SceneHost.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.ui.scene_host.SceneHost.reparent

````

````{py:method} node_at(path, default=_NO_DEFAULT)
:canonical: simvx.core.ui.scene_host.SceneHost.node_at

````

````{py:method} find(target, *, direct: bool = False)
:canonical: simvx.core.ui.scene_host.SceneHost.find

````

````{py:method} find_all(target, *, direct: bool = False)
:canonical: simvx.core.ui.scene_host.SceneHost.find_all

````

````{py:method} expect(target, *, direct: bool = False)
:canonical: simvx.core.ui.scene_host.SceneHost.expect

````

````{py:method} ancestor(target)
:canonical: simvx.core.ui.scene_host.SceneHost.ancestor

````

````{py:method} walk(*, include_self: bool = True) -> collections.abc.Iterator[simvx.core.node.Node]
:canonical: simvx.core.ui.scene_host.SceneHost.walk

````

````{py:property} path
:canonical: simvx.core.ui.scene_host.SceneHost.path
:type: str

````

````{py:property} is_scene_root
:canonical: simvx.core.ui.scene_host.SceneHost.is_scene_root
:type: bool

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.ui.scene_host.SceneHost.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.ui.scene_host.SceneHost.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.ui.scene_host.SceneHost.is_in_group

````

````{py:method} on_ready() -> None
:canonical: simvx.core.ui.scene_host.SceneHost.on_ready

````

````{py:method} on_enter_tree() -> None
:canonical: simvx.core.ui.scene_host.SceneHost.on_enter_tree

````

````{py:method} on_exit_tree() -> None
:canonical: simvx.core.ui.scene_host.SceneHost.on_exit_tree

````

````{py:method} on_fixed_update(dt: float) -> None
:canonical: simvx.core.ui.scene_host.SceneHost.on_fixed_update

````

````{py:method} on_draw(canvas) -> None
:canonical: simvx.core.ui.scene_host.SceneHost.on_draw

````

````{py:method} on_draw_3d(gizmos) -> None
:canonical: simvx.core.ui.scene_host.SceneHost.on_draw_3d

````

````{py:method} on_picked(event: simvx.core.input.events.PickEvent) -> bool | None
:canonical: simvx.core.ui.scene_host.SceneHost.on_picked

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.ui.scene_host.SceneHost.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.ui.scene_host.SceneHost.stop_coroutine

````

````{py:property} focused
:canonical: simvx.core.ui.scene_host.SceneHost.focused
:type: bool

````

````{py:method} drag_threshold_for(pointer_type: simvx.core.input.enums.PointerType | str) -> float
:canonical: simvx.core.ui.scene_host.SceneHost.drag_threshold_for

````

````{py:method} grab_focus() -> None
:canonical: simvx.core.ui.scene_host.SceneHost.grab_focus

````

````{py:method} release_focus() -> None
:canonical: simvx.core.ui.scene_host.SceneHost.release_focus

````

````{py:method} capture_pointer(pointer_id: int | None = None) -> None
:canonical: simvx.core.ui.scene_host.SceneHost.capture_pointer

````

````{py:method} release_pointer(pointer_id: int | None = None) -> None
:canonical: simvx.core.ui.scene_host.SceneHost.release_pointer

````

````{py:property} render_dirty
:canonical: simvx.core.ui.scene_host.SceneHost.render_dirty
:type: bool

````

````{py:method} clear_children()
:canonical: simvx.core.ui.scene_host.SceneHost.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.ui.scene_host.SceneHost.destroy

````

````{py:property} destroying
:canonical: simvx.core.ui.scene_host.SceneHost.destroying
:type: bool

````

````{py:method} call_deferred(method: collections.abc.Callable[..., typing.Any], *args: typing.Any) -> None
:canonical: simvx.core.ui.scene_host.SceneHost.call_deferred

````

````{py:property} app
:canonical: simvx.core.ui.scene_host.SceneHost.app

````

````{py:property} tree
:canonical: simvx.core.ui.scene_host.SceneHost.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:property} physics
:canonical: simvx.core.ui.scene_host.SceneHost.physics

````

````{py:property} physics_2d
:canonical: simvx.core.ui.scene_host.SceneHost.physics_2d

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.ui.scene_host.SceneHost.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.ui.scene_host.SceneHost.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.ui.scene_host.SceneHost.__repr__

````

`````