Class WallOpening

Namespace

S1MAPI.Building.Structural

Assembly

S1MAPI_Mono.dll

Configuration for a wall opening (door or window).

public sealed class WallOpening

Inheritance

object

WallOpening

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

WallOpening()

public WallOpening()

Properties

BottomOffset

The bottom offset (sill height) in meters. Used for windows.

public float BottomOffset { get; set; }

Property Value

float

Count

Number of window panes across the opening (default 1).

public int Count { get; set; }

Property Value

int

DividerWidth

Width of the wall divider between adjacent panes in meters.

public float DividerWidth { get; set; }

Property Value

float

FrameColor

Optional frame color override for window openings. Defaults to dark gray when null.

public Color? FrameColor { get; set; }

Property Value

Color?

FrameMaterial

Optional frame material override for window openings.

public Material? FrameMaterial { get; set; }

Property Value

Material

GlassMaterial

Optional glass material override. When null, uses Materials.WindowGlass.

public Material? GlassMaterial { get; set; }

Property Value

Material

Height

The height of the opening in meters.

public float Height { get; set; }

Property Value

float

LeftWindow

Optional window for the left side segment of a door wall.

public WallOpening? LeftWindow { get; set; }

Property Value

WallOpening

Offset

Lateral offset from center along the wall in meters. Positive shifts toward the right/forward end, negative toward left/back.

public float Offset { get; set; }

Property Value

float

RightWindow

Optional window for the right side segment of a door wall.

public WallOpening? RightWindow { get; set; }

Property Value

WallOpening

Type

The type of opening (door, window, or none).

public WallOpeningType Type { get; set; }

Property Value

WallOpeningType

Width

The width of the opening in meters.

public float Width { get; set; }

Property Value

float

Methods

Door(float, float, float)

Creates a door opening configuration.

public static WallOpening Door(float width = 2, float height = 2.2, float offset = 0)

Parameters

width float

The door width in meters (default 2.0).

height float

The door height in meters (default 2.2).

offset float

Lateral offset from center along the wall in meters (default 0, centered).

Returns

WallOpening

A new WallOpening configured as a door.

DoorWithWindows(float, float, WallOpening?, WallOpening?)

Creates a door opening with windows on the left and/or right side segments.

public static WallOpening DoorWithWindows(float doorWidth = 2, float doorHeight = 2.2, WallOpening? leftWindow = null, WallOpening? rightWindow = null)

Parameters

doorWidth float

The door width in meters (default 2.0).

doorHeight float

The door height in meters (default 2.2).

leftWindow WallOpening

Window config for left side, or null for no window.

rightWindow WallOpening

Window config for right side, or null for no window.

Returns

WallOpening

A new WallOpening configured as a door with side windows.

Window(float, float, float, int, float, Material?, float, Material?, Color?)

Creates a window opening configuration.

public static WallOpening Window(float width = 2.5, float height = 2, float sillHeight = 0.8, int count = 1, float dividerWidth = 0.15, Material? glassMaterial = null, float offset = 0, Material? frameMaterial = null, Color? frameColor = null)

Parameters

width float

The window width in meters (default 2.5).

height float

The window height in meters (default 2.0).

sillHeight float

The sill height from the floor in meters (default 0.8).

count int

Number of window panes to distribute across the opening width (default 1).

dividerWidth float

Width of wall dividers between adjacent panes in meters (default 0.15).

glassMaterial Material

Optional glass material override. Defaults to Materials.WindowGlass when null.

offset float

Lateral offset from center along the wall in meters (default 0, centered).

frameMaterial Material

Optional frame material override.

frameColor Color?

Optional frame color override. Defaults to dark gray when null.

Returns

WallOpening

A new WallOpening configured as a window.