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

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

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

## Module Contents

### Classes

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

* - {py:obj}`Colour <simvx.core.properties.Colour>`
  - ```{autodoc2-docstring} simvx.core.properties.Colour
    :summary:
    ```
* - {py:obj}`FilePath <simvx.core.properties.FilePath>`
  - ```{autodoc2-docstring} simvx.core.properties.FilePath
    :summary:
    ```
* - {py:obj}`Multiline <simvx.core.properties.Multiline>`
  - ```{autodoc2-docstring} simvx.core.properties.Multiline
    :summary:
    ```
* - {py:obj}`Bitmask <simvx.core.properties.Bitmask>`
  - ```{autodoc2-docstring} simvx.core.properties.Bitmask
    :summary:
    ```
* - {py:obj}`NodePath <simvx.core.properties.NodePath>`
  - ```{autodoc2-docstring} simvx.core.properties.NodePath
    :summary:
    ```
````

### Data

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

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

### API

`````{py:class} Colour(default: tuple = (1.0, 1.0, 1.0, 1.0), *, has_alpha: bool = True, **kwargs)
:canonical: simvx.core.properties.Colour

Bases: {py:obj}`simvx.core.descriptors.Property`

```{autodoc2-docstring} simvx.core.properties.Colour
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.properties.Colour.__init__
```

````{py:attribute} WHITE
:canonical: simvx.core.properties.Colour.WHITE
:value: >
   (1.0, 1.0, 1.0, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.WHITE
```

````

````{py:attribute} BLACK
:canonical: simvx.core.properties.Colour.BLACK
:value: >
   (0.0, 0.0, 0.0, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.BLACK
```

````

````{py:attribute} RED
:canonical: simvx.core.properties.Colour.RED
:value: >
   (1.0, 0.0, 0.0, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.RED
```

````

````{py:attribute} GREEN
:canonical: simvx.core.properties.Colour.GREEN
:value: >
   (0.0, 1.0, 0.0, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.GREEN
```

````

````{py:attribute} BLUE
:canonical: simvx.core.properties.Colour.BLUE
:value: >
   (0.0, 0.0, 1.0, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.BLUE
```

````

````{py:attribute} YELLOW
:canonical: simvx.core.properties.Colour.YELLOW
:value: >
   (1.0, 1.0, 0.0, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.YELLOW
```

````

````{py:attribute} CYAN
:canonical: simvx.core.properties.Colour.CYAN
:value: >
   (0.0, 1.0, 1.0, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.CYAN
```

````

````{py:attribute} MAGENTA
:canonical: simvx.core.properties.Colour.MAGENTA
:value: >
   (1.0, 0.0, 1.0, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.MAGENTA
```

````

````{py:attribute} TRANSPARENT
:canonical: simvx.core.properties.Colour.TRANSPARENT
:value: >
   (0.0, 0.0, 0.0, 0.0)

```{autodoc2-docstring} simvx.core.properties.Colour.TRANSPARENT
```

````

````{py:attribute} GRAY
:canonical: simvx.core.properties.Colour.GRAY
:value: >
   (0.5, 0.5, 0.5, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.GRAY
```

````

````{py:attribute} DARK_GRAY
:canonical: simvx.core.properties.Colour.DARK_GRAY
:value: >
   (0.2, 0.2, 0.2, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.DARK_GRAY
```

````

````{py:attribute} LIGHT_GRAY
:canonical: simvx.core.properties.Colour.LIGHT_GRAY
:value: >
   (0.75, 0.75, 0.75, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.LIGHT_GRAY
```

````

````{py:attribute} ORANGE
:canonical: simvx.core.properties.Colour.ORANGE
:value: >
   (1.0, 0.6, 0.0, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.ORANGE
```

````

````{py:attribute} PURPLE
:canonical: simvx.core.properties.Colour.PURPLE
:value: >
   (0.6, 0.2, 0.8, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.PURPLE
```

````

````{py:attribute} PINK
:canonical: simvx.core.properties.Colour.PINK
:value: >
   (1.0, 0.4, 0.7, 1.0)

```{autodoc2-docstring} simvx.core.properties.Colour.PINK
```

````

````{py:attribute} __slots__
:canonical: simvx.core.properties.Colour.__slots__
:value: >
   ('has_alpha',)

```{autodoc2-docstring} simvx.core.properties.Colour.__slots__
```

````

````{py:method} __set__(obj, value)
:canonical: simvx.core.properties.Colour.__set__

```{autodoc2-docstring} simvx.core.properties.Colour.__set__
```

````

````{py:method} hex(h: str) -> tuple[float, float, float, float]
:canonical: simvx.core.properties.Colour.hex
:staticmethod:

```{autodoc2-docstring} simvx.core.properties.Colour.hex
```

````

````{py:method} rgba(r: float, g: float, b: float, a: float = 1.0) -> tuple[float, float, float, float]
:canonical: simvx.core.properties.Colour.rgba
:staticmethod:

```{autodoc2-docstring} simvx.core.properties.Colour.rgba
```

````

````{py:method} from_255(r: int, g: int, b: int, a: int = 255) -> tuple[float, float, float, float]
:canonical: simvx.core.properties.Colour.from_255
:staticmethod:

```{autodoc2-docstring} simvx.core.properties.Colour.from_255
```

````

````{py:method} __set_name__(owner, name)
:canonical: simvx.core.properties.Colour.__set_name__

````

````{py:method} __get__(obj, objtype=None)
:canonical: simvx.core.properties.Colour.__get__

````

````{py:method} __repr__()
:canonical: simvx.core.properties.Colour.__repr__

````

`````

`````{py:class} FilePath(default: str = '', *, filter: str = '*.*', relative_to: str | None = None, **kwargs)
:canonical: simvx.core.properties.FilePath

Bases: {py:obj}`simvx.core.descriptors.Property`

```{autodoc2-docstring} simvx.core.properties.FilePath
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.properties.FilePath.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.properties.FilePath.__slots__
:value: >
   ('filter', 'relative_to')

```{autodoc2-docstring} simvx.core.properties.FilePath.__slots__
```

````

````{py:method} __set__(obj, value)
:canonical: simvx.core.properties.FilePath.__set__

```{autodoc2-docstring} simvx.core.properties.FilePath.__set__
```

````

````{py:method} __set_name__(owner, name)
:canonical: simvx.core.properties.FilePath.__set_name__

````

````{py:method} __get__(obj, objtype=None)
:canonical: simvx.core.properties.FilePath.__get__

````

````{py:method} __repr__()
:canonical: simvx.core.properties.FilePath.__repr__

````

`````

`````{py:class} Multiline(default: str = '', *, min_lines: int = 3, syntax: str | None = None, **kwargs)
:canonical: simvx.core.properties.Multiline

Bases: {py:obj}`simvx.core.descriptors.Property`

```{autodoc2-docstring} simvx.core.properties.Multiline
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.properties.Multiline.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.properties.Multiline.__slots__
:value: >
   ('min_lines', 'syntax')

```{autodoc2-docstring} simvx.core.properties.Multiline.__slots__
```

````

````{py:method} __set__(obj, value)
:canonical: simvx.core.properties.Multiline.__set__

```{autodoc2-docstring} simvx.core.properties.Multiline.__set__
```

````

````{py:method} __set_name__(owner, name)
:canonical: simvx.core.properties.Multiline.__set_name__

````

````{py:method} __get__(obj, objtype=None)
:canonical: simvx.core.properties.Multiline.__get__

````

````{py:method} __repr__()
:canonical: simvx.core.properties.Multiline.__repr__

````

`````

`````{py:class} Bitmask(default: int = 0, *, bits: int = 32, names: list[str] | None = None, **kwargs)
:canonical: simvx.core.properties.Bitmask

Bases: {py:obj}`simvx.core.descriptors.Property`

```{autodoc2-docstring} simvx.core.properties.Bitmask
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.properties.Bitmask.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.properties.Bitmask.__slots__
:value: >
   ('bits', 'names')

```{autodoc2-docstring} simvx.core.properties.Bitmask.__slots__
```

````

````{py:method} __set__(obj, value)
:canonical: simvx.core.properties.Bitmask.__set__

```{autodoc2-docstring} simvx.core.properties.Bitmask.__set__
```

````

````{py:method} __set_name__(owner, name)
:canonical: simvx.core.properties.Bitmask.__set_name__

````

````{py:method} __get__(obj, objtype=None)
:canonical: simvx.core.properties.Bitmask.__get__

````

````{py:method} __repr__()
:canonical: simvx.core.properties.Bitmask.__repr__

````

`````

`````{py:class} NodePath(default: str = '', *, type_filter: type | None = None, **kwargs)
:canonical: simvx.core.properties.NodePath

Bases: {py:obj}`simvx.core.descriptors.Property`

```{autodoc2-docstring} simvx.core.properties.NodePath
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.properties.NodePath.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.properties.NodePath.__slots__
:value: >
   ('type_filter',)

```{autodoc2-docstring} simvx.core.properties.NodePath.__slots__
```

````

````{py:method} __set__(obj, value)
:canonical: simvx.core.properties.NodePath.__set__

```{autodoc2-docstring} simvx.core.properties.NodePath.__set__
```

````

````{py:method} __set_name__(owner, name)
:canonical: simvx.core.properties.NodePath.__set_name__

````

````{py:method} __get__(obj, objtype=None)
:canonical: simvx.core.properties.NodePath.__get__

````

````{py:method} __repr__()
:canonical: simvx.core.properties.NodePath.__repr__

````

`````

````{py:data} __all__
:canonical: simvx.core.properties.__all__
:value: >
   ['Bitmask', 'Colour', 'FilePath', 'Multiline', 'NodePath']

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

````