Struct cam_geom::RayBundle

source · [−]

pub struct RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
    Coords: CoordinateSystem,
    BType: Bundle<R>,
    R: RealField,
    NPTS: Dim,
    StorageMultiple: Storage<R, NPTS, U3>,  {
    pub data: Matrix<R, NPTS, U3, StorageMultiple>,
    /* private fields */
}

Expand description

3D rays. Can be in any CoordinateSystem.

Any given RayBundle will have a particular bundle type, which implements the Bundle trait.

Fields

data: Matrix<R, NPTS, U3, StorageMultiple>

The matrix storing the ray data.

Implementations

source

impl<Coords, BType, R, NPTS, StorageMultiple> RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 Coords: CoordinateSystem,
 BType: Bundle<R>,
 R: RealField,
 NPTS: DimName,
 StorageMultiple: Storage<R, NPTS, U3>,
 DefaultAllocator: Allocator<R, NPTS, U3>,

source

pub fn directions(&self) -> Matrix<R, NPTS, U3, Owned<R, NPTS, U3>>

get directions of each ray in bundle

source

pub fn centers(&self) -> Matrix<R, NPTS, U3, Owned<R, NPTS, U3>>

get centers (origins) of each ray in bundle

source

impl<Coords, BType, R> RayBundle<Coords, BType, R, U1, Owned<R, U1, U3>> where
 Coords: CoordinateSystem,
 BType: Bundle<R>,
 R: RealField,

source

pub fn to_single_ray(&self) -> Ray<Coords, R>

Return the single ray from the RayBundle with exactly one ray.

source

impl<Coords, R, NPTS, StorageMultiple> RayBundle<Coords, SharedOriginRayBundle<R>, R, NPTS, StorageMultiple> where
 Coords: CoordinateSystem,
 R: RealField,
 NPTS: Dim,
 StorageMultiple: Storage<R, NPTS, U3>,

source

pub fn new_shared_zero_origin(
data: Matrix<R, NPTS, U3, StorageMultiple>
) -> Self

Create a new RayBundle instance in which all rays share origin at zero.

The number of points allocated is given by the npts parameter, which should agree with the NPTS type. The coordinate system is given by the Coords type.

source

impl<Coords, R, NPTS, StorageMultiple> RayBundle<Coords, SharedDirectionRayBundle<R>, R, NPTS, StorageMultiple> where
 Coords: CoordinateSystem,
 R: RealField,
 NPTS: Dim,
 StorageMultiple: Storage<R, NPTS, U3>,

source

pub fn new_shared_plusz_direction(
data: Matrix<R, NPTS, U3, StorageMultiple>
) -> Self

Create a new RayBundle instance in which all rays share +z direction.

The number of points allocated is given by the npts parameter, which should agree with the NPTS type. The coordinate system is given by the Coords type.

source

impl<Coords, BType, R, NPTS, StorageMultiple> RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 Coords: CoordinateSystem,
 BType: Bundle<R>,
 R: RealField,
 NPTS: Dim,
 StorageMultiple: Storage<R, NPTS, U3>,

source

pub fn point_on_ray(&self) -> Points<Coords, R, NPTS, Owned<R, NPTS, U3>> where
DefaultAllocator: Allocator<R, NPTS, U3>,

get a 3D point on the ray, obtained by adding the direction(s) to the origin(s)

The distance of the point from the ray bundle center is not definted and can be arbitrary.

source

pub fn point_on_ray_at_distance(
 &self,
 distance: R
) -> Points<Coords, R, NPTS, Owned<R, NPTS, U3>> where
 DefaultAllocator: Allocator<R, NPTS, U3>,

get a 3D point on the ray at a defined distance from the origin(s)

Trait Implementations

source

impl<Coords: Clone, BType: Clone, R: Clone, NPTS: Clone, StorageMultiple: Clone> Clone for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 Coords: CoordinateSystem,
 BType: Bundle<R>,
 R: RealField,
 NPTS: Dim,
 StorageMultiple: Storage<R, NPTS, U3>,

source

fn clone(&self) -> RayBundle<Coords, BType, R, NPTS, StorageMultiple>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<Coords: Debug, BType: Debug, R: Debug, NPTS: Debug, StorageMultiple: Debug> Debug for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 Coords: CoordinateSystem,
 BType: Bundle<R>,
 R: RealField,
 NPTS: Dim,
 StorageMultiple: Storage<R, NPTS, U3>,

source

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

Formats the value using the given formatter. Read more

source

impl<'de, Coords, BType, R, NPTS, StorageMultiple> Deserialize<'de> for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 Coords: CoordinateSystem,
 BType: Bundle<R>,
 R: RealField,
 NPTS: Dim,
 StorageMultiple: Storage<R, NPTS, U3>,
 BType: Deserialize<'de>,
 R: Deserialize<'de>,
 NPTS: Deserialize<'de>,
 StorageMultiple: Deserialize<'de>,

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl<Coords: PartialEq, BType: PartialEq, R: PartialEq, NPTS: PartialEq, StorageMultiple: PartialEq> PartialEq<RayBundle<Coords, BType, R, NPTS, StorageMultiple>> for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 Coords: CoordinateSystem,
 BType: Bundle<R>,
 R: RealField,
 NPTS: Dim,
 StorageMultiple: Storage<R, NPTS, U3>,

source

fn eq(&self, other: &RayBundle<Coords, BType, R, NPTS, StorageMultiple>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &RayBundle<Coords, BType, R, NPTS, StorageMultiple>) -> bool

This method tests for !=.

source

impl<Coords, BType, R, NPTS, StorageMultiple> Serialize for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 Coords: CoordinateSystem,
 BType: Bundle<R>,
 R: RealField,
 NPTS: Dim,
 StorageMultiple: Storage<R, NPTS, U3>,
 BType: Serialize,
 R: Serialize,
 NPTS: Serialize,
 StorageMultiple: Serialize,

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl<Coords, BType, R, NPTS, StorageMultiple> StructuralPartialEq for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 Coords: CoordinateSystem,
 BType: Bundle<R>,
 R: RealField,
 NPTS: Dim,
 StorageMultiple: Storage<R, NPTS, U3>,

Auto Trait Implementations

impl<Coords, BType, R, NPTS, StorageMultiple> RefUnwindSafe for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 BType: RefUnwindSafe,
 Coords: RefUnwindSafe,
 NPTS: RefUnwindSafe,
 R: RefUnwindSafe,
 StorageMultiple: RefUnwindSafe,

impl<Coords, BType, R, NPTS, StorageMultiple> Send for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 BType: Send,
 Coords: Send,
 StorageMultiple: Send,

impl<Coords, BType, R, NPTS, StorageMultiple> Sync for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 BType: Sync,
 Coords: Sync,
 StorageMultiple: Sync,

impl<Coords, BType, R, NPTS, StorageMultiple> Unpin for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 BType: Unpin,
 Coords: Unpin,
 NPTS: Unpin,
 R: Unpin,
 StorageMultiple: Unpin,

impl<Coords, BType, R, NPTS, StorageMultiple> UnwindSafe for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
 BType: UnwindSafe,
 Coords: UnwindSafe,
 NPTS: UnwindSafe,
 R: UnwindSafe,
 StorageMultiple: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

source

Struct cam_geom::RayBundle

Fields

Implementations

impl<Coords, BType, R, NPTS, StorageMultiple> RayBundle<Coords, BType, R, NPTS, StorageMultiple> where Coords: CoordinateSystem, BType: Bundle<R>, R: RealField, NPTS: DimName, StorageMultiple: Storage<R, NPTS, U3>, DefaultAllocator: Allocator<R, NPTS, U3>,

pub fn directions(&self) -> Matrix<R, NPTS, U3, Owned<R, NPTS, U3>>

pub fn centers(&self) -> Matrix<R, NPTS, U3, Owned<R, NPTS, U3>>

impl<Coords, BType, R> RayBundle<Coords, BType, R, U1, Owned<R, U1, U3>> where Coords: CoordinateSystem, BType: Bundle<R>, R: RealField,

pub fn to_single_ray(&self) -> Ray<Coords, R>

impl<Coords, R, NPTS, StorageMultiple> RayBundle<Coords, SharedOriginRayBundle<R>, R, NPTS, StorageMultiple> where Coords: CoordinateSystem, R: RealField, NPTS: Dim, StorageMultiple: Storage<R, NPTS, U3>,

pub fn new_shared_zero_origin( data: Matrix<R, NPTS, U3, StorageMultiple>) -> Self

impl<Coords, R, NPTS, StorageMultiple> RayBundle<Coords, SharedDirectionRayBundle<R>, R, NPTS, StorageMultiple> where Coords: CoordinateSystem, R: RealField, NPTS: Dim, StorageMultiple: Storage<R, NPTS, U3>,

pub fn new_shared_plusz_direction( data: Matrix<R, NPTS, U3, StorageMultiple>) -> Self

impl<Coords, BType, R, NPTS, StorageMultiple> RayBundle<Coords, BType, R, NPTS, StorageMultiple> where Coords: CoordinateSystem, BType: Bundle<R>, R: RealField, NPTS: Dim, StorageMultiple: Storage<R, NPTS, U3>,

pub fn point_on_ray(&self) -> Points<Coords, R, NPTS, Owned<R, NPTS, U3>> where DefaultAllocator: Allocator<R, NPTS, U3>,

pub fn point_on_ray_at_distance( &self, distance: R) -> Points<Coords, R, NPTS, Owned<R, NPTS, U3>> where DefaultAllocator: Allocator<R, NPTS, U3>,

Trait Implementations

impl<Coords: Clone, BType: Clone, R: Clone, NPTS: Clone, StorageMultiple: Clone> Clone for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where Coords: CoordinateSystem, BType: Bundle<R>, R: RealField, NPTS: Dim, StorageMultiple: Storage<R, NPTS, U3>,

fn clone(&self) -> RayBundle<Coords, BType, R, NPTS, StorageMultiple>

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

impl<Coords: Debug, BType: Debug, R: Debug, NPTS: Debug, StorageMultiple: Debug> Debug for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where Coords: CoordinateSystem, BType: Bundle<R>, R: RealField, NPTS: Dim, StorageMultiple: Storage<R, NPTS, U3>,

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

fn eq(&self, other: &RayBundle<Coords, BType, R, NPTS, StorageMultiple>) -> bool

fn ne(&self, other: &RayBundle<Coords, BType, R, NPTS, StorageMultiple>) -> bool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer,

impl<Coords, BType, R, NPTS, StorageMultiple> StructuralPartialEq for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where Coords: CoordinateSystem, BType: Bundle<R>, R: RealField, NPTS: Dim, StorageMultiple: Storage<R, NPTS, U3>,

Auto Trait Implementations

impl<Coords, BType, R, NPTS, StorageMultiple> RefUnwindSafe for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where BType: RefUnwindSafe, Coords: RefUnwindSafe, NPTS: RefUnwindSafe, R: RefUnwindSafe, StorageMultiple: RefUnwindSafe,

impl<Coords, BType, R, NPTS, StorageMultiple> Send for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where BType: Send, Coords: Send, StorageMultiple: Send,

impl<Coords, BType, R, NPTS, StorageMultiple> Sync for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where BType: Sync, Coords: Sync, StorageMultiple: Sync,

impl<Coords, BType, R, NPTS, StorageMultiple> Unpin for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where BType: Unpin, Coords: Unpin, NPTS: Unpin, R: Unpin, StorageMultiple: Unpin,

impl<Coords, BType, R, NPTS, StorageMultiple> UnwindSafe for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where BType: UnwindSafe, Coords: UnwindSafe, NPTS: UnwindSafe, R: UnwindSafe, StorageMultiple: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

impl<T> Scalar for T where T: 'static + Clone + PartialEq<T> + Debug,

impl<Coords, BType, R, NPTS, StorageMultiple> RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
Coords: CoordinateSystem,
BType: Bundle<R>,
R: RealField,
NPTS: DimName,
StorageMultiple: Storage<R, NPTS, U3>,
DefaultAllocator: Allocator<R, NPTS, U3>,

impl<Coords, BType, R> RayBundle<Coords, BType, R, U1, Owned<R, U1, U3>> where
Coords: CoordinateSystem,
BType: Bundle<R>,
R: RealField,

impl<Coords, R, NPTS, StorageMultiple> RayBundle<Coords, SharedOriginRayBundle<R>, R, NPTS, StorageMultiple> where
Coords: CoordinateSystem,
R: RealField,
NPTS: Dim,
StorageMultiple: Storage<R, NPTS, U3>,

pub fn new_shared_zero_origin(
data: Matrix<R, NPTS, U3, StorageMultiple>
) -> Self

impl<Coords, R, NPTS, StorageMultiple> RayBundle<Coords, SharedDirectionRayBundle<R>, R, NPTS, StorageMultiple> where
Coords: CoordinateSystem,
R: RealField,
NPTS: Dim,
StorageMultiple: Storage<R, NPTS, U3>,

pub fn new_shared_plusz_direction(
data: Matrix<R, NPTS, U3, StorageMultiple>
) -> Self

impl<Coords, BType, R, NPTS, StorageMultiple> RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
Coords: CoordinateSystem,
BType: Bundle<R>,
R: RealField,
NPTS: Dim,
StorageMultiple: Storage<R, NPTS, U3>,

pub fn point_on_ray(&self) -> Points<Coords, R, NPTS, Owned<R, NPTS, U3>> where
DefaultAllocator: Allocator<R, NPTS, U3>,

pub fn point_on_ray_at_distance(
&self,
distance: R
) -> Points<Coords, R, NPTS, Owned<R, NPTS, U3>> where
DefaultAllocator: Allocator<R, NPTS, U3>,

impl<Coords: Clone, BType: Clone, R: Clone, NPTS: Clone, StorageMultiple: Clone> Clone for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
Coords: CoordinateSystem,
BType: Bundle<R>,
R: RealField,
NPTS: Dim,
StorageMultiple: Storage<R, NPTS, U3>,

impl<Coords: Debug, BType: Debug, R: Debug, NPTS: Debug, StorageMultiple: Debug> Debug for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
Coords: CoordinateSystem,
BType: Bundle<R>,
R: RealField,
NPTS: Dim,
StorageMultiple: Storage<R, NPTS, U3>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

impl<Coords, BType, R, NPTS, StorageMultiple> StructuralPartialEq for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
Coords: CoordinateSystem,
BType: Bundle<R>,
R: RealField,
NPTS: Dim,
StorageMultiple: Storage<R, NPTS, U3>,

impl<Coords, BType, R, NPTS, StorageMultiple> RefUnwindSafe for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
BType: RefUnwindSafe,
Coords: RefUnwindSafe,
NPTS: RefUnwindSafe,
R: RefUnwindSafe,
StorageMultiple: RefUnwindSafe,

impl<Coords, BType, R, NPTS, StorageMultiple> Send for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
BType: Send,
Coords: Send,
StorageMultiple: Send,

impl<Coords, BType, R, NPTS, StorageMultiple> Sync for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
BType: Sync,
Coords: Sync,
StorageMultiple: Sync,

impl<Coords, BType, R, NPTS, StorageMultiple> Unpin for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
BType: Unpin,
Coords: Unpin,
NPTS: Unpin,
R: Unpin,
StorageMultiple: Unpin,

impl<Coords, BType, R, NPTS, StorageMultiple> UnwindSafe for RayBundle<Coords, BType, R, NPTS, StorageMultiple> where
BType: UnwindSafe,
Coords: UnwindSafe,
NPTS: UnwindSafe,
R: UnwindSafe,
StorageMultiple: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

impl<T> Scalar for T where
T: 'static + Clone + PartialEq<T> + Debug,