Represents a hatch element.
typedef struct { API_Elem_Head head; API_ExtendedPenType contPen; API_HatchSubType hatchType; UInt32 hatchFlags; API_ExtendedPenType fillPen; short filler_0; short fillBGPen; API_AttributeIndex fillInd; API_AttributeIndex buildingMaterial; API_AttributeIndex ltypeInd; char roomSpecial; char filler_1[4]; bool showArea; short determination; Int32 filler_2[2]; char filler_3[16]; double penWeight; Int32 filler_3[2]; API_NoteType note; API_Polygon poly; bool filler_5[8]; Int32 filler_6[10]; API_HatchOrientation hatchOrientation; bool filler_7; char filler_8[3]; Int32 filler_9[5]; API_RGBColor backgroundRGB; bool filler_10; char filler_11[3]; Int32 filler_12[5]; API_RGBColor foregroundRGB; } API_HatchType;
Members
- head
- General element header.
- contPen
- Pen attribute index of the hatch contour (0 if contour is switched off).
- hatchType
- Subtype of the hatch.
- hatchFlags
- Flags to modify hatch display. See API_HatchFlags for possible values.
- fillPen
- Pen attribute index of the hatch fill.
- fillBGPen
- Pen attribute index of hatch fill background.
- fillInd
- Fill attribute index of the hatch.
Used only is case of API_FillHatch. - buildingMaterial
- Building Material attribute index of the hatch.
Used only is case of API_BuildingMaterialHatch. - ltypeInd
- Line type attribute index.
- roomSpecial
- Special area percent in a room (negative means OFF).
- showArea
True
if area text is shown (parameters in note).- determination
- Fill category:
-
APIHatch_DraftingFills
Default fill category. Drafting fills adopt the Drafting Fill settings chosen in Display Options.
APIHatch_CoverFills
The Cover Fill category is assigned to the fills of Slabs, Roofs, Meshes and Zones on the floor plan. Cover fills adopt the Element Cover Fill settings chosen in Display Options.
APIHatch_CutFills
The Cut Fill category is assigned to the fills of Cut Elements. Cut fills adopt the Cut Fill settings chosen in Display Options.
- Used only is case of API_FillHatch.
- penWeight
- Pen weight of the contour (overrides the weight defined in
contPen
). - note
- Parameters of the area text.
- poly
- Polygon of the hatch element.
- hatchOrientation
- Orientation and distortion parameters of the cover fill.
- backgroundRGB
- RGB color for background painting.
- foregroundRGB
- RGB color for foreground painting.
Remarks
In Archicad 10 the
polyFill
field is removed from the structure, the global
, refPos
and refAngle
parameters are placed into a separate structure (API_HatchOrientation). Along this line, in Archicad 13 the gradient fill parameters were also moved to the same structure.
In Archicad 17 the
hasForegroundRGB
and hasBackgroundRGB
parameters are placed into a separate structure (API_HatchFlags).
In Archicad 20 the
contPen
and fillPen
parameters are placed into a separate structure (API_ExtendedPenType).
Requirements
- Version: API 2.1 or later
- Header: APIdefs_Elements.h
See Also
API_AttributeIndex, API_HatchSubType, API_HatchFlags, API_ExtendedPenType,
API_Elem_Head, API_Element, API_ElementMemo
API_NoteType, API_Coord, API_Polygon, API_HatchOrientation
API_FilltypeType, API_RGBColor
Element Manager, API Types