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

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

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

## Module Contents

### Classes

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

* - {py:obj}`CombineMode <simvx.core.physics.material.CombineMode>`
  - ```{autodoc2-docstring} simvx.core.physics.material.CombineMode
    :summary:
    ```
* - {py:obj}`PhysicsMaterial <simvx.core.physics.material.PhysicsMaterial>`
  - ```{autodoc2-docstring} simvx.core.physics.material.PhysicsMaterial
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.core.physics.material.__all__>`
  - ```{autodoc2-docstring} simvx.core.physics.material.__all__
    :summary:
    ```
* - {py:obj}`DEFAULT_PHYSICS_MATERIAL <simvx.core.physics.material.DEFAULT_PHYSICS_MATERIAL>`
  - ```{autodoc2-docstring} simvx.core.physics.material.DEFAULT_PHYSICS_MATERIAL
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.physics.material.__all__
:value: >
   ['CombineMode', 'PhysicsMaterial']

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

````

`````{py:class} CombineMode
:canonical: simvx.core.physics.material.CombineMode

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

```{autodoc2-docstring} simvx.core.physics.material.CombineMode
```

````{py:attribute} AVERAGE
:canonical: simvx.core.physics.material.CombineMode.AVERAGE
:value: >
   'average'

```{autodoc2-docstring} simvx.core.physics.material.CombineMode.AVERAGE
```

````

````{py:attribute} MIN
:canonical: simvx.core.physics.material.CombineMode.MIN
:value: >
   'minimum'

```{autodoc2-docstring} simvx.core.physics.material.CombineMode.MIN
```

````

````{py:attribute} MAX
:canonical: simvx.core.physics.material.CombineMode.MAX
:value: >
   'maximum'

```{autodoc2-docstring} simvx.core.physics.material.CombineMode.MAX
```

````

````{py:attribute} MULTIPLY
:canonical: simvx.core.physics.material.CombineMode.MULTIPLY
:value: >
   'multiply'

```{autodoc2-docstring} simvx.core.physics.material.CombineMode.MULTIPLY
```

````

````{py:method} __new__(value)
:canonical: simvx.core.physics.material.CombineMode.__new__

````

````{py:method} __repr__()
:canonical: simvx.core.physics.material.CombineMode.__repr__

````

````{py:method} __str__()
:canonical: simvx.core.physics.material.CombineMode.__str__

````

````{py:method} __dir__()
:canonical: simvx.core.physics.material.CombineMode.__dir__

````

````{py:method} __format__(format_spec)
:canonical: simvx.core.physics.material.CombineMode.__format__

````

````{py:method} __hash__()
:canonical: simvx.core.physics.material.CombineMode.__hash__

````

````{py:method} __reduce_ex__(proto)
:canonical: simvx.core.physics.material.CombineMode.__reduce_ex__

````

````{py:method} __deepcopy__(memo)
:canonical: simvx.core.physics.material.CombineMode.__deepcopy__

````

````{py:method} __copy__()
:canonical: simvx.core.physics.material.CombineMode.__copy__

````

````{py:method} name()
:canonical: simvx.core.physics.material.CombineMode.name

````

````{py:method} value()
:canonical: simvx.core.physics.material.CombineMode.value

````

`````

`````{py:class} PhysicsMaterial
:canonical: simvx.core.physics.material.PhysicsMaterial

```{autodoc2-docstring} simvx.core.physics.material.PhysicsMaterial
```

````{py:attribute} friction
:canonical: simvx.core.physics.material.PhysicsMaterial.friction
:type: float
:value: >
   0.5

```{autodoc2-docstring} simvx.core.physics.material.PhysicsMaterial.friction
```

````

````{py:attribute} restitution
:canonical: simvx.core.physics.material.PhysicsMaterial.restitution
:type: float
:value: >
   0.0

```{autodoc2-docstring} simvx.core.physics.material.PhysicsMaterial.restitution
```

````

````{py:attribute} friction_combine
:canonical: simvx.core.physics.material.PhysicsMaterial.friction_combine
:type: simvx.core.physics.material.CombineMode
:value: >
   None

```{autodoc2-docstring} simvx.core.physics.material.PhysicsMaterial.friction_combine
```

````

````{py:attribute} restitution_combine
:canonical: simvx.core.physics.material.PhysicsMaterial.restitution_combine
:type: simvx.core.physics.material.CombineMode
:value: >
   None

```{autodoc2-docstring} simvx.core.physics.material.PhysicsMaterial.restitution_combine
```

````

````{py:method} __post_init__() -> None
:canonical: simvx.core.physics.material.PhysicsMaterial.__post_init__

```{autodoc2-docstring} simvx.core.physics.material.PhysicsMaterial.__post_init__
```

````

`````

````{py:data} DEFAULT_PHYSICS_MATERIAL
:canonical: simvx.core.physics.material.DEFAULT_PHYSICS_MATERIAL
:value: >
   'PhysicsMaterial(...)'

```{autodoc2-docstring} simvx.core.physics.material.DEFAULT_PHYSICS_MATERIAL
```

````