pyrot.eye_modelling.datamodels.validators
=========================================

.. py:module:: pyrot.eye_modelling.datamodels.validators


Classes
-------

.. autoapisummary::

   pyrot.eye_modelling.datamodels.validators.Vector3


Functions
---------

.. autoapisummary::

   pyrot.eye_modelling.datamodels.validators.rayocular_field
   pyrot.eye_modelling.datamodels.validators.dataclass
   pyrot.eye_modelling.datamodels.validators.positive_float
   pyrot.eye_modelling.datamodels.validators.vector3


Module Contents
---------------

.. py:function:: rayocular_field(validator: Callable[[Any], Value], name: str | None = None) -> Value

   Creates a validated field with the given validator.

   Parameters
   ----------
   name : str
       The RayOcular name of the field.
   validator : Callable[[Any], Value]
       A callable object that takes any value as input and returns a validated value.

   Returns
   -------
   ValidatedField[Instance, Value]
       The validated field.


.. py:function:: dataclass(cls: type[Value]) -> Callable[Ellipsis, Value]

.. py:function:: positive_float(value: Any) -> float

.. py:class:: Vector3

   Bases: :py:obj:`Generic`\ [\ :py:obj:`Value`\ ]


   .. py:attribute:: x
      :type:  Value


   .. py:attribute:: y
      :type:  Value


   .. py:attribute:: z
      :type:  Value


.. py:function:: vector3(item_validator: Callable[Ellipsis, Item]) -> Callable[[Any], Vector3[Item]]