→Graphisoft Home →Download ArchiCAD Educational →Download ArchiCAD Trial →ArchiCAD Forum →ArchiCAD Tutorials

Contets

Whenever you create a new Zone Stamp you do it in the Library part Editing Dialog. If you start a new Zone Stamp you will see that there are 40 fixed parameters additionally to the default 'A' and 'B' parameters. This document tells you about what each of these parameters mean and what values they return.

ROOM_NAME

Type: string
Possible length: max. 31 characters
Returns the name (e.g. 'Living Room') of the Zone. The default value set in the Zone Stamp Library Part is overridden by the value set in the Zone Settings Dialog.

ROOM_NAME.gif

The fields in the Zone Settings Dialog corresponding to or reporting ROOM_NAME, ROOM_NUMBER, ROOM_AREA, ROOM_HEIGHT, ROOM_BASELEV, ROOM_FL_THICK and ROOM_LSIZE

ROOM_NUMBER

Type: string
Possible length: max. 31 characters
Returns the number (e.g. '001') of the Zone. The default value set in the Zone Stamp Library Part is overridden by the value set in the Zone Settings Dialog.
Note: see illustration at ROOM_NAME

ROOM_LSIZE

Type: numerical (positive value)
Possible range: 0 and up (in millimeter)
Returns the default letter size with which texts of the Zone Stamp are drawn. The default value set in the Zone Stamp Library Part is overridden by the value set in the Zone Settings Dialog.
Note: see illustration at ROOM_NAME

ROOM_AREA

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area of the Zone polygon as measured automatically by the program. Depending on input type the Zone polygon finds either the inside of enclosing Walls or their reference lines (which can even be on the opposite side of the Wall) and ROOM_AREA will reflect this difference in value. The sizes of holes within the polygon are not deducted from this value. The value of the variable will be displayed on the 'Parameters' Tab Page of the Zone Settings Dialog.
Note: see illustration at ROOM_NAME

ROOM_PERIM

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of the outside perimeter of the Zone polygon. The perimeter of holes within the Zone polygon is not included in the variable. If the Zone is set to find the reference lines of its surrounding Walls instead of their inside surfaces then the Zone's perimeter will be measured along these reference lines. If there is a recess in a Wall because of a Window or Door and the Zone extends to the inside of surrounding Walls the sides of the recess will be added to this perimeter value.

ROOM_PERIM.gif

The surfaces returned by ROOM_PERIM, ROOM_HOLES_PRM and ROOM_WALLS_PRM

ROOM_HOLES_PRM

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the perimeter of all holes within the Zone polygon. These holes can be created by Walls or Columns that are inside the Zone polygon and are set in their Dialogs to be Zone boundaries (thereby generating holes into the Zone) or by holes placed into the Zone when it is drawn manually (not automatically finding boundaries).
Note: see illustration at ROOM_PERIM

ROOM_WALLS_PRM

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of Walls along the outside perimeter of the Zone polygon. This means that those portions of Wall lengths will be added where there is a Wall body along the outside perimeter of the Zone polygon. If a portion of the boundary of the Zone polygon is made of a Line, Circle, Ellipse or Spline that portion is not included in the value of this variable.
Note: see illustration at ROOM_PERIM

ROOM_CORNERS

Type: numerical (positive integer value)
Possible range: 2 (in case of a circle sector) and up
Returns the total number of corners of the Zone. This includes the number of corners of the Zone polygon plus the number of corners of any holes within the Zone polygon. Holes may also be generated into the Zone if a Wall or Column stands in the Zone and the 'Zone Boundary' setting is selected in its Settings Dialog for its relation to Zones. Also, the number of corners in the Zone polygon created because of Wall recesses or Window/Door recesses in Walls will be added. When you select the Zone you will not see these corners generated by recesses but on the Floor Plan you will see them in the Zone polygon's shape. The existence of these recesses is controlled from the 'Zones' Tab page of the Preferences Dialog (over what size are they generated as part of the Zone).

ROOM_CONCAVES

Type: numerical (positive integer value)
Possible range: 2 (in case of a circle sector) and up
Returns how many of the corners of the Zone polygon (returned by ROOM_CORNERS) are concave (larger than 180°). The angle is always measured in the Zone side of any corner. For example, the four corners around a Zone polygon hole are all concave (270° - not 90°).

ROOM_WALLS_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface of Walls along the outside perimeter of the Zone polygon. The surfaces of those Walls being within the Zone and being 'Zone boundaries' are also included. The Wall surfaces will be reduced by the area of those Window/Door openings or empty holes placed in them which are larger than the limit set in the 'Reduce Wall quantities if an Opening is larger than' field of the Setup List Schemes Dialog.

ROOM_WALLS_SURF.gif

The surfaces of the Zone body returned by ROOM_WALLS_SURF

ROOM_DOORS_WID

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of the widths of all Doors that are placed into Walls along the perimeter of the Zone polygon (both outside perimeter and the perimeter of holes).

ROOM_DOORS_WID.gif

The surfaces returned by ROOM_DOORS_WID, ROOM_DOORS_SURF, ROOM_WINDS_WID and ROOM_WINDS_SURF

ROOM_DOORS_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all Doors that are placed into Walls along the perimeter of the Zone polygon (both outside perimeter and the perimeter of holes).
Note: see illustration at ROOM_DOORS_WID

ROOM_WINDS_WID

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of the widths of all Windows that are placed into Walls along the perimeter of the Zone polygon (both outside perimeter and the perimeter of holes).
Note: see illustration at ROOM_DOORS_WID

ROOM_WINDS_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all Windows that are placed into Walls along the perimeter of the Zone polygon (both outside perimeter and the perimeter of holes).
Note: see illustration at ROOM_DOORS_WID

ROOM_BASELEV

Type: numerical (real value)
Possible range: any value (in meters)
Returns the level (height) at which the bottom of the Zone 'body' is located. The default value set in the Zone Stamp Library Part is overridden by the value set in the Zone Settings Dialog.
Note: see illustration at ROOM_NAME

ROOM_FL_THICK

Type: numerical (positive value)
Possible range: 0 or up (in meters)
Returns the subfloor thickness of the Zone. The default value set in the Zone Stamp Library Part is overridden by the value set in the Zone Settings Dialog.
Note: see illustration at ROOM_NAME

ROOM_HEIGHT

Type: numerical (real value)
Possible range: any value (in meters)
Returns the height of the Zone 'body'. The default value set in the Zone Stamp Library Part is overridden by the value set in the Zone Settings Dialog. The variable can return a negative value as well.
Note: see illustration at ROOM_NAME

ROOM_NET_AREA

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total net area of the Zone as measured automatically by the program. It is the area of the Zone within the inner sides of its enclosing Walls or other boundaries minus the holes that are created into the Zone by Walls or Columns by setting 'Zone boundary' role for these elements in their Settings Dialog. A hole can also be created into a Zone polygon by drawing one into it using the 'Polygon' Zone creation method (not automatically finding its boundaries at Walls etc.). The value is displayed in the 'Area Calculation' Tab Page of the Zone Settings Dialog.

ROOM_NET_AREA.gif

The fields in the Zone Settings Dialog reporting or corresponding to ROOM_NET_AREA, ROOM_WALL_EXTR_AREA, ROOM_COLUMN_EXTR_AREA, ROOM_FILL_EXTR_AREA, ROOM_LOW_EXTR_AREA, ROOM_REDUCED_AREA, ROOM_AREA_FACTOR and ROOM_CALC_AREA

ROOM_NET_PERIMETER

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of the net perimeter of the Zone polygon. This includes the perimeter of the Zone polygon plus the perimeter of holes in the Zone polygon. If the Zone is set to find the reference lines of its surrounding Walls than that portion of Zone Perimeter will be measured along these reference lines.

ROOM_WALL_EXTR_AREA

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area that is reduced from the Zone's measured net area (ROOM_NET_AREA) because there are Walls there within the Zone. The 'Reduce Zone Area' option has to be selected for these Walls in the 'Relation to Zones' field of the 'Listing Attributes' portion of the Wall Settings Dialog for their areas to be reduced from the Zone area. Walls that are Zone boundaries are not included in this variable. The value is displayed in the 'Area Calculation' Tab Page of the Zone Settings Dialog.
Note: see illustration at ROOM_NET_AREA

ROOM_COLUMN_EXTR_AREA

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area that is reduced from the Zone's measured net area (ROOM_NET_AREA) because there are Columns there within the Zone. The 'Reduce Zone Area' option has to be selected for these Columns in the 'Relation to Zones' field of the 'Listing Attributes' portion of the Column Settings Dialog for their areas to be reduced from the Zone area. Columns that are Zone boundaries are not included in this variable. The value is displayed in the 'Area Calculation' Tab Page of the Zone Settings Dialog.
Note: see illustration at ROOM_NET_AREA

ROOM_FILL_EXTR_AREA

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area that is reduced from the Zone's measured net area (ROOM_NET_AREA) because Fills are placed there within the Zone. The 'Subtract from Zones' checkbox has to be selected for these Fills in the 'Listing Attributes' portion of the Fill Settings Dialog for their areas to be reduced from the Zone area. The defined percentage of the Fills' areas will be deducted. The value is displayed in the 'Area Calculation' Tab Page of the Zone Settings Dialog.
Note: see illustration at ROOM_NET_AREA

ROOM_LOW_EXTR_AREA

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area that is reduced from the Zone's measured net area (ROOM_NET_AREA) because their height is lower than the predefined values. These limits can be set in the 'Low Ceiling Reduction' portion of the 'Zones' tab page of the Preferences Dialog. The predefined percentages of these calculated areas will be deducted from the Zone area. The value is displayed in the 'Area Calculation' Tab Page of the Zone Settings Dialog.
Note: see illustration at ROOM_NET_AREA

ROOM_TOTAL_EXTR_AREA

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area that is deducted from the Zone's measured net area (ROOM_NET_AREA). This is obtained by adding the values returned under ROOM_WALL_EXTR_AREA, ROOM_COLUMN_EXTR_AREA, ROOM_LOW_EXTR_AREA and ROOM_FILL_EXTR_AREA.

ROOM_REDUCED_AREA

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the area of the Zone that remains after deducting all the above areas (ROOM_TOTAL_EXTR_AREA) that are decreased from the measured area of the Zone (ROOM_NET_AREA). The value is displayed in the 'Area Calculation' Tab Page of the Zone Settings Dialog.
Note: see illustration at ROOM_NET_AREA

ROOM_AREA_FACTOR

Type: numerical (positive value)
Possible range: 0.00 - 1.00
Returns a number corresponding to the reduction value of the Zone. It is calculated this way: In the 'Area Calculation' Tab page of the Zone Settings Dialog you can set a percentage in the field next to the 'Reduce by'checkbox when the checkbox is enabled. The percentage value can be between 0-100 %. The remainder relative to 'Reduced Area' is expressed by this number. It is calculated by the following formula:

Zone Area Reducement = image012.gif

For example if no reduction is set 'Zone Area Reducement' returns 1.00 in case of 10% reduction it returns 0.90. Note: see illustration at ROOM_NET_AREA

ROOM_CALC_AREA

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the area that remains from the Zone (and is reported on the Zone stamp) as final calculated area of the Zone. It is obtained by multiplying ROOM_REDUCED_AREA by ROOM_AREA_FACTOR. Naturally, ROOM_CALC_AREA is never larger than ROOM_REDUCED_AREA. The value is displayed in the 'Area Calculation' Tab Page of the Zone Settings Dialog.
Note: see illustration at ROOM_NET_AREA

ROOM_VOLUME

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns the total volume of the Zone. When calculating the volume, holes of the Zone are deducted in their full height, Wall recesses are added, portions of the Zone body trimmed by Roofs, Slabs and Beams are deducted to calculate the final value of the volume.

ROOM_BOUNDARY_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface of the sides of the perimeter of the Zone polygon. The surfaces of Zone holes are also included. The Wall surfaces will be reduced by the area of those Window/Door openings or empty holes placed in them which are larger than the limit set in the 'Reduce Wall quantities if an Opening is larger than' field of the Setup List Schemes Dialog. Also, trimming the Zone body with Roofs, Slabs or Beams also results in the side areas of the Zone body being reduced, which is reflected in the value returned by this variable.

ROOM_TOP_SURFACE

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total top surface of the Zone body. This is the surface that remains from its top after it has been trimmed by Roofs, Slabs and/or Beams.

ROOM_TOP_SURFACE.gif

The surfaces of a Zone body returned by ROOM_TOP_SURFACE, ROOM_ROOF_TOP_SURF, ROOM_SLAB_TOP_SURF and ROOM_BEAM_TOP_SURF

ROOM_BOT_SURFACE

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total bottom surface of the Zone body. This is the surface that remains from its bottom after it has been trimmed by Roofs, Slabs and/or Beams.

ROOM_BOT_SURFACE.gif

The surfaces of a Zone body returned by ROOM_BOT_SURFACE, ROOM_ROOF_BOT_SURF, ROOM_SLAB_BOT_SURF and ROOM_BEAM_BOT_SURF

ROOM_ROOF_TOP_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area of all flat or sloped surfaces of the Zone body that were generated by trimming the top of the Zone body to a Roof.
Note: see illustration at ROOM_TOP_SURFACE

ROOM_ROOF_BOT_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area of all flat or sloped surfaces of the Zone body that were generated by trimming the bottom of the Zone body to a Roof.
Note: see illustration at ROOM_BOT_SURFACE

ROOM_SLAB_TOP_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area of all surfaces of the Zone body that were generated and cut out from its top surface by trimming the top of the Zone body to a Slab.
Note: see illustration at ROOM_TOP_SURFACE

ROOM_SLAB_BOT_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area of all surfaces of the Zone body that were generated and cut out from its bottom surface by trimming the bottom of the Zone body to a Slab.
Note: see illustration at ROOM_BOT_SURFACE

ROOM_BEAM_TOP_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area of all surfaces of the Zone body that were generated and cut out from its top surface by trimming the top of the Zone body to a Beam.
Note: see illustration at ROOM_TOP_SURFACE

ROOM_BEAM_BOT_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area of all surfaces of the Zone body that were generated and cut out from its top surface by trimming the bottom of the Zone body to a Beam.
Note: see illustration at ROOM_BOT_SURFACE

ROOM_WALL_IN_TOP_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
If there is a Door/Window in a Wall and its sill height is zero an inset is generated into the Wall the body of which is added to the Zone body. This variable returns the top surface of this inset. Since the inset does not follow the shape of the Door/Window but always extends a rectangular body from the Zone's main body, ROOM_WALL_IN_TOP_SURF is obtained by multiplying the depth of the Door/Window in the Wall by its width.

ROOM_WALL_IN_TOP_SURF.gif

The measurements returned by ROOM_WALL_IN_TOP_SURF, ROOM_WALL_IN_BACK_SURF and ROOM_WALL_IN_SIDE_SURF (in case of Wall inset body extruding from the Zone body)

ROOM_WALL_IN_BACK_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the back surface of the wall inset, which is the size of the rectangular hole the Door/Window cuts into the Wall. It is obtained by multiplying the width of the Door/Window by its height.
Note: see illustration at ROOM_WALL_IN_TOP_SURF

ROOM_WALL_IN_SIDE_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total of side surfaces of the wall inset, which is the size of the two sides of the rectangular hole the Door/Window cuts into the Wall. It is obtained by multiplying by two the product of the depth of the Door/Window in the Wall and its width.
Note: see illustration at ROOM_WALL_IN_TOP_SURF


CategoryCalculation, CategoryGdl

Zone Fix Parameters (last edited 2008-08-27 15:11:31 by localhost)