Represents a beam element.
typedef struct {
API_Elem_Head head;
short aboveViewLinePen;
API_AttributeIndex aboveViewLineType;
API_AttributeIndex refLtype;
short refPen;
short cutContourLinePen;
API_AttributeIndex cutContourLineType;
Int32 sequence;
API_PenOverrideType penOverride;
API_StoryVisibility visibility;
API_LinkToSettings linkToSettings;
API_BHoleTypeID holeType;
bool holeContureOn;
bool isAutoOnStoryVisibility;
double holeWidth;
double holeHeight;
double holeLevel;
double offset;
double level;
API_BeamVisibleLinesID showContourLines;
API_BeamVisibleLinesID showReferenceAxis;
API_Coord begC;
API_Coord endC;
double curveAngle;
API_AttributeIndex verticalCurveHeight;
API_AttributeIndex hiddenLineType;
short hiddenLinePen;
API_AttributeIndex belowViewLineType;
short belowViewLinePen;
bool isFlipped;
bool isSlanted;
double slantAngle;
double axisRotationAngle;
API_BeamShapeTypeID beamShape;
API_ElemDisplayOptionsID displayOption;
API_ElemViewDepthLimitationsID viewDepthLimitation;
API_ElemViewDepthLimitationsID uncutProjectionMode;
API_ElemViewDepthLimitationsID overheadProjectionMode;
UInt32 nSegments;
UInt32 nCuts;
UInt32 nSchemes;
UInt32 nProfiles;
bool useCoverFill;
bool useCoverFillFromSurface;
bool coverFillOrientationComesFrom3D;
bool filler_6;
API_AttributeIndex coverFillType;
short coverFillForegroundPen;
short coverFillBackgroundPen;
short filler_7;
API_CoverFillTransformationTypeID coverFillTransformationType;
Int32 filler_8;
API_CoverFillTransformation coverFillTransformation;
} API_BeamType;
Members
- head
- General element header.
- aboveViewLinePen
- The pen index.
- aboveViewLineType
- The linetype index.
- refLtype
- The linetype index of the reference line.
- refPen
- The pen index of the reference line.
- cutContourLinePen
- The pen index of the cut lines of the beam.
- cutContourLineType
- The line type index of the beam section countour line.
- sequence
- Sequence is required when two beams meet with the same priority or when 3 or more beams meet in a junction. It’s actual values can be between 0 and 999.
- penOverride
- Cut fill pens set in the used structure (building material, complex profile) can be overridden on the element level.
- visibility
- The option to define which stories display the beam.
- linkToSettings
- Mode of linking to home story.
- holeType
- The shape of the beam hole (see API_BHoleTypeID).
- holeContureOn
- Show the hole’s conture on the plan.
- isAutoOnStoryVisibility
- Recalculate the story visibility automatically according to the actual elevation of the beam.
- holeWidth
- The default width of the holes.
- holeHeight
- The default height of the holes (effective only for the rectangle type –
holeTypeisAPIBHole_Rectangular). - holeLevel
- The default level of the holes: the distance between the center of the hole and the top of the beam.
- offset
- The offset of beam’s reference line from the center.
- level
- The top height of the beam relative to the floor level.
- showContourLines
- showReferenceAxis
- begC
- The beginning (start) coordinate of the beam.
- endC
- The end coordinate of the beam.
- curveAngle
- The arc angle of the curved beam between
begCandendC(negative value results an arc on the opposite side). This value is always zero for straight beams. - verticalCurveHeight
- The height of the vertical curvature of the beam.
- hiddenLineType
- hiddenLinePen
- belowViewLinePen
- Pen index of the uncut lines.
- belowViewLineType
- Linetype of the uncut lines.
- isFlipped
- Defines whether the beam is mirrored. Applies to profiled beams only.
- isSlanted
- Defines whether the beam is slanted.
- slantAngle
- Slant angle.
- axisRotationAngle
- Profile rotating angle around it’s center line.
- beamShape
- Type to define if beam is straight, horizontally or vertically curved.
- 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).
- uncutProjectionMode
- Uncut projection mode.
- overheadProjectionMode
- Overhead projection mode.
- nSegments
- Number of segments.
- nCuts
- Number of cuts.
- nSchemes
- Number of schemes.
- nProfiles
- Number of profiles.
- useCoverFill
- Use Floor plan fill.
- useCoverFillFromSurface
- Use the fill attribute assigned to the surface material of the element.
- coverFillOrientationComesFrom3D
- Use cover fill orientation from 3D element view.
- coverFillType
- Type of the fill.
- coverFillForegroundPen
- Foreground pen of the cover fill.
- coverFillBackgroundPen
- Background pen of the cover fill.
- coverFillTransformationType
- TransformationType of the fill (see API_CoverFillTransformationTypeID).
- coverFillTransformation
- Orientation and distortion parameters of the cover fill. (see API_CoverFillTransformation).
Remarks
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 profileAttr.
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 beam related memo data see the ACAPI_Element_GetMemo function.
Requirements
- Version: API 2.1 or later
- Header: APIdefs_Elements.h
See Also
API_BHoleTypeID, API_Coord, API_StoryVisibility, API_LinkToSettings
API_ElemDisplayOptionsID, API_ElemViewDepthLimitationsID
API_AttributeIndex, API_Elem_Head, API_Element, API_ElementMemo
API_Gable
API_BeamSegmentType, API_AssemblySegmentData
API_AssemblySegmentSchemeData, API_AssemblySegmentProfileData
API_BeamRelation
Element Manager, API Types