The common parameters of roof (API_RoofType) and shell (API_ShellType) elements.
typedef struct { short pen; short filler_0; API_AttributeIndex ltypeInd; API_ModelElemStructureType modelElemStructureType; API_AttributeIndex buildingMaterial; API_AttributeIndex composite; short filler_1[2]; API_PenOverrideType penOverride; API_AttributeIndex sectContLtype; short sectContPen; short floorFillPen; API_AttributeIndex floorFillInd; short floorFillBGPen; short aboveViewLinePen; API_AttributeIndex aboveViewLineType; short filler_2[2]; bool useFloorFill; bool use3DHatching; bool useFillLocBaseLine; bool useSlantedFill; Int32 filler_3[8]; API_HatchOrientation hatchOrientation; char filler_4[16]; API_OverriddenAttribute topMat; API_OverriddenAttribute sidMat; API_OverriddenAttribute botMat; bool materialsChained; bool isAutoOnStoryVisibility; API_StoryVisibility visibilityCont; API_StoryVisibility visibilityFill; API_LinkToSettings linkToSettings; bool filler_5[12]; Int32 filler_6; double level; double thickness; API_EdgeTrim edgeTrim; API_ShellBaseCutBodyTypeID cutBodyType; API_ElemDisplayOptionsID displayOption; API_ElemViewDepthLimitationsID viewDepthLimitation; Int32 compositionPriority; } API_ShellBaseType;
Members
- pen
- Pen attribute index of the contour.
- ltypeInd
- Line type attribute index of the contour.
- modelElemStructureType
- The structure type of the shellBase.
- buildingMaterial
- Building Material index of shellBase’s hatch. Used only, if structure type is API_BasicStrucure.
- composite
- Composite index of shellBase. Used only, if structure type is API_CompositeStructure.
- penOverride
- Cut fill pens set in the used structure (building material, composite) can be overridden on the element level.
- sectContPen
- Contour pen attribute index of the fill in sections.
- sectContLtype
- Line type attribute index of the element’s section contour.
- floorFillPen
- Pen attribute index of element’s cover fill.
- floorFillBGPen
- Background pen attribute index of the element’s cover fill.
- floorFillInd
- Fill attribute index of the element’s cover fill.
- aboveViewLinePen
- Pen used when “Overhead All” is selected from the “Floor Plan Display” popup. Corresponds to the “Overhead Line Pens” value in the element’s Settings dialog.
- aboveViewLineType
- Line type used when “Overhead All” is selected from the “Floor Plan Display” popup. Corresponds to the “Overhead Lines” value in the element’s Settings dialog.
- useFloorFill
- Use cover fill.
- use3DHatching
- Use the fill attribute assigned to the surface material (vectorial 3D hatch) of the element.
- useFillLocBaseLine
- Align the cover fill pattern with the pivot line of the roof instead of using the fill handle.
- useSlantedFill
- Distort the cover fill to have the effect of a sloped roof as seen from above.
- hatchOrientation
- Orientation and distortion parameters of the cover fill.
- topMat
- Top material attribute override structure.
- sideMat
- Side material attribute override structure.
- botMat
- Bottom material attribute override structure.
- materialsChained
- Are surface materials chained?
- isAutoOnStoryVisibility
- Recalculate the story visibility automatically according to the actual vertical extent of the element.
- visibilityCont
- Visibility of the element’s contour line. On the element’s own story the contour should always be visible.
- visibilityFill
- Visibility of the element’s cover fill.
- linkToSettings
- Mode of linking to home story.
- level
- Base level of the element (reference line height in case of Roof elements) from the floor level.
- thickness
- Thickness of the element.
- edgeTrim
- Type of the trim of the element’s edges. (In former API versions this parameter used to be called
sideType
.) - cutBodyType
- Type of the element’s body extension for connections (see API_ShellBaseCutBodyTypeID).
- displayOption
- Display options of the element on the floor plan (see API_ElemDisplayOptionsID).
- viewDepthLimitation
- Defines the range within the element is shown on the floor plan (see API_ElemViewDepthLimitationsID).
- compositionPriority
- Corresponds to the value of “Junction Order” in the settings dialogs, visible only when “Use legacy intersection and Surface methods for model elements” is set in Project Preferences / Legacy.
Its value is in the [0-16] range.
Remarks
This structure is created from
API_RoofType
to hold the common parameters of API_RoofType and API_ShellType.
In Archicad 17 the type of the elements’ structure is defined with the new
modelElemStructureType
member. The related attribute indices are separated into buildingMaterial
and composite
. The composite index is a non-negative index.
In Archicad 17 the the elements’ cut fill foreground and background pens inherit from the element structure, and can be overridden on the element level.
In Archicad 17 the the elements’ surface materials inherit from the element structure, and can be overridden on the element level.
For shell related memo data see the ACAPI_Element_GetMemo function.
Requirements
- Version: API 15 or later
- Header: APIdefs_Elements.h
See Also
API_AttributeIndex, API_Elem_Head, API_HatchOrientation, API_StoryVisibility, API_LinkToSettings
API_EdgeTrim, API_ShellBaseCutBodyTypeID, API_ElemDisplayOptionsID, API_ElemViewDepthLimitationsID
API_RoofType, API_ShellType, API_Element, API_ElementMemo
Element Manager, API Types