Struct Point 

pub struct Point {
    pub position: Vec3,
    pub direction: Vec3,
    pub area: f32,
    pub gravity: f32,
    pub eclipse: Etype,
    pub flux: f32,
}

Struct defining a point on the surface of a model grid (e.g. of a star or disc etc.) A Point has a position, a direction which is the surface normal, an area, a relative gravity, a vector of phase pairs defining when the point is eclipsed by another model component, and a flux.

Fields

position: Vec3

direction: Vec3

area: f32

gravity: f32

eclipse: Etype

flux: f32

Implementations

impl Point

pub fn new( position: Vec3, direction: Vec3, area: f64, gravity: f64, eclipse: Etype, ) -> Self

Creates a new Point.

pub fn set_flux(&mut self, flux: f32)

sets the point’s flux.

pub fn is_visible(&self, phase: f64) -> bool

checks that the given phase is not during one of the phase ranges when the point is eclipsed.

pub fn is_visible_phase_normed(&self, phase: f64) -> bool

This version of is_visible will not correct for phases outside of expected range to speed up large loops. run phase = phase - phase.floor(); outside of loop beforehand

Trait Implementations

impl Clone for Point

fn clone(&self) -> Point

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Point

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

Formats the value using the given formatter.

impl Default for Point

fn default() -> Self

Returns the “default value” for a type.

impl Display for Point

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

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for Point

type Target = Point

The Python output type

type Output = Bound<'py, <Point 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 Point

const NAME: &str = "Point"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Point

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

Module which the class will be associated with.

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 = /// /// Struct defining a point on the surface of a model grid (e.g. of a star or disc etc.) /// A `Point` has a position, a direction which is the surface normal, an area, /// a relative gravity, a vector of phase pairs defining when the point is eclipsed by /// another model component, and a flux. ///

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 Layout = <<Point as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<Point>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

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<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for Point

const TEXT_SIGNATURE: &'static str = "(position, direction, area, gravity, eclipse)"

impl PyMethods<Point> for PyClassImplCollector<Point>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Point

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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 Point