# {py:mod}`simvx.core.surface_tool`

```{py:module} simvx.core.surface_tool
```

```{autodoc2-docstring} simvx.core.surface_tool
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`PrimitiveType <simvx.core.surface_tool.PrimitiveType>`
  - ```{autodoc2-docstring} simvx.core.surface_tool.PrimitiveType
    :summary:
    ```
* - {py:obj}`SurfaceTool <simvx.core.surface_tool.SurfaceTool>`
  - ```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool
    :summary:
    ```
* - {py:obj}`ImmediateGeometry3D <simvx.core.surface_tool.ImmediateGeometry3D>`
  - ```{autodoc2-docstring} simvx.core.surface_tool.ImmediateGeometry3D
    :summary:
    ```
````

### Functions

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

* - {py:obj}`create_box <simvx.core.surface_tool.create_box>`
  - ```{autodoc2-docstring} simvx.core.surface_tool.create_box
    :summary:
    ```
* - {py:obj}`create_sphere <simvx.core.surface_tool.create_sphere>`
  - ```{autodoc2-docstring} simvx.core.surface_tool.create_sphere
    :summary:
    ```
* - {py:obj}`create_cylinder <simvx.core.surface_tool.create_cylinder>`
  - ```{autodoc2-docstring} simvx.core.surface_tool.create_cylinder
    :summary:
    ```
* - {py:obj}`create_plane <simvx.core.surface_tool.create_plane>`
  - ```{autodoc2-docstring} simvx.core.surface_tool.create_plane
    :summary:
    ```
* - {py:obj}`create_capsule <simvx.core.surface_tool.create_capsule>`
  - ```{autodoc2-docstring} simvx.core.surface_tool.create_capsule
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} log
:canonical: simvx.core.surface_tool.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.core.surface_tool.log
```

````

````{py:data} __all__
:canonical: simvx.core.surface_tool.__all__
:value: >
   ['SurfaceTool', 'PrimitiveType', 'ImmediateGeometry3D', 'create_box', 'create_sphere', 'create_cylin...

```{autodoc2-docstring} simvx.core.surface_tool.__all__
```

````

`````{py:class} PrimitiveType()
:canonical: simvx.core.surface_tool.PrimitiveType

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

```{autodoc2-docstring} simvx.core.surface_tool.PrimitiveType
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.surface_tool.PrimitiveType.__init__
```

````{py:attribute} TRIANGLES
:canonical: simvx.core.surface_tool.PrimitiveType.TRIANGLES
:value: >
   0

```{autodoc2-docstring} simvx.core.surface_tool.PrimitiveType.TRIANGLES
```

````

````{py:attribute} LINES
:canonical: simvx.core.surface_tool.PrimitiveType.LINES
:value: >
   1

```{autodoc2-docstring} simvx.core.surface_tool.PrimitiveType.LINES
```

````

````{py:attribute} POINTS
:canonical: simvx.core.surface_tool.PrimitiveType.POINTS
:value: >
   2

```{autodoc2-docstring} simvx.core.surface_tool.PrimitiveType.POINTS
```

````

````{py:attribute} TRIANGLE_STRIP
:canonical: simvx.core.surface_tool.PrimitiveType.TRIANGLE_STRIP
:value: >
   3

```{autodoc2-docstring} simvx.core.surface_tool.PrimitiveType.TRIANGLE_STRIP
```

````

````{py:method} __abs__()
:canonical: simvx.core.surface_tool.PrimitiveType.__abs__

````

````{py:method} __add__()
:canonical: simvx.core.surface_tool.PrimitiveType.__add__

````

````{py:method} __and__()
:canonical: simvx.core.surface_tool.PrimitiveType.__and__

````

````{py:method} __bool__()
:canonical: simvx.core.surface_tool.PrimitiveType.__bool__

````

````{py:method} __ceil__()
:canonical: simvx.core.surface_tool.PrimitiveType.__ceil__

````

````{py:method} __delattr__()
:canonical: simvx.core.surface_tool.PrimitiveType.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.core.surface_tool.PrimitiveType.__dir__

````

````{py:method} __divmod__()
:canonical: simvx.core.surface_tool.PrimitiveType.__divmod__

````

````{py:method} __eq__()
:canonical: simvx.core.surface_tool.PrimitiveType.__eq__

````

````{py:method} __float__()
:canonical: simvx.core.surface_tool.PrimitiveType.__float__

````

````{py:method} __floor__()
:canonical: simvx.core.surface_tool.PrimitiveType.__floor__

````

````{py:method} __floordiv__()
:canonical: simvx.core.surface_tool.PrimitiveType.__floordiv__

````

````{py:method} __format__()
:canonical: simvx.core.surface_tool.PrimitiveType.__format__

````

````{py:method} __ge__()
:canonical: simvx.core.surface_tool.PrimitiveType.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.core.surface_tool.PrimitiveType.__getattribute__

````

````{py:method} __getnewargs__()
:canonical: simvx.core.surface_tool.PrimitiveType.__getnewargs__

````

````{py:method} __getstate__()
:canonical: simvx.core.surface_tool.PrimitiveType.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.core.surface_tool.PrimitiveType.__gt__

````

````{py:method} __hash__()
:canonical: simvx.core.surface_tool.PrimitiveType.__hash__

````

````{py:method} __index__()
:canonical: simvx.core.surface_tool.PrimitiveType.__index__

````

````{py:method} __int__()
:canonical: simvx.core.surface_tool.PrimitiveType.__int__

````

````{py:method} __invert__()
:canonical: simvx.core.surface_tool.PrimitiveType.__invert__

````

````{py:method} __le__()
:canonical: simvx.core.surface_tool.PrimitiveType.__le__

````

````{py:method} __lshift__()
:canonical: simvx.core.surface_tool.PrimitiveType.__lshift__

````

````{py:method} __lt__()
:canonical: simvx.core.surface_tool.PrimitiveType.__lt__

````

````{py:method} __mod__()
:canonical: simvx.core.surface_tool.PrimitiveType.__mod__

````

````{py:method} __mul__()
:canonical: simvx.core.surface_tool.PrimitiveType.__mul__

````

````{py:method} __ne__()
:canonical: simvx.core.surface_tool.PrimitiveType.__ne__

````

````{py:method} __neg__()
:canonical: simvx.core.surface_tool.PrimitiveType.__neg__

````

````{py:method} __new__()
:canonical: simvx.core.surface_tool.PrimitiveType.__new__

````

````{py:method} __or__()
:canonical: simvx.core.surface_tool.PrimitiveType.__or__

````

````{py:method} __pos__()
:canonical: simvx.core.surface_tool.PrimitiveType.__pos__

````

````{py:method} __pow__()
:canonical: simvx.core.surface_tool.PrimitiveType.__pow__

````

````{py:method} __radd__()
:canonical: simvx.core.surface_tool.PrimitiveType.__radd__

````

````{py:method} __rand__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rand__

````

````{py:method} __rdivmod__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rdivmod__

````

````{py:method} __reduce__()
:canonical: simvx.core.surface_tool.PrimitiveType.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.core.surface_tool.PrimitiveType.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.core.surface_tool.PrimitiveType.__repr__

````

````{py:method} __rfloordiv__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rfloordiv__

````

````{py:method} __rlshift__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rlshift__

````

````{py:method} __rmod__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rmod__

````

````{py:method} __rmul__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rmul__

````

````{py:method} __ror__()
:canonical: simvx.core.surface_tool.PrimitiveType.__ror__

````

````{py:method} __round__()
:canonical: simvx.core.surface_tool.PrimitiveType.__round__

````

````{py:method} __rpow__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rpow__

````

````{py:method} __rrshift__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rrshift__

````

````{py:method} __rshift__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rshift__

````

````{py:method} __rsub__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rsub__

````

````{py:method} __rtruediv__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rtruediv__

````

````{py:method} __rxor__()
:canonical: simvx.core.surface_tool.PrimitiveType.__rxor__

````

````{py:method} __setattr__()
:canonical: simvx.core.surface_tool.PrimitiveType.__setattr__

````

````{py:method} __sizeof__()
:canonical: simvx.core.surface_tool.PrimitiveType.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.core.surface_tool.PrimitiveType.__str__

````

````{py:method} __sub__()
:canonical: simvx.core.surface_tool.PrimitiveType.__sub__

````

````{py:method} __subclasshook__()
:canonical: simvx.core.surface_tool.PrimitiveType.__subclasshook__

````

````{py:method} __truediv__()
:canonical: simvx.core.surface_tool.PrimitiveType.__truediv__

````

````{py:method} __trunc__()
:canonical: simvx.core.surface_tool.PrimitiveType.__trunc__

````

````{py:method} __xor__()
:canonical: simvx.core.surface_tool.PrimitiveType.__xor__

````

````{py:method} as_integer_ratio()
:canonical: simvx.core.surface_tool.PrimitiveType.as_integer_ratio

````

````{py:method} bit_count()
:canonical: simvx.core.surface_tool.PrimitiveType.bit_count

````

````{py:method} bit_length()
:canonical: simvx.core.surface_tool.PrimitiveType.bit_length

````

````{py:method} conjugate()
:canonical: simvx.core.surface_tool.PrimitiveType.conjugate

````

```{py:class} denominator
:canonical: simvx.core.surface_tool.PrimitiveType.denominator

```

```{py:class} imag
:canonical: simvx.core.surface_tool.PrimitiveType.imag

```

````{py:method} is_integer()
:canonical: simvx.core.surface_tool.PrimitiveType.is_integer

````

```{py:class} numerator
:canonical: simvx.core.surface_tool.PrimitiveType.numerator

```

```{py:class} real
:canonical: simvx.core.surface_tool.PrimitiveType.real

```

````{py:method} to_bytes()
:canonical: simvx.core.surface_tool.PrimitiveType.to_bytes

````

````{py:method} __deepcopy__(memo)
:canonical: simvx.core.surface_tool.PrimitiveType.__deepcopy__

````

````{py:method} __copy__()
:canonical: simvx.core.surface_tool.PrimitiveType.__copy__

````

````{py:method} name()
:canonical: simvx.core.surface_tool.PrimitiveType.name

````

````{py:method} value()
:canonical: simvx.core.surface_tool.PrimitiveType.value

````

`````

`````{py:class} SurfaceTool()
:canonical: simvx.core.surface_tool.SurfaceTool

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.surface_tool.SurfaceTool.__slots__
:value: >
   ('_primitive', '_positions', '_normals', '_uvs', '_colours', '_indices', '_cur_normal', '_cur_uv', '...

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.__slots__
```

````

````{py:method} begin(primitive: simvx.core.surface_tool.PrimitiveType = PrimitiveType.TRIANGLES) -> None
:canonical: simvx.core.surface_tool.SurfaceTool.begin

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.begin
```

````

````{py:method} set_normal(normal: collections.abc.Sequence[float] | simvx.core.math.types.Vec3) -> None
:canonical: simvx.core.surface_tool.SurfaceTool.set_normal

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.set_normal
```

````

````{py:method} set_uv(uv: collections.abc.Sequence[float] | simvx.core.math.types.Vec2) -> None
:canonical: simvx.core.surface_tool.SurfaceTool.set_uv

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.set_uv
```

````

````{py:method} set_colour(colour: collections.abc.Sequence[float]) -> None
:canonical: simvx.core.surface_tool.SurfaceTool.set_colour

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.set_colour
```

````

````{py:method} add_vertex(position: collections.abc.Sequence[float] | simvx.core.math.types.Vec3) -> None
:canonical: simvx.core.surface_tool.SurfaceTool.add_vertex

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.add_vertex
```

````

````{py:method} add_index(index: int) -> None
:canonical: simvx.core.surface_tool.SurfaceTool.add_index

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.add_index
```

````

````{py:method} add_triangle_fan(vertices: collections.abc.Sequence[collections.abc.Sequence[float]], uvs: collections.abc.Sequence[collections.abc.Sequence[float]] | None = None, normals: collections.abc.Sequence[collections.abc.Sequence[float]] | None = None) -> None
:canonical: simvx.core.surface_tool.SurfaceTool.add_triangle_fan

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.add_triangle_fan
```

````

````{py:method} generate_normals() -> None
:canonical: simvx.core.surface_tool.SurfaceTool.generate_normals

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.generate_normals
```

````

````{py:method} generate_tangents() -> None
:canonical: simvx.core.surface_tool.SurfaceTool.generate_tangents

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.generate_tangents
```

````

````{py:method} commit() -> simvx.core.graphics.mesh.Mesh
:canonical: simvx.core.surface_tool.SurfaceTool.commit

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.commit
```

````

````{py:method} clear() -> None
:canonical: simvx.core.surface_tool.SurfaceTool.clear

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.clear
```

````

````{py:property} vertex_count
:canonical: simvx.core.surface_tool.SurfaceTool.vertex_count
:type: int

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.vertex_count
```

````

````{py:property} index_count
:canonical: simvx.core.surface_tool.SurfaceTool.index_count
:type: int

```{autodoc2-docstring} simvx.core.surface_tool.SurfaceTool.index_count
```

````

`````

`````{py:class} ImmediateGeometry3D(**kwargs)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D

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

```{autodoc2-docstring} simvx.core.surface_tool.ImmediateGeometry3D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.surface_tool.ImmediateGeometry3D.__init__
```

````{py:method} process(dt: float) -> None
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.process

````

````{py:attribute} render_layer
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.render_layer
:value: >
   'Property(...)'

````

````{py:property} position
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.position

````

````{py:property} rotation
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.rotation
:type: simvx.core.math.types.Quat

````

````{py:property} scale
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.scale

````

````{py:property} rotation_degrees
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.rotation_degrees
:type: simvx.core.math.types.Vec3

````

````{py:property} world_position
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.world_position
:type: simvx.core.math.types.Vec3

````

````{py:property} world_rotation
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.world_rotation
:type: simvx.core.math.types.Quat

````

````{py:property} world_scale
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.world_scale
:type: simvx.core.math.types.Vec3

````

````{py:property} forward
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.forward
:type: simvx.core.math.types.Vec3

````

````{py:property} right
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.right
:type: simvx.core.math.types.Vec3

````

````{py:property} up
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.up
:type: simvx.core.math.types.Vec3

````

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

````

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

````

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

````

````{py:method} rotate_x(angle: float)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.rotate_x

````

````{py:method} rotate_y(angle: float)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.rotate_y

````

````{py:method} rotate_z(angle: float)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.rotate_z

````

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

````

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

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.is_on_render_layer

````

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

````

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

````

````{py:attribute} script_error_raised
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.get_node

````

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

````

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

````

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

````

````{py:property} path
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.destroy

````

````{py:property} app
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.app

````

````{py:property} tree
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.core.surface_tool.ImmediateGeometry3D.__repr__

````

`````

````{py:function} create_box(size: float | collections.abc.Sequence[float] = 1.0) -> simvx.core.graphics.mesh.Mesh
:canonical: simvx.core.surface_tool.create_box

```{autodoc2-docstring} simvx.core.surface_tool.create_box
```
````

````{py:function} create_sphere(radius: float = 1.0, rings: int = 16, sectors: int = 16) -> simvx.core.graphics.mesh.Mesh
:canonical: simvx.core.surface_tool.create_sphere

```{autodoc2-docstring} simvx.core.surface_tool.create_sphere
```
````

````{py:function} create_cylinder(radius: float = 0.5, height: float = 1.0, segments: int = 16) -> simvx.core.graphics.mesh.Mesh
:canonical: simvx.core.surface_tool.create_cylinder

```{autodoc2-docstring} simvx.core.surface_tool.create_cylinder
```
````

````{py:function} create_plane(size: float | collections.abc.Sequence[float] = 1.0, subdivisions: int = 1) -> simvx.core.graphics.mesh.Mesh
:canonical: simvx.core.surface_tool.create_plane

```{autodoc2-docstring} simvx.core.surface_tool.create_plane
```
````

````{py:function} create_capsule(radius: float = 0.5, height: float = 1.0, rings: int = 8, sectors: int = 16) -> simvx.core.graphics.mesh.Mesh
:canonical: simvx.core.surface_tool.create_capsule

```{autodoc2-docstring} simvx.core.surface_tool.create_capsule
```
````