# {py:mod}`simvx.core.nodes_3d.spring_arm`

```{py:module} simvx.core.nodes_3d.spring_arm
```

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`SpringArm3D <simvx.core.nodes_3d.spring_arm.SpringArm3D>`
  - ```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D
    :summary:
    ```
````

### API

`````{py:class} SpringArm3D(**kwargs)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D

Bases: {py:obj}`simvx.core.nodes_3d.node3d.Node3D`

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D.__init__
```

````{py:attribute} spring_length
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.spring_length
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D.spring_length
```

````

````{py:attribute} margin
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.margin
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D.margin
```

````

````{py:attribute} collision_mask
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.collision_mask
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D.collision_mask
```

````

````{py:attribute} shape_radius
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.shape_radius
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D.shape_radius
```

````

````{py:attribute} gizmo_colour
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.gizmo_colour
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D.gizmo_colour
```

````

````{py:method} get_hit_length() -> float
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.get_hit_length

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D.get_hit_length
```

````

````{py:method} add_excluded_object(obj) -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.add_excluded_object

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D.add_excluded_object
```

````

````{py:method} remove_excluded_object(obj) -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.remove_excluded_object

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D.remove_excluded_object
```

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.physics_process

````

````{py:method} get_gizmo_lines() -> list[tuple[simvx.core.math.types.Vec3, simvx.core.math.types.Vec3]]
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.get_gizmo_lines

```{autodoc2-docstring} simvx.core.nodes_3d.spring_arm.SpringArm3D.get_gizmo_lines
```

````

````{py:attribute} render_layer
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.render_layer
:value: >
   'Property(...)'

````

````{py:property} position
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.position

````

````{py:property} rotation
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.rotation
:type: simvx.core.math.types.Quat

````

````{py:property} scale
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.scale

````

````{py:property} rotation_degrees
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.rotation_degrees
:type: simvx.core.math.types.Vec3

````

````{py:property} world_position
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.world_position
:type: simvx.core.math.types.Vec3

````

````{py:property} world_rotation
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.world_rotation
:type: simvx.core.math.types.Quat

````

````{py:property} world_scale
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.world_scale
:type: simvx.core.math.types.Vec3

````

````{py:property} forward
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.forward
:type: simvx.core.math.types.Vec3

````

````{py:property} right
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.right
:type: simvx.core.math.types.Vec3

````

````{py:property} up
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.up
:type: simvx.core.math.types.Vec3

````

````{py:method} translate(offset: tuple[float, float, float] | numpy.ndarray)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.translate

````

````{py:method} translate_global(offset: tuple[float, float, float] | numpy.ndarray)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.translate_global

````

````{py:method} rotate(axis: tuple[float, float, float] | numpy.ndarray, angle: float)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.rotate

````

````{py:method} rotate_x(angle: float)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.rotate_x

````

````{py:method} rotate_y(angle: float)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.rotate_y

````

````{py:method} rotate_z(angle: float)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.rotate_z

````

````{py:method} look_at(target: tuple[float, float, float] | numpy.ndarray, up=None)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.look_at

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.is_on_render_layer

````

````{py:method} wrap_bounds(bounds: tuple[float, float, float] | numpy.ndarray, margin: float = 1.0)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.wrap_bounds

````

````{py:attribute} strict_errors
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.find_child

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.find_all

````

````{py:property} path
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.destroy

````

````{py:property} app
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.app

````

````{py:property} tree
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.nodes_3d.spring_arm.SpringArm3D.__repr__

````

`````