This toolkit is also available as a nuget package: https://www.nuget.org/packages/RoomKit
- class CoordGrid
Maintains a list of available and allocated points in a grid of the specified interval within the orthogonal bounding box of a Polygon.
- class Messages
Common exception messages.
- class Place
Rooms 2D Polygons in various spatial relationships to each other.
- class Room
A data structure recording room characteristics.
- class RoomGroup
Creates and manages Rooms within a perimeter.
- class RoomRow
Creates and manages Rooms placed along a line.
- class Scope
Data structure recording space program characteristics and the status of a Room placing process.
- class Story
Creates and manages the geometry of a slab and Rooms representing corridors, occupied rooms, and services.
- class Tower
- enum Corner { NE , SE , SW , NW }
A list of box corners as compass designations. NE = maximum X and Y corner. SE = maximum X and minimum Y corner. SW = minimum X and Y corner. NW = minimum X and maximum Y corner.
A list of box corners as compass designations. NE = maximum X and Y corner. SE = maximum X and minimum Y corner. SW = minimum X and Y corner. NW = minimum X and maximum Y corner.
Maintains a list of available and allocated points in a grid of the specified interval within the orthogonal bounding box of a Polygon.
- CoordGrid (Polygon polygon, double xInterval=1, double yInterval=1, int randomSeed=1)
Creates an orthogonal 2D grid of Vector3 points from the supplied Polygon and axis intervals.
- void Allocate (Polygon polygon)
Allocates the points in the grid falling within or on the supplied Polygon.
- void Allocate (IList< Polygon > polygons)
Allocates points in the grid falling within the supplied Polygons.
- Vector3 AllocatedNearTo (Vector3 point)
Returns the allocated grid point nearest to the supplied point.
- Vector3 AllocatedRandom ()
Returns a random allocated point.
- Vector3 AvailableMax ()
Returns the maximum available grid point.
- Vector3 AvailableMin ()
Returns the minimum available grid point.
- Vector3 AvailableNearTo (Vector3 point)
Returns the available grid point nearest to the supplied Vector3 point.
- Vector3 AvailableRandom ()
Returns a random available grid point.
- List< Vector3 > Allocated [get]
The list of vector3 allocated points.
- List< Vector3 > Available [get]
The list of Vector3 points available for allocation.
- Polygon Perimeter [get, set]
Maintains a list of available and allocated points in a grid of the specified interval within the orthogonal bounding box of a Polygon.
RoomKit.CoordGrid.CoordGrid (Polygon polygon, double xInterval = 1, double yInterval = 1, int randomSeed = 1)
Creates an orthogonal 2D grid of Vector3 points from the supplied Polygon and axis intervals.
| perimeter | The Polygon boundary of the point grid. |
|---|---|
| xInterval | The spacing of the grid along the x-axis. |
| yInterval | The spacing of the grid along the y-axis. |
A new CoordGrid.
Allocates the points in the grid falling within or on the supplied Polygon.
| polygon | The Polygon bounding the points to be allocated. |
|---|
None.
Allocates points in the grid falling within the supplied Polygons.
| polygon | The Polygon bounding the points to be allocated. |
|---|
None.
Returns the allocated grid point nearest to the supplied point.
| point | The Vector3 point to compare. |
|---|
A Vector3 point.
Returns a random allocated point.
A Vector3 point.
Returns the maximum available grid point.
A Vector3 point.
Returns the minimum available grid point.
A Vector3 point.
Returns the available grid point nearest to the supplied Vector3 point.
| point | The Vector3 point to compare. |
|---|
A Vector3 point.
Returns a random available grid point.
A Vector3 point.
The list of vector3 allocated points.
The list of Vector3 points available for allocation.
- RoomKit/CoordGrid.cs
A data structure recording room characteristics.
- Room ()
Constructor setting all internal variables to default values to create a 1.0 x 1.0 x 1.0 white cube with no required adjacencies placed on the zero plane with an empty string, null perimeter, and an integer TypeID of -1.
- Polygon MoveFromTo (Vector3 from, Vector3 to)
Moves the Room along a 3D vector calculated between the supplied Vector3 points.
- bool Rotate (Vector3 pivot, double angle)
Rotates the Room Perimeter in the horizontal plane around the supplied pivot point.
- bool SetDimensions (Vector3 xyz, Vector3 moveTo=null)
Creates and sets a rectangular Room Perimeter, Height, and southwest corner location with a supplied vectors. Sets the DesignX and DesignY properties.
- bool SetPerimeter (Vector3 moveTo=null)
Creates and sets a rectangular Room Perimeter with dimensions derived from Room characteristics with its southwest corner at the origin or at the 2D location implied by the supplied Vector3.
- bool SetPerimeter (double area, double ratio=1.5, Vector3 moveTo=null)
Creates and sets a rectangular Room Perimeter with dimensions derived from Room characteristics with its southwest corner at the supplied Vector3 point. If no point is supplied, the southwest corner is placed at the origin.
- bool SetPerimeter (Line axis, double width)
Creates and sets a rectangular Room perimeter with dimensions derived from a supplied Line and a width. Intended for creating corridors.
- bool SetPerimeter (Vector3 start, Vector3 end, double width)
Creates and sets a rectangular Room perimeter with dimensions derived from two points and a width. Intended for creating corridors.
- int [] AdjacentTo [get, set]
A list of Resource ID integers indicating the desired adjacencies of this Room type to other Room types.
- double Area [get]
The area of the room's perimeter Polygon. Returns -1.0 if the Room's Perimeter is null.
- double AreaVariance [get]
The ratio between the intended area and the actual area of the Room. Returns a negative value if the Room has no Perimeter value.
- Space AsSpace [get]
A Space created from Room characteristics. Adds properties to the Space recording Name TypeID as Type DesignArea as Design Area DesignX as Design Length DesignY as Design Width Perimeter.Area as Area Elevation Height
- Color Color [get, set]
- double DesignArea [get, set]
- double DesignLength [get, set]
Desired x-axis dimension of this Room.
- double DesignWidth [get, set]
Desired y-axis dimension of this Room.
- double DesignRatio [get, set]
- bool DesignSet [get]
Returns true if both DesignLength and DesignWidth are positive values.
- Vector3 DesignXYZ [get, set]
- double Elevation [get, set]
The vertical position of the Room's lowest plane, parallel to the ground plane.
- double Height [get, set]
Height of the Room prism. Set ignores non-positive values.
- string Name [get, set]
Arbitrary string identifier for this Room instance.
- Polygon Perimeter [get, set]
- bool Placed [get, set]
Manual flag to record if the Room has been placed in its final position.
- double SizeX [get]
X dimensions of the Room Perimeter orthogonal bounding box.
- double SizeY [get]
X dimensions of the Room Perimeter orthogonal bounding box.
- int TypeID [get, set]
Arbitrary integer identifier of this instance..
- string UniqueID [get]
UUID for this instance, set on initialization.
A data structure recording room characteristics.
Constructor setting all internal variables to default values to create a 1.0 x 1.0 x 1.0 white cube with no required adjacencies placed on the zero plane with an empty string, null perimeter, and an integer TypeID of -1.
Moves the Room along a 3D vector calculated between the supplied Vector3 points.
| from | Vector3 base point of the move. |
|---|---|
| to | Vector3 target point of the move. |
A Polygon represeting the Room's new Perimeter.
Rotates the Room Perimeter in the horizontal plane around the supplied pivot point.
| pivot | Vector3 point around which the Room Perimeter will be rotated. |
|---|---|
| angle | Angle in degrees to rotate the Perimeter. |
True if the Perimeter is successfully rotated.
Creates and sets a rectangular Room Perimeter, Height, and southwest corner location with a supplied vectors. Sets the DesignX and DesignY properties.
| xyz | Vector3 dimensions of a new Polygon Perimeter. If xy.Z is > 0.0, sets the height of the Room. |
|---|---|
| moveTo | Vector3 location of the new Polygon's southwest corner. |
True if the Perimeter is successfully set.
Creates and sets a rectangular Room Perimeter with dimensions derived from Room characteristics with its southwest corner at the origin or at the 2D location implied by the supplied Vector3.
True if the Perimeter is successfully set.
Creates and sets a rectangular Room Perimeter with dimensions derived from Room characteristics with its southwest corner at the supplied Vector3 point. If no point is supplied, the southwest corner is placed at the origin.
| area | Area override for the new Room Perimeter. If zero, defaults to the value of DesignArea. |
|---|---|
| ratio | Desired ratio of X to Y Room dimensions. |
| moveTo | Vector3 location of the new Polygon's southwest corner. |
True if the Perimeter is successfully set.
Creates and sets a rectangular Room perimeter with dimensions derived from a supplied Line and a width. Intended for creating corridors.
| axis | The Line defining the centerline of the perimeter. |
|---|---|
| width | The width of the perimeter along the axis Line. |
True if the Perimeter is successfully set.
Creates and sets a rectangular Room perimeter with dimensions derived from two points and a width. Intended for creating corridors.
| start | The start point of an axis defining centerline of the perimeter. |
|---|---|
| end | The end point of an axis defining centerline of the perimeter. |
| width | The width of the perimeter along the axis Line. |
True if the Perimeter is successfully set.
A list of Resource ID integers indicating the desired adjacencies of this Room type to other Room types.
The area of the room's perimeter Polygon. Returns -1.0 if the Room's Perimeter is null.
The ratio between the intended area and the actual area of the Room. Returns a negative value if the Room has no Perimeter value.
A Space created from Room characteristics. Adds properties to the Space recording Name TypeID as Type DesignArea as Design Area DesignX as Design Length DesignY as Design Width Perimeter.Area as Area Elevation Height
Desired x-axis dimension of this Room.
Returns true if both DesignLength and DesignWidth are positive values.
Desired y-axis dimension of this Room.
The vertical position of the Room's lowest plane, parallel to the ground plane.
Height of the Room prism. Set ignores non-positive values.
Arbitrary string identifier for this Room instance.
Manual flag to record if the Room has been placed in its final position.
X dimensions of the Room Perimeter orthogonal bounding box.
X dimensions of the Room Perimeter orthogonal bounding box.
Arbitrary integer identifier of this instance..
UUID for this instance, set on initialization.
- RoomKit/Room.cs
Creates and manages Rooms within a perimeter.
- RoomGroup ()
Creates an empty group of Rooms.
- void MoveFromTo (Vector3 from, Vector3 to)
Moves all Rooms in the RoomGroup and the RoomGroup Perimeter along a 3D vector calculated between the supplied Vector3 points.
- void Rotate (Vector3 pivot, double angle)
Rotates the RoomGroup Perimeter and Rooms in the horizontal plane around the supplied pivot point.
- void SetColor (Color color)
Uniformly sets the color of all Rooms in the RoomGroup.
- void SetHeight (double height)
Uniformly sets the height of all Rooms in the RoomGroup.
- bool RoomsByDivision (int xRooms=1, int yRooms=1, double height=3.0, string name="")
Clears the current Rooms list and creates new Rooms defined by orthogonal x- and y-axis divisions of the RoomGroup Perimeter.
- double AreaAvailable [get]
Unallocated area of the RoomGroup perimeter.
- double AreaPlaced [get]
Area allocated within the RoomGroup.
- double Elevation [get, set]
- string Name [get, set]
Arbitrary string identifier for this RoomGroup.
- Polygon Perimeter [get, set]
- List< Room > Rooms [get]
List of Rooms placed within the Perimeter.
- List< Polygon > RoomsAsPolygons [get]
List of all Room perimeters as Polygons.
- List< Space > RoomsAsSpaces [get]
List of all Rooms as Spaces.
- double SizeX [get]
X dimension of the Perimeter orthogonal bounding box.
- double SizeY [get]
Y dimension of the Perimeter orthogonal bounding box.
- int TypeID [get, set]
Arbitrary integer identifier of this instance..
- string UniqueID [get]
UUID for this RoomGroup instance, set on initialization.
Creates and manages Rooms within a perimeter.
Creates an empty group of Rooms.
A new RoomGroup.
Moves all Rooms in the RoomGroup and the RoomGroup Perimeter along a 3D vector calculated between the supplied Vector3 points.
| from | Vector3 base point of the move. |
|---|---|
| to | Vector3 target point of the move. |
None.
bool RoomKit.RoomGroup.RoomsByDivision (int xRooms = 1, int yRooms = 1, double height = 3.0, string name = "")
Clears the current Rooms list and creates new Rooms defined by orthogonal x- and y-axis divisions of the RoomGroup Perimeter.
| xRooms | The quantity of Rooms along orthogonal x-axis. Must be positive. |
|---|---|
| yRooms | The quantity of Rooms along orthogonal y-axis. Must be positive. |
True if the Rooms are created.
Rotates the RoomGroup Perimeter and Rooms in the horizontal plane around the supplied pivot point.
| pivot | Vector3 point around which the Room Perimeter will be rotated. |
|---|---|
| angle | Angle in degrees to rotate the Perimeter. |
None.
Uniformly sets the color of all Rooms in the RoomGroup.
| color | The new color of the Rooms. |
|---|
None.
Uniformly sets the height of all Rooms in the RoomGroup.
| elevation | The new height of the Rooms. |
|---|
None.
Unallocated area of the RoomGroup perimeter.
Area allocated within the RoomGroup.
Arbitrary string identifier for this RoomGroup.
List of Rooms placed within the Perimeter.
List of all Room perimeters as Polygons.
List of all Rooms as Spaces.
X dimension of the Perimeter orthogonal bounding box.
Y dimension of the Perimeter orthogonal bounding box.
Arbitrary integer identifier of this instance..
UUID for this RoomGroup instance, set on initialization.
- RoomKit/RoomGroup.cs
Creates and manages Rooms placed along a line.
- RoomRow (Line row)
Constructor initializes the RoomRow with a new Line.
- RoomRow (Vector3 start, Vector3 end)
Constructor initializes the RoomRow with line endpoints.
- bool AddRoom (Room room, Polygon within=null, IList< Polygon > among=null)
Attempts to place a Room perimeter on the next open segment of the Row, with optional restrictions of a perimeter within which the Room's perimeter must fit and a list of Polygons with which it cannot intersect.
- void MoveFromTo (Vector3 from, Vector3 to)
Moves all Rooms in the RoomRow and the RoomRow Row along a 3D vector calculated between the supplied Vector3 points.
- void Rotate (Vector3 pivot, double angle)
Rotates the RoomRow Row and Rooms in the horizontal plane around the supplied pivot point.
- void SetColor (Color color)
Uniformly sets the color of all Rooms in the RoomRow.
- void SetHeight (double height)
Uniformly sets the height of all Rooms in the RoomRow.
- double AreaPlaced [get]
Aggregate area of the Rooms placed on this Row.
- double AvailableLength [get]
Unallocated length of the RoomRow.
- Polygon Circulation [get]
Circulation envelope around the row.
- double CirculationWidth [get, set]
- double Depth = 0.0 [get]
Depth of the deepest room along the Row.
- double Elevation [get, set]
- string Name [get, set]
Arbitrary string identifier for this RoomRow.
- IList< Room > Rooms [get]
List of Rooms placed along the Row.
- List< Polygon > RoomsAsPolygons [get]
List of all Room perimeters as Polygons.
- List< Space > RoomsAsSpaces [get]
List of all Rooms as Spaces.
- Line Row [get]
Line along which Rooms can be placed.
- double SizeX [get]
X dimension of the Circulation orthogonal bounding box.
- double SizeY [get]
Y dimension of the Circulation orthogonal bounding box.
- int TypeID [get, set]
Arbitrary integer identifier of this instance..
- string UniqueID [get]
UUID for this RoomRow instance, set on initialization.
Creates and manages Rooms placed along a line.
Constructor initializes the RoomRow with a new Line.
Constructor initializes the RoomRow with line endpoints.
bool RoomKit.RoomRow.AddRoom (Room room, Polygon within = null, IList< Polygon > among = null)
Attempts to place a Room perimeter on the next open segment of the Row, with optional restrictions of a perimeter within which the Room's perimeter must fit and a list of Polygons with which it cannot intersect.
| room | Room from which to derive the Polygon to place. |
|---|---|
| within | Polygon perimeter within which a new Room must fit. |
| among | List of Polygon perimeters the new Room cannot intersect. |
True if the room was successfully placed.
Moves all Rooms in the RoomRow and the RoomRow Row along a 3D vector calculated between the supplied Vector3 points.
| from | Vector3 base point of the move. |
|---|---|
| to | Vector3 target point of the move. |
None.
Rotates the RoomRow Row and Rooms in the horizontal plane around the supplied pivot point.
| pivot | Vector3 point around which the Room Perimeter will be rotated. |
|---|---|
| angle | Angle in degrees to rotate the Perimeter. |
None.
Uniformly sets the color of all Rooms in the RoomRow.
| color | New color of the Rooms. |
|---|
None.
Uniformly sets the height of all Rooms in the RoomRow.
| elevation | New height of the Rooms. |
|---|
None.
Aggregate area of the Rooms placed on this Row.
Unallocated length of the RoomRow.
Circulation envelope around the row.
Depth of the deepest room along the Row.
Arbitrary string identifier for this RoomRow.
List of Rooms placed along the Row.
List of all Room perimeters as Polygons.
List of all Rooms as Spaces.
Line along which Rooms can be placed.
X dimension of the Circulation orthogonal bounding box.
Y dimension of the Circulation orthogonal bounding box.
Arbitrary integer identifier of this instance..
UUID for this RoomRow instance, set on initialization.
- RoomKit/RoomRow.cs
Data structure recording space program characteristics and the status of a Room placing process.
- Scope ()
Contructor creates empty Room lists for Circulation, Occupation, Service, and Tenant.
- RoomFindByDesignArea (double area, bool unplaced=true)
Finds the first Occupant Room with the DesignArea value closest to the supplied area. C
- RoomFindByDesignXY (double designLength, double designWidth, bool unplaced=true)
Finds the first Occupant Room with the designed x and y dimensions closest to the supplied values.
- RoomFindByTypeID (int typeID, bool unplaced=true)
Finds the first unplaced Room with the specifed TypeID.
- List< Room > Circulation [get]
List of Rooms designated as circulation.
- List< Room > Occupant [get]
List of Rooms designated for occupation, rather than circulation.
- List< Room > Service [get]
List of Rooms designated for building services.
- List< Room > Tenant [get]
List of Rooms intended as a series of tenant space containers of other Rooms.
- List< Polygon > AllocatedAsPolygons [get]
List of allocated Circulation, Occupant, and Service Room Perimeters as Polygons.
- double AreaDesignAvailable [get]
Area available for horizontal circulation.
- double AreaDesignCirculation [get]
Intended aggregate area of all Occupant Rooms.
- double AreaDesignOccupant [get]
Intended aggregate area of all Occupant Rooms.
- double AreaCirculation [get]
Allocated aggregate area of all placed Circulation Rooms.
- double AreaOccupant [get]
Allocated aggregate area of all placed Occupant Rooms.
- double AreaService [get]
Aggregate area of all Services Rooms.
- double AreaTenant [get]
Aggregate area of all occupiable Tenant Rooms.
- List< Polygon > CirculationAsPolygons [get]
List of all Circulation Room Perimeters as Polygons.
- List< Polygon > OccupantAsPolygons [get]
List of all Occupant Room Perimeters as Polygons.
- List< Polygon > ServiceAsPolygons [get]
List of all Service Room Perimeters as Polygons.
- List< Polygon > TenantAsPolygons [get]
List of all Tenant Room Perimeter Polygons.
- List< Room > Placed [get]
List of all Rooms marked as Placed.
- bool PlacedAll [get]
Returns whether all Occupant Rooms have been Placed.
- double PlacedQuantity [get]
The quantity of placed Rooms.
- double RatioCirculation [get]
Returns the ratio of the aggregate area of all Occupant Rooms against the Circulation area.
- double RatioDesignCirculation [get]
Returns the ratio of the aggregate area of all designed Occupant Rooms against the designed Circulation area.
- List< Room > Unplaced [get]
Returns all Rooms with Placed = false.
- double UnplacedQuantity [get]
The quantity of unplaced Rooms.
Data structure recording space program characteristics and the status of a Room placing process.
Contructor creates empty Room lists for Circulation, Occupation, Service, and Tenant.
A new Scope.
Finds the first Occupant Room with the DesignArea value closest to the supplied area. C
| area | Area to match from the list of all Occupant Room definitions. |
|---|
A Room.
Finds the first Occupant Room with the designed x and y dimensions closest to the supplied values.
| designX | The x-axis dimension to match. |
|---|---|
| designY | The y-axis dimension to match. |
A Room.
Finds the first unplaced Room with the specifed TypeID.
| typeID | The integer ID of a Room type. |
|---|
A Room.
List of allocated Circulation, Occupant, and Service Room Perimeters as Polygons.
Allocated aggregate area of all placed Circulation Rooms.
Area available for horizontal circulation.
Intended aggregate area of all Occupant Rooms.
Intended aggregate area of all Occupant Rooms.
Allocated aggregate area of all placed Occupant Rooms.
Aggregate area of all Services Rooms.
Aggregate area of all occupiable Tenant Rooms.
List of Rooms designated as circulation.
List of all Circulation Room Perimeters as Polygons.
A list of Polygons.
List of Rooms designated for occupation, rather than circulation.
List of all Occupant Room Perimeters as Polygons.
A list of Polygons.
List of all Rooms marked as Placed.
A list of Rooms.
Returns whether all Occupant Rooms have been Placed.
Returns true if each Room in Occupant has been marked with Room.Placed = true.
The quantity of placed Rooms.
Returns the ratio of the aggregate area of all Occupant Rooms against the Circulation area.
A list of Rooms.
Returns the ratio of the aggregate area of all designed Occupant Rooms against the designed Circulation area.
A list of Rooms.
List of Rooms designated for building services.
List of all Service Room Perimeters as Polygons.
A list of Polygons.
List of Rooms intended as a series of tenant space containers of other Rooms.
List of all Tenant Room Perimeter Polygons.
A list of Polygons.
Returns all Rooms with Placed = false.
A list of Rooms.
The quantity of unplaced Rooms.
- RoomKit/Scope.cs
Creates and manages the geometry of a slab and Rooms representing corridors, occupied rooms, and services.
- Story ()
Creates a Story at a 1.0 Height on the zero plane with new lists for Corridors, Rooms, and Services. Perimeter is set to null, Name is blank, and SlabThickness is s0.1.
- bool AddCorridor (Room room, bool fit=true)
Adds a Room to the Corridors list.
- bool AddExclusion (Room room, bool fit=true)
Adds a Room to the Exclusions list.
- bool AddRoom (Room room, bool fit=true)
Adds a Room to the Rooms list.
- bool AddService (Room room, bool fit=true)
Adds a Room to the Services list.
- double AreaByName (string name)
Returns the aggregate area of all Rooms with a supplied name.
- void MoveFromTo (Vector3 from, Vector3 to)
Moves all Rooms in the Story and the Story Envelope along a 3D vector calculated between the supplied Vector3 points.
- bool RoomsByDivision (int xRooms=1, int yRooms=1, double height=3.0, double setback=0.0, string name="", Color color=null, bool fit=true)
Creates Rooms by orthogonally dividing the interior of the Story perimeter by a quantity of x-axis and y-axis intervals. Adds the new Rooms to the Rooms list. New Rooms conform to Corridor and Service perimeters.
- List< Room > RoomsByName (string name)
Returns a list of Rooms with a specific name.
- void Rotate (Vector3 pivot, double angle)
Rotates the Story Perimeter and Rooms in the horizontal plane around the supplied pivot point.
- double Area [get]
Area of the perimeter.
- double AreaAvailable [get]
Unallocated area within the Story.
- double AreaPlaced [get]
Area allocated to Corridors, Rooms, and Services.
- Color Color [get, set]
- List< Room > Corridors [get]
List of Rooms designated as cooridors.
- List< Polygon > CorridorsAsPolygons [get]
Polygons representing Corridors. Rooms Perimeters in the Story conform to Corridor Perimeters.
- List< Space > CorridorsAsSpaces [get]
List of Spaces created from Room characteristics within the Corridors list.
- Color CorridorsColor [set]
Sets the Corridors color.
- double Elevation [get, set]
- RoomEnvelope [get]
Room representing the Story envelope.
- Polygon EnvelopeAsPolygon [get]
Polygon representation of the Story Perimeter.
- Space EnvelopeAsSpace [get]
Space created from Story characteristics.
- List< Room > Exclusions [get]
Rooms representing areas that must not be intersected, but which will not be available as Spaces. All other Room Perimeters in the Story conform to Exclusion Room Perimeters.
- List< Polygon > ExclusionsAsPolygons [get]
Polygons representing areas that must not be intersected. All other Room Perimeters in the Story conform to Exclusion Room Perimeters.
- double Height [get, set]
- double HeightInteriors [set]
Sets the height of all Corridors, Rooms, and Services.
- IList< Polygon > InteriorsAsPolygons [get]
Returns all Corridors, Exclusions, Rooms, and Services as Polygons.
- IList< Space > InteriorsAsSpaces [get]
Returns all Corridors, Rooms, and Services as Spaces.
- bool IsBasement [get, set]
Identifies whether this story represents a base ment level.
- string Name [get, set]
Arbitrary string identifier.
- Polygon Perimeter [get, set]
- List< Room > Rooms [get]
List of Rooms designated as occupiable rooms.
- List< Polygon > RoomsAsPolygons [get]
Polygons representing Services. Corridors and Rooms Perimeters in the Story conform to Service Room Perimeters.
- List< Space > RoomsAsSpaces [get]
List of Spaces created from Room characteristics within the Rooms list.
- Color RoomsColor [set]
Sets the Rooms rendering color.
- List< Room > Services [get]
A list of Rooms designated as building services.
- List< Polygon > ServicesAsPolygons [get]
Polygons representing Services. Corridors and Rooms Perimeters in the Story conform to Service Room Perimeters.
- List< Space > ServicesAsSpaces [get]
List of Spaces created from Room characteristics within the Services list.
- Color ServicesColor [set]
Sets the Services Space rendering color.
- Floor Slab [get]
Concrete Floor created from Story and Slab characteristics.
- double SlabThickness [get, set]
- int TypeID [get, set]
Arbitrary integer identifier of this instance..
- string UniqueID [get]
UUID for this instance, set on initialization.
Creates and manages the geometry of a slab and Rooms representing corridors, occupied rooms, and services.
Creates a Story at a 1.0 Height on the zero plane with new lists for Corridors, Rooms, and Services. Perimeter is set to null, Name is blank, and SlabThickness is s0.1.
A new Story.
Adds a Room to the Corridors list.
| room | Room to add. |
|---|---|
| fit | Indicates whether the new room should mutually fit to other Story features. Default is true. |
True if one or more rooms were added to the Story.
Adds a Room to the Exclusions list.
| room | Room to add. |
|---|---|
| fit | Indicates whether the new room should mutually fit to other Story features. Default is true. |
True if one or more rooms were added to the Story.
Adds a Room to the Rooms list.
| room | Room to add. |
|---|---|
| fit | Indicates whether the new Room should mutually fit to other Story features. Default is true. |
True if one or more Rooms were added to the Story.
Adds a Room to the Services list.
| room | Room to add. |
|---|---|
| fit | Indicates whether the new Room should mutually fit to other Story features. Default is true. |
True if one or more Rooms were added to the Story.
Returns the aggregate area of all Rooms with a supplied name.
| name | Name of the Rooms to retrieve. |
|---|
None.
///
Moves all Rooms in the Story and the Story Envelope along a 3D vector calculated between the supplied Vector3 points.
| from | Vector3 base point of the move. |
|---|---|
| to | Vector3 target point of the move. |
None.
bool RoomKit.Story.RoomsByDivision (int xRooms = 1, int yRooms = 1, double height = 3.0, double setback = 0.0, string name = "", Color color = null, bool fit = true)
Creates Rooms by orthogonally dividing the interior of the Story perimeter by a quantity of x-axis and y-axis intervals. Adds the new Rooms to the Rooms list. New Rooms conform to Corridor and Service perimeters.
| xRooms | Quantity Rooms along the orthogonal x-axis. |
|---|---|
| yRooms | Quantity Rooms along the orthogonal y-axis. |
| height | Height of the new Rooms. |
| setback | Offset from the Story perimeter. |
| name | String identifier applied to every new Room. |
| color | Rendering color of the Room as a Space. |
None.
Returns a list of Rooms with a specific name.
| name | Name of the rooms to retrieve. |
|---|
None.
///
Rotates the Story Perimeter and Rooms in the horizontal plane around the supplied pivot point.
| pivot | Vector3 point around which the Room Perimeter will be rotated. |
|---|---|
| angle | Angle in degrees to rotate the Perimeter. |
None.
Area of the perimeter.
Unallocated area within the Story.
Area allocated to Corridors, Rooms, and Services.
List of Rooms designated as cooridors.
Polygons representing Corridors. Rooms Perimeters in the Story conform to Corridor Perimeters.
List of Spaces created from Room characteristics within the Corridors list.
Sets the Corridors color.
Room representing the Story envelope.
Polygon representation of the Story Perimeter.
Space created from Story characteristics.
Rooms representing areas that must not be intersected, but which will not be available as Spaces. All other Room Perimeters in the Story conform to Exclusion Room Perimeters.
Polygons representing areas that must not be intersected. All other Room Perimeters in the Story conform to Exclusion Room Perimeters.
Sets the height of all Corridors, Rooms, and Services.
Returns all Corridors, Exclusions, Rooms, and Services as Polygons.
Returns all Corridors, Rooms, and Services as Spaces.
Identifies whether this story represents a base ment level.
Arbitrary string identifier.
List of Rooms designated as occupiable rooms.
Polygons representing Services. Corridors and Rooms Perimeters in the Story conform to Service Room Perimeters.
List of Spaces created from Room characteristics within the Rooms list.
Sets the Rooms rendering color.
A list of Rooms designated as building services.
Polygons representing Services. Corridors and Rooms Perimeters in the Story conform to Service Room Perimeters.
List of Spaces created from Room characteristics within the Services list.
Sets the Services Space rendering color.
Concrete Floor created from Story and Slab characteristics.
Arbitrary integer identifier of this instance..
UUID for this instance, set on initialization.
- RoomKit/Story.cs
- bool AddCore (Polygon perimeter, int baseStory=0, double addHeight=0.0, Color color=null)
Adds a new service Core to the Tower.
- double AreaByName (string name)
Returns the aggregate area of all Rooms with a supplied name.
- void MoveFromTo (Vector3 from, Vector3 to)
Moves all Cores and Stories in the Tower along a 3D vector calculated between the supplied Vector3 points.
- List< Room > RoomsByName (string name)
Returns a list of Rooms with a specific name.
- void Rotate (Vector3 pivot, double angle)
Rotates the Tower Perimeter and Stories in the horizontal plane around the supplied pivot point.
- bool Stack ()
Creates the Tower by stacking a series of Story instances from the Tower Elevation.
- bool SetStoryHeight (int story, double height, bool interiors=true, bool upward=true)
Sets the height of an index-specified Story and relocates Stories above to accommodate the Story's new height.
- List< Story > Stories = null
List of all Stories in the Tower.
- double Area [get]
Returns the aggregate area of all Stories in the Tower.
- Color Color [get, set]
- List< Room > Cores [get]
List of all service Cores in the Tower.
- double Elevation [get, set]
- RoomEnvelope [get]
Room representing the Tower envelope.
- Polygon EnvelopeAsPolygon [get]
Polygon representation of the Story Perimeter.
- Space EnvelopeAsSpace [get]
Space created from Story characteristics.
- int Floors [get, set]
- double Height [get]
Highest point of the highest tower story above the zero plane.
- double HeightLimit [get, set]
Desired typical Story height in the Tower.
- string Name [get, set]
Arbitrary string identifier for this Tower instance.
- Polygon Perimeter [get, set]
- List< Floor > Slabs [get]
List of all Slabs from every Story in the Tower.
- List< Space > Spaces [get]
List of all Spaces from every Story in the Tower.
- double StoryHeight [get, set]
- double TargetArea [get, set]
- int TypeID [get, set]
Arbitrary integer identifier of this instance..
- string UniqueID [get]
UUID for this instance, set on initialization.
bool RoomKit.Tower.AddCore (Polygon perimeter, int baseStory = 0, double addHeight = 0.0, Color color = null)
Adds a new service Core to the Tower.
| perimeter | Polygon perimeter defining the footprint of the service Core. |
|---|---|
| baseStory | Index of the lowest Story whose elevation will serve as the lowest level of the Core. |
| addHeight | Additional height of the Core above the highest Story. |
| color | Color of the Core when it it is accessed as a Space. |
True if the Core is successfully added.
Returns the aggregate area of all Rooms with a supplied name.
| name | Name of the Rooms to retrieve. |
|---|
None.
///
Moves all Cores and Stories in the Tower along a 3D vector calculated between the supplied Vector3 points.
| from | Vector3 base point of the move. |
|---|---|
| to | Vector3 target point of the move. |
None.
Returns a list of Rooms with a specific name.
| name | Name of the rooms to retrieve. |
|---|
None.
///
Rotates the Tower Perimeter and Stories in the horizontal plane around the supplied pivot point.
| pivot | Vector3 point around which the Room Perimeter will be rotated. |
|---|---|
| angle | Angle in degrees to rotate the Perimeter. |
None.
bool RoomKit.Tower.SetStoryHeight (int story, double height, bool interiors = true, bool upward = true)
Sets the height of an index-specified Story and relocates Stories above to accommodate the Story's new height.
| story | Index of the Story to affect. |
|---|---|
| height | Desired new height of the specified Story. |
| interiors | If true also sets any Corridors and Rooms in the Story to the new Height. |
True if the Tower is successfully stacked.
Creates the Tower by stacking a series of Story instances from the Tower Elevation.
| floors | Desired quantity of stacked Stories to form the Tower. If greater than zero, overrides and resets the current Floors property. |
|---|---|
| storyHeight | Desired typical Story height of the Tower. If greater than zero, overrides and resets the current StoryHeight property. |
| basement | Whether to consider the lowest floor a basement. |
True if the Tower is successfully stacked.
List of all Stories in the Tower.
Returns the aggregate area of all Stories in the Tower.
List of all service Cores in the Tower.
Room representing the Tower envelope.
Polygon representation of the Story Perimeter.
Space created from Story characteristics.
Highest point of the highest tower story above the zero plane.
Desired typical Story height in the Tower.
Arbitrary string identifier for this Tower instance.
List of all Slabs from every Story in the Tower.
List of all Spaces from every Story in the Tower.
Arbitrary integer identifier of this instance..
UUID for this instance, set on initialization.
- RoomKit/Tower.cs