Struct Bound

pub struct Bound<N>
where
    N: Copy + RealField,
{
    pub transform: Isometry<N, Unit<Quaternion<N>>, 3>,
    pub min_target: OPoint<N, Const<3>>,
    pub max_target: OPoint<N, Const<3>>,
    pub min_eye: OPoint<N, Const<3>>,
    pub max_eye: OPoint<N, Const<3>>,
    pub min_up: OPoint<N, Const<3>>,
    pub max_up: OPoint<N, Const<3>>,
    pub min_distance: N,
    pub max_distance: N,
    pub hysteresis: N,
}

Orthogonal boundary conditions implementing Clamp.

Implements Default and can be created with Bound::default().

Fields

transform: Isometry<N, Unit<Quaternion<N>>, 3>

Isometry in world space of bound inversely transforming target and eye positions.

min_target: OPoint<N, Const<3>>

Minimum components of target position in world space. Default splats N::MIN.

max_target: OPoint<N, Const<3>>

Maximum components of target position in world space. Default splats N::MAX.

min_eye: OPoint<N, Const<3>>

Minimum components of eye position in world space. Default splats N::MIN.

max_eye: OPoint<N, Const<3>>

Maximum components of eye position in world space. Default splats N::MAX.

min_up: OPoint<N, Const<3>>

Minimum components of up axis in world space following yaw. Default splats N::MIN.

max_up: OPoint<N, Const<3>>

Maximum components of up axis in world space following yaw. Default splats N::MAX.

min_distance: N

Minimum distance of eye from target. Default is N::zero().

max_distance: N

Maximum distance of eye from target. Default is N::MAX.

hysteresis: N

Epsilon allowing clamped Delta to more likely pass revalidation.

Default is AbsDiffEq::default_epsilon().sqrt().

Trait Implementations

impl<N> Clamp<N> for Bound<N>

where N: Copy + RealField,

fn loops(&self) -> usize

Using lower loop limit for flat boundary conditions.

fn target(&self, frame: &Frame<N>) -> Option<Plane<N>>

Find any boundary plane exceeded by target position.

fn eye(&self, frame: &Frame<N>) -> Option<Plane<N>>

Find any boundary plane exceeded by eye position.

fn up(&self, frame: &Frame<N>) -> Option<Plane<N>>

Find any boundary plane exceeded by up position.

fn compute( &self, frame: &Frame<N>, scope: &Scope<N>, delta: &Delta<N>, ) -> Option<(Delta<N>, usize)>

Computes clamped Delta wrt abstract boundary conditions of Frame and Scope.

impl<N> Clone for Bound<N>

where N: Clone + Copy + RealField,

fn clone(&self) -> Bound<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Bound<N>

where N: Debug + Copy + RealField,

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

Formats the value using the given formatter.

impl<N> Default for Bound<N>

where N: Copy + RealField,

fn default() -> Bound<N>

Returns the “default value” for a type.

impl<'de, N> Deserialize<'de> for Bound<N>

where N: Copy + RealField + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Bound<N>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<N> PartialEq for Bound<N>

where N: PartialEq + Copy + RealField,

fn eq(&self, other: &Bound<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N> Serialize for Bound<N>

where N: Copy + RealField + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<N> Copy for Bound<N>

where N: Copy + RealField,

impl<N> Eq for Bound<N>

where N: Eq + Copy + RealField,

impl<N> StructuralPartialEq for Bound<N>

where N: Copy + RealField,