# {py:mod}`simvx.core.physics.root`

```{py:module} simvx.core.physics.root
```

```{autodoc2-docstring} simvx.core.physics.root
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`PhysicsRoot <simvx.core.physics.root.PhysicsRoot>`
  - ```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot
    :summary:
    ```
* - {py:obj}`PhysicsRoot2D <simvx.core.physics.root.PhysicsRoot2D>`
  - ```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot2D
    :summary:
    ```
````

### Functions

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

* - {py:obj}`resolve_world <simvx.core.physics.root.resolve_world>`
  - ```{autodoc2-docstring} simvx.core.physics.root.resolve_world
    :summary:
    ```
* - {py:obj}`resolve_world_2d <simvx.core.physics.root.resolve_world_2d>`
  - ```{autodoc2-docstring} simvx.core.physics.root.resolve_world_2d
    :summary:
    ```
````

### Data

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

* - {py:obj}`WorldFactory <simvx.core.physics.root.WorldFactory>`
  - ```{autodoc2-docstring} simvx.core.physics.root.WorldFactory
    :summary:
    ```
* - {py:obj}`WorldFactory2D <simvx.core.physics.root.WorldFactory2D>`
  - ```{autodoc2-docstring} simvx.core.physics.root.WorldFactory2D
    :summary:
    ```
* - {py:obj}`__all__ <simvx.core.physics.root.__all__>`
  - ```{autodoc2-docstring} simvx.core.physics.root.__all__
    :summary:
    ```
````

### API

````{py:data} WorldFactory
:canonical: simvx.core.physics.root.WorldFactory
:value: >
   None

```{autodoc2-docstring} simvx.core.physics.root.WorldFactory
```

````

````{py:data} WorldFactory2D
:canonical: simvx.core.physics.root.WorldFactory2D
:value: >
   None

```{autodoc2-docstring} simvx.core.physics.root.WorldFactory2D
```

````

````{py:function} resolve_world(node: simvx.core.node.Node) -> simvx.core.physics.world.PhysicsWorld
:canonical: simvx.core.physics.root.resolve_world

```{autodoc2-docstring} simvx.core.physics.root.resolve_world
```
````

````{py:function} resolve_world_2d(node: simvx.core.node.Node) -> simvx.core.physics.world2d.Physics2DWorld
:canonical: simvx.core.physics.root.resolve_world_2d

```{autodoc2-docstring} simvx.core.physics.root.resolve_world_2d
```
````

`````{py:class} PhysicsRoot(name: str = '', *, gravity: simvx.core.math.Vec3 = _DEFAULT_GRAVITY, backend: str | None = None, factory: simvx.core.physics.root.WorldFactory | None = None, **kwargs: object)
:canonical: simvx.core.physics.root.PhysicsRoot

Bases: {py:obj}`simvx.core.node.Node`

```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot.__init__
```

````{py:property} world
:canonical: simvx.core.physics.root.PhysicsRoot.world
:type: simvx.core.physics.world.PhysicsWorld

```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot.world
```

````

````{py:method} on_enter_tree() -> None
:canonical: simvx.core.physics.root.PhysicsRoot.on_enter_tree

```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot.on_enter_tree
```

````

````{py:method} on_exit_tree() -> None
:canonical: simvx.core.physics.root.PhysicsRoot.on_exit_tree

```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot.on_exit_tree
```

````

````{py:attribute} strict_errors
:canonical: simvx.core.physics.root.PhysicsRoot.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.physics.root.PhysicsRoot.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.physics.root.PhysicsRoot.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.physics.root.PhysicsRoot.name
:type: str

````

````{py:property} update_mode
:canonical: simvx.core.physics.root.PhysicsRoot.update_mode
:type: simvx.core.descriptors.UpdateMode

````

````{py:property} visible
:canonical: simvx.core.physics.root.PhysicsRoot.visible
:type: bool

````

````{py:method} reset_error() -> None
:canonical: simvx.core.physics.root.PhysicsRoot.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.physics.root.PhysicsRoot.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.physics.root.PhysicsRoot.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.physics.root.PhysicsRoot.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.physics.root.PhysicsRoot.get_node

````

````{py:method} get_node_or_none(path: str) -> simvx.core.node.Node | None
:canonical: simvx.core.physics.root.PhysicsRoot.get_node_or_none

````

````{py:method} find(target, *, direct: bool = False)
:canonical: simvx.core.physics.root.PhysicsRoot.find

````

````{py:method} find_all(target, *, direct: bool = False)
:canonical: simvx.core.physics.root.PhysicsRoot.find_all

````

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

````

````{py:property} path
:canonical: simvx.core.physics.root.PhysicsRoot.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.physics.root.PhysicsRoot.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.physics.root.PhysicsRoot.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.physics.root.PhysicsRoot.is_in_group

````

````{py:method} on_ready() -> None
:canonical: simvx.core.physics.root.PhysicsRoot.on_ready

````

````{py:method} on_update(dt: float) -> None
:canonical: simvx.core.physics.root.PhysicsRoot.on_update

````

````{py:method} on_fixed_update(dt: float) -> None
:canonical: simvx.core.physics.root.PhysicsRoot.on_fixed_update

````

````{py:method} on_draw(renderer) -> None
:canonical: simvx.core.physics.root.PhysicsRoot.on_draw

````

````{py:method} on_picked(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.physics.root.PhysicsRoot.on_picked

````

````{py:method} on_unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.physics.root.PhysicsRoot.on_unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.physics.root.PhysicsRoot.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.physics.root.PhysicsRoot.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.physics.root.PhysicsRoot.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.physics.root.PhysicsRoot.destroy

````

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

````

````{py:property} app
:canonical: simvx.core.physics.root.PhysicsRoot.app

````

````{py:property} tree
:canonical: simvx.core.physics.root.PhysicsRoot.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:property} physics
:canonical: simvx.core.physics.root.PhysicsRoot.physics

````

````{py:property} physics_2d
:canonical: simvx.core.physics.root.PhysicsRoot.physics_2d

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.physics.root.PhysicsRoot.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.physics.root.PhysicsRoot.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.physics.root.PhysicsRoot.__repr__

````

`````

`````{py:class} PhysicsRoot2D(name: str = '', *, gravity: simvx.core.math.Vec2 = _DEFAULT_GRAVITY_2D, backend: str | None = None, factory: simvx.core.physics.root.WorldFactory2D | None = None, **kwargs: object)
:canonical: simvx.core.physics.root.PhysicsRoot2D

Bases: {py:obj}`simvx.core.physics.root.PhysicsRoot`

```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot2D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot2D.__init__
```

````{py:property} world_2d
:canonical: simvx.core.physics.root.PhysicsRoot2D.world_2d
:type: simvx.core.physics.world2d.Physics2DWorld

```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot2D.world_2d
```

````

````{py:method} on_enter_tree() -> None
:canonical: simvx.core.physics.root.PhysicsRoot2D.on_enter_tree

```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot2D.on_enter_tree
```

````

````{py:method} on_exit_tree() -> None
:canonical: simvx.core.physics.root.PhysicsRoot2D.on_exit_tree

```{autodoc2-docstring} simvx.core.physics.root.PhysicsRoot2D.on_exit_tree
```

````

````{py:property} world
:canonical: simvx.core.physics.root.PhysicsRoot2D.world
:type: simvx.core.physics.world.PhysicsWorld

````

````{py:attribute} strict_errors
:canonical: simvx.core.physics.root.PhysicsRoot2D.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.physics.root.PhysicsRoot2D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.physics.root.PhysicsRoot2D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.physics.root.PhysicsRoot2D.name
:type: str

````

````{py:property} update_mode
:canonical: simvx.core.physics.root.PhysicsRoot2D.update_mode
:type: simvx.core.descriptors.UpdateMode

````

````{py:property} visible
:canonical: simvx.core.physics.root.PhysicsRoot2D.visible
:type: bool

````

````{py:method} reset_error() -> None
:canonical: simvx.core.physics.root.PhysicsRoot2D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.physics.root.PhysicsRoot2D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.physics.root.PhysicsRoot2D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.physics.root.PhysicsRoot2D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.physics.root.PhysicsRoot2D.get_node

````

````{py:method} get_node_or_none(path: str) -> simvx.core.node.Node | None
:canonical: simvx.core.physics.root.PhysicsRoot2D.get_node_or_none

````

````{py:method} find(target, *, direct: bool = False)
:canonical: simvx.core.physics.root.PhysicsRoot2D.find

````

````{py:method} find_all(target, *, direct: bool = False)
:canonical: simvx.core.physics.root.PhysicsRoot2D.find_all

````

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

````

````{py:property} path
:canonical: simvx.core.physics.root.PhysicsRoot2D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.physics.root.PhysicsRoot2D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.physics.root.PhysicsRoot2D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.physics.root.PhysicsRoot2D.is_in_group

````

````{py:method} on_ready() -> None
:canonical: simvx.core.physics.root.PhysicsRoot2D.on_ready

````

````{py:method} on_update(dt: float) -> None
:canonical: simvx.core.physics.root.PhysicsRoot2D.on_update

````

````{py:method} on_fixed_update(dt: float) -> None
:canonical: simvx.core.physics.root.PhysicsRoot2D.on_fixed_update

````

````{py:method} on_draw(renderer) -> None
:canonical: simvx.core.physics.root.PhysicsRoot2D.on_draw

````

````{py:method} on_picked(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.physics.root.PhysicsRoot2D.on_picked

````

````{py:method} on_unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.physics.root.PhysicsRoot2D.on_unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.physics.root.PhysicsRoot2D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.physics.root.PhysicsRoot2D.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.physics.root.PhysicsRoot2D.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.physics.root.PhysicsRoot2D.destroy

````

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

````

````{py:property} app
:canonical: simvx.core.physics.root.PhysicsRoot2D.app

````

````{py:property} tree
:canonical: simvx.core.physics.root.PhysicsRoot2D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:property} physics
:canonical: simvx.core.physics.root.PhysicsRoot2D.physics

````

````{py:property} physics_2d
:canonical: simvx.core.physics.root.PhysicsRoot2D.physics_2d

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.physics.root.PhysicsRoot2D.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.physics.root.PhysicsRoot2D.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.physics.root.PhysicsRoot2D.__repr__

````

`````

````{py:data} __all__
:canonical: simvx.core.physics.root.__all__
:value: >
   ['PhysicsRoot', 'PhysicsRoot2D', 'resolve_world', 'resolve_world_2d', 'WorldFactory', 'WorldFactory2...

```{autodoc2-docstring} simvx.core.physics.root.__all__
```

````