Struct UgrParams 

pub struct UgrParams {
    pub room_length: f64,
    pub room_width: f64,
    pub mounting_height: f64,
    pub eye_height: f64,
    pub observer_x: f64,
    pub observer_y: f64,
    pub rho_ceiling: f64,
    pub rho_wall: f64,
    pub rho_floor: f64,
    pub illuminance: f64,
    /* private fields */
}

Parameters for UGR calculation.

Fields

room_length: f64

Room length (m)

room_width: f64

Room width (m)

mounting_height: f64

Mounting height above floor (m)

eye_height: f64

Observer eye height (m)

observer_x: f64

Observer X position (m)

observer_y: f64

Observer Y position (m)

rho_ceiling: f64

Ceiling reflectance (0-1)

rho_wall: f64

Wall reflectance (0-1)

rho_floor: f64

Floor reflectance (0-1)

illuminance: f64

Target illuminance (lux)

Trait Implementations

impl Clone for UgrParams

fn clone(&self) -> UgrParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UgrParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&UgrParams> for UgrParams

fn from(p: &UgrParams) -> Self

Converts to this type from the input type.

impl From<UgrParams> for UgrParams

fn from(p: CoreUgrParams) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for UgrParams

type Target = UgrParams

The Python output type

type Output = Bound<'py, <UgrParams as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for UgrParams

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for UgrParams

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Parameters for UGR calculation.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<UgrParams>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for UgrParams

const TEXT_SIGNATURE: &'static str = "(room_length=8.0, room_width=4.0, mounting_height=2.8, eye_height=1.2, observer_x=4.0, observer_y=2.0)"

impl PyMethods<UgrParams> for PyClassImplCollector<UgrParams>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for UgrParams

const NAME: &'static str = "UgrParams"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for UgrParams

impl ExtractPyClassWithClone for UgrParams