# {py:mod}`simvx.editor.panels.viewport3d`

```{py:module} simvx.editor.panels.viewport3d
```

```{autodoc2-docstring} simvx.editor.panels.viewport3d
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`ViewMode <simvx.editor.panels.viewport3d.ViewMode>`
  - ```{autodoc2-docstring} simvx.editor.panels.viewport3d.ViewMode
    :summary:
    ```
* - {py:obj}`Viewport3DPanel <simvx.editor.panels.viewport3d.Viewport3DPanel>`
  - ```{autodoc2-docstring} simvx.editor.panels.viewport3d.Viewport3DPanel
    :summary:
    ```
````

### API

`````{py:class} ViewMode()
:canonical: simvx.editor.panels.viewport3d.ViewMode

Bases: {py:obj}`enum.StrEnum`

```{autodoc2-docstring} simvx.editor.panels.viewport3d.ViewMode
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.editor.panels.viewport3d.ViewMode.__init__
```

````{py:attribute} SOLID
:canonical: simvx.editor.panels.viewport3d.ViewMode.SOLID
:value: >
   'solid'

```{autodoc2-docstring} simvx.editor.panels.viewport3d.ViewMode.SOLID
```

````

````{py:attribute} WIREFRAME
:canonical: simvx.editor.panels.viewport3d.ViewMode.WIREFRAME
:value: >
   'wireframe'

```{autodoc2-docstring} simvx.editor.panels.viewport3d.ViewMode.WIREFRAME
```

````

````{py:attribute} BOUNDING
:canonical: simvx.editor.panels.viewport3d.ViewMode.BOUNDING
:value: >
   'bounding'

```{autodoc2-docstring} simvx.editor.panels.viewport3d.ViewMode.BOUNDING
```

````

````{py:method} __new__(*values)
:canonical: simvx.editor.panels.viewport3d.ViewMode.__new__

````

````{py:method} __add__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__add__

````

````{py:method} __contains__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__contains__

````

````{py:method} __delattr__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__dir__

````

````{py:method} __eq__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__eq__

````

````{py:method} __format__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__format__

````

````{py:method} __ge__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__getattribute__

````

````{py:method} __getitem__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__getitem__

````

````{py:method} __getnewargs__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__getnewargs__

````

````{py:method} __getstate__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__gt__

````

````{py:method} __hash__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__hash__

````

````{py:method} __iter__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__iter__

````

````{py:method} __le__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__le__

````

````{py:method} __len__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__len__

````

````{py:method} __lt__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__lt__

````

````{py:method} __mod__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__mod__

````

````{py:method} __mul__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__mul__

````

````{py:method} __ne__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__ne__

````

````{py:method} __reduce__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__repr__

````

````{py:method} __rmod__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__rmod__

````

````{py:method} __rmul__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__rmul__

````

````{py:method} __setattr__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__setattr__

````

````{py:method} __sizeof__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__str__

````

````{py:method} __subclasshook__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__subclasshook__

````

````{py:method} capitalize()
:canonical: simvx.editor.panels.viewport3d.ViewMode.capitalize

````

````{py:method} casefold()
:canonical: simvx.editor.panels.viewport3d.ViewMode.casefold

````

````{py:method} center()
:canonical: simvx.editor.panels.viewport3d.ViewMode.center

````

````{py:method} count()
:canonical: simvx.editor.panels.viewport3d.ViewMode.count

````

````{py:method} encode()
:canonical: simvx.editor.panels.viewport3d.ViewMode.encode

````

````{py:method} endswith()
:canonical: simvx.editor.panels.viewport3d.ViewMode.endswith

````

````{py:method} expandtabs()
:canonical: simvx.editor.panels.viewport3d.ViewMode.expandtabs

````

````{py:method} find()
:canonical: simvx.editor.panels.viewport3d.ViewMode.find

````

````{py:method} format()
:canonical: simvx.editor.panels.viewport3d.ViewMode.format

````

````{py:method} format_map()
:canonical: simvx.editor.panels.viewport3d.ViewMode.format_map

````

````{py:method} index()
:canonical: simvx.editor.panels.viewport3d.ViewMode.index

````

````{py:method} isalnum()
:canonical: simvx.editor.panels.viewport3d.ViewMode.isalnum

````

````{py:method} isalpha()
:canonical: simvx.editor.panels.viewport3d.ViewMode.isalpha

````

````{py:method} isascii()
:canonical: simvx.editor.panels.viewport3d.ViewMode.isascii

````

````{py:method} isdecimal()
:canonical: simvx.editor.panels.viewport3d.ViewMode.isdecimal

````

````{py:method} isdigit()
:canonical: simvx.editor.panels.viewport3d.ViewMode.isdigit

````

````{py:method} isidentifier()
:canonical: simvx.editor.panels.viewport3d.ViewMode.isidentifier

````

````{py:method} islower()
:canonical: simvx.editor.panels.viewport3d.ViewMode.islower

````

````{py:method} isnumeric()
:canonical: simvx.editor.panels.viewport3d.ViewMode.isnumeric

````

````{py:method} isprintable()
:canonical: simvx.editor.panels.viewport3d.ViewMode.isprintable

````

````{py:method} isspace()
:canonical: simvx.editor.panels.viewport3d.ViewMode.isspace

````

````{py:method} istitle()
:canonical: simvx.editor.panels.viewport3d.ViewMode.istitle

````

````{py:method} isupper()
:canonical: simvx.editor.panels.viewport3d.ViewMode.isupper

````

````{py:method} join()
:canonical: simvx.editor.panels.viewport3d.ViewMode.join

````

````{py:method} ljust()
:canonical: simvx.editor.panels.viewport3d.ViewMode.ljust

````

````{py:method} lower()
:canonical: simvx.editor.panels.viewport3d.ViewMode.lower

````

````{py:method} lstrip()
:canonical: simvx.editor.panels.viewport3d.ViewMode.lstrip

````

````{py:method} partition()
:canonical: simvx.editor.panels.viewport3d.ViewMode.partition

````

````{py:method} removeprefix()
:canonical: simvx.editor.panels.viewport3d.ViewMode.removeprefix

````

````{py:method} removesuffix()
:canonical: simvx.editor.panels.viewport3d.ViewMode.removesuffix

````

````{py:method} replace()
:canonical: simvx.editor.panels.viewport3d.ViewMode.replace

````

````{py:method} rfind()
:canonical: simvx.editor.panels.viewport3d.ViewMode.rfind

````

````{py:method} rindex()
:canonical: simvx.editor.panels.viewport3d.ViewMode.rindex

````

````{py:method} rjust()
:canonical: simvx.editor.panels.viewport3d.ViewMode.rjust

````

````{py:method} rpartition()
:canonical: simvx.editor.panels.viewport3d.ViewMode.rpartition

````

````{py:method} rsplit()
:canonical: simvx.editor.panels.viewport3d.ViewMode.rsplit

````

````{py:method} rstrip()
:canonical: simvx.editor.panels.viewport3d.ViewMode.rstrip

````

````{py:method} split()
:canonical: simvx.editor.panels.viewport3d.ViewMode.split

````

````{py:method} splitlines()
:canonical: simvx.editor.panels.viewport3d.ViewMode.splitlines

````

````{py:method} startswith()
:canonical: simvx.editor.panels.viewport3d.ViewMode.startswith

````

````{py:method} strip()
:canonical: simvx.editor.panels.viewport3d.ViewMode.strip

````

````{py:method} swapcase()
:canonical: simvx.editor.panels.viewport3d.ViewMode.swapcase

````

````{py:method} title()
:canonical: simvx.editor.panels.viewport3d.ViewMode.title

````

````{py:method} translate()
:canonical: simvx.editor.panels.viewport3d.ViewMode.translate

````

````{py:method} upper()
:canonical: simvx.editor.panels.viewport3d.ViewMode.upper

````

````{py:method} zfill()
:canonical: simvx.editor.panels.viewport3d.ViewMode.zfill

````

````{py:method} __deepcopy__(memo)
:canonical: simvx.editor.panels.viewport3d.ViewMode.__deepcopy__

````

````{py:method} __copy__()
:canonical: simvx.editor.panels.viewport3d.ViewMode.__copy__

````

````{py:method} name()
:canonical: simvx.editor.panels.viewport3d.ViewMode.name

````

````{py:method} value()
:canonical: simvx.editor.panels.viewport3d.ViewMode.value

````

`````

`````{py:class} Viewport3DPanel(editor_state: simvx.editor.state.EditorState, **kwargs)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel

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

```{autodoc2-docstring} simvx.editor.panels.viewport3d.Viewport3DPanel
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.editor.panels.viewport3d.Viewport3DPanel.__init__
```

````{py:method} process(dt: float)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.process

```{autodoc2-docstring} simvx.editor.panels.viewport3d.Viewport3DPanel.process
```

````

````{py:method} draw(renderer)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.draw

```{autodoc2-docstring} simvx.editor.panels.viewport3d.Viewport3DPanel.draw
```

````

````{py:method} handle_scroll(delta: float)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.handle_scroll

```{autodoc2-docstring} simvx.editor.panels.viewport3d.Viewport3DPanel.handle_scroll
```

````

````{py:method} set_viewport_size(width: float, height: float)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.set_viewport_size

```{autodoc2-docstring} simvx.editor.panels.viewport3d.Viewport3DPanel.set_viewport_size
```

````

````{py:attribute} size_x
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.size_x
:value: >
   'Property(...)'

````

````{py:attribute} size_y
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.size_y
:value: >
   'Property(...)'

````

````{py:property} size
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.size
:type: simvx.core.math.types.Vec2

````

````{py:attribute} touch_mode
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.touch_mode
:type: str
:value: >
   'mouse'

````

````{py:property} theme
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.theme
:type: simvx.core.ui.types.Theme | None

````

````{py:property} mouse_over
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.mouse_over
:type: bool

````

````{py:property} focused
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.focused
:type: bool

````

````{py:property} disabled
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.disabled
:type: bool

````

````{py:method} get_theme() -> simvx.core.ui.types.Theme
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.get_theme

````

````{py:method} queue_redraw()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.queue_redraw

````

````{py:method} get_minimum_size() -> simvx.core.math.types.Vec2
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.get_minimum_size

````

````{py:method} get_rect() -> tuple[float, float, float, float]
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.get_rect

````

````{py:method} get_global_rect() -> tuple[float, float, float, float]
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.get_global_rect

````

````{py:method} is_point_inside(point) -> bool
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.is_point_inside

````

````{py:method} set_anchor_preset(preset: simvx.core.ui.enums.AnchorPreset)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.set_anchor_preset

````

````{py:method} set_focus()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.set_focus

````

````{py:method} grab_focus()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.grab_focus

````

````{py:method} release_focus()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.release_focus

````

````{py:method} has_focus() -> bool
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.has_focus

````

````{py:method} focus_next_control()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.focus_previous_control

````

````{py:method} grab_mouse()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.grab_mouse

````

````{py:method} release_mouse()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.release_mouse

````

````{py:method} set_drag_preview(control: simvx.core.ui.core.Control)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.set_drag_preview

````

````{py:method} draw_popup(renderer)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.draw_popup

````

````{py:method} is_popup_point_inside(point) -> bool
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.is_popup_point_inside

````

````{py:method} popup_input(event)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.popup_input

````

````{py:method} dismiss_popup()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.dismiss_popup

````

````{py:attribute} z_index
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_position
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, colour=None)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.wrap_screen

````

````{py:attribute} strict_errors
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.find_child

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.find_all

````

````{py:property} path
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.physics_process

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.clear_children

````

````{py:method} destroy()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.destroy

````

````{py:property} app
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.app

````

````{py:property} tree
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.editor.panels.viewport3d.Viewport3DPanel.__repr__

````

`````