Struct ReticleDescription 

pub struct ReticleDescription {
    pub name: String,
    pub focal_plane: FocalPlane,
    pub reference_magnification: f64,
    pub marks: Vec<ReticleMark>,
}

A complete reticle: its focal plane, its calibration magnification, and its marks.

This is THE shared schema. It is deliberately permissive on unknown JSON keys (no deny_unknown_fields) so a richer front-end description round-trips through the engine without being rejected, and every field a solve needs is required.

Fields

name: String

Display name, e.g. "mil-grid 0.5/10" or a vendor model designation.

focal_plane: FocalPlane

reference_magnification: f64

The magnification at which ReticleMark subtensions are true. Meaningful only for FocalPlane::Second; ignored (and unvalidated) for FFP, where subtensions are magnification-independent by construction.

marks: Vec<ReticleMark>

Implementations

impl ReticleDescription

pub fn validate(&self) -> Result<(), ReticleError>

Validate the description on its own terms: mark count, finiteness, and (SFP only) the reference magnification.

pub fn mark_scale(&self, magnification: f64) -> f64

The factor that converts NOMINAL mark subtensions to TRUE subtensions at magnification: reference_magnification / magnification for SFP, exactly 1.0 for FFP.

Assumes Self::validate has passed and magnification is finite and positive.

pub fn scaled_marks( &self, magnification: f64, ) -> Result<Vec<ScaledMark>, ReticleError>

Every mark’s TRUE angular position at magnification.

pub fn mil_grid(spacing_mil: f64, extent_mil: f64) -> Result<Self, ReticleError>

A plain mil-hash CROSS: marks every spacing_mil along the vertical and horizontal stadia out to extent_mil, plus a MarkKind::Center at the origin.

This is NOT a filled two-dimensional grid — see the module header’s IP exclusions. The result is FFP with a reference_magnification of 1.0 (unused for FFP); callers wanting an SFP grid set those two fields afterwards.

pub fn tree( rows: usize, row_spacing_mil: f64, spread_step_mil: f64, ) -> Result<Self, ReticleError>

A generic parametric holdover tree: rows rows below center at row_spacing_mil intervals, each row n carrying windage dots at ±k * spread_step_mil for k in 1..=n, so the tree widens with depth. Plus a MarkKind::Center.

Generic geometry only — no vendor tree layout is reproduced here (module header).

pub fn bdc_from_drops(drops: &[(f64, f64)]) -> Result<Self, ReticleError>

A BDC ladder built from ALREADY-SOLVED drops: one labeled hash per (range_m, drop_mil) pair on the vertical stadium, plus a MarkKind::Center.

This generator deliberately does NOT run a solve. It is pure data assembly, so the caller stays in control of which load, atmosphere and zero the ladder describes, and this module keeps its “no physics” property.

Trait Implementations

impl Clone for ReticleDescription

fn clone(&self) -> ReticleDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReticleDescription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReticleDescription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReticleDescription

fn eq(&self, other: &ReticleDescription) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReticleDescription

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReticleDescription