Struct RoofConfig 

pub struct RoofConfig {
    pub roof_type: RoofType,
    pub pitch: f64,
    pub secondary_pitch: Option<f64>,
    pub overhang: f64,
    pub ridge_offset: f64,
    pub fascia_depth: f64,
    pub tier_height: Option<f64>,
}

Rich parametric configuration for the Roof operation.

All angular values are in degrees. Lengths are in world units. Optional fields default as described; see each field doc.

Fields

roof_type: RoofType

pitch: f64

Primary pitch angle in degrees from horizontal. Must be in (0°, 90°).

secondary_pitch: Option<f64>

Secondary pitch angle in degrees. Used by Gambrel (upper zone) and Mansard. If None when required, defaults to pitch / 2.

overhang: f64

Extra overhang beyond the scope footprint on each side. Default 0.0.

ridge_offset: f64

Ridge offset for Saltbox: fraction [0, 1] of the scope depth (Z) where the ridge is positioned from the front. Default 0.5 (symmetric / centred ridge).

fascia_depth: f64

Thickness of the roof fascia edge in world units. Default 0.0 (flat panels).

tier_height: Option<f64>

Normalised height at which the pitch break occurs for Gambrel, Mansard, Jerkinhead, and DutchGable. 0.5 means the break is at half the eave-to-ridge distance. None uses a type-specific default.

Implementations

impl RoofConfig

pub fn new(roof_type: RoofType, pitch: f64) -> Self

Creates a minimal config for deterministic types (Pyramid, Shed, Gable, Hip, Flat, …).

pub fn secondary_pitch_or_default(&self) -> f64

Returns the secondary pitch, defaulting to pitch / 2 if unset.

pub fn tier_height_or(&self, default: f64) -> f64

Returns the tier height, defaulting to default if unset.

Trait Implementations

impl Clone for RoofConfig

fn clone(&self) -> RoofConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoofConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoofConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RoofConfig

fn eq(&self, other: &RoofConfig) -> 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 Serialize for RoofConfig

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 RoofConfig