Struct nyx_space::md::targeter::Objective [−][src]
pub struct Objective {
pub parameter: StateParameter,
pub desired_value: f64,
pub tolerance: f64,
pub multiplicative_factor: f64,
pub additive_factor: f64,
}Expand description
Defines a state parameter event finder
Fields
parameter: StateParameterThe state parameter to target
desired_value: f64The desired self.desired_value, must be in the same units as the state parameter
tolerance: f64The precision on the desired value
multiplicative_factor: f64A multiplicative factor this parameter’s error in the targeting (defaults to 1.0)
additive_factor: f64An additive factor to this parameters’s error in the targeting (defaults to 0.0)
Implementations
Match a specific value for the parameter. By default, the tolerance on the parameter is 0.1 times whatever unit is the default for that parameter. For example, a radius event will seek the requested value at the decimeter level, and an angle event will seek it at the tenth of a degree.
pub fn within_tolerance(
parameter: StateParameter,
desired_value: f64,
tolerance: f64
) -> Self[src]
pub fn within_tolerance(
parameter: StateParameter,
desired_value: f64,
tolerance: f64
) -> Self[src]Match a specific value for the parameter to hit the specified value with the provided tolerance on the value
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Objectiveimpl UnwindSafe for ObjectiveBlanket Implementations
Mutably borrows from an owned value. Read more
type Output = T
type Output = TShould always be Self
The inverse inclusion map: attempts to construct self from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> boolChecks if self is actually part of its subset T (and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SSUse with care! Same as self.to_subset but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SPThe inclusion map: converts self to the equivalent element of its superset.
pub fn vzip(self) -> V