API_ElementMemo |

API_ElementMemo

Describes the variable length additional data of elements.

    typedef struct {
        API_Coord                        **coords;
        Int32                            **pends;
        API_PolyArc                      **parcs;
        UInt32                           **vertexIDs;
        UInt32                           **edgeIDs;
        UInt32                           **contourIDs;
        API_AddParType                   **params;
        API_Gable                        **gables;
        API_EdgeTrim                     **edgeTrims;
        double                           **meshPolyZ;
        API_MeshLevelCoord               **meshLevelCoords;
        Int32                            **meshLevelEnds;
        API_DimElem                      **dimElems;
        API_SplineDir                    **bezierDirs;
        char                             **textContent;
        short                            **textLineStarts;
        API_Beam_Hole                    **beamHoles;
        API_LinkType                     **linkList;
        char                             **pictHdl;
        API_ParagraphType                **paragraphs;
        GSPtr                            drawingData;
        ProfileVectorImage               *customOrigProfile;
        ProfileVectorImage               *stretchedProfile;
        GSPtr                            customParams;
        API_SectionSegment               *intElevSegments;
        API_Coord                        *sectionSegmentMainCoords;
        API_Coord                        *sectionSegmentDistCoords;
        API_Coord                        *sectionSegmentDepthCoords;
        API_Guid                         *wallWindows;
        API_Guid                         *wallDoors;
        API_GridMesh                     *cWSegGridMesh;
        API_CWContourData                *cWSegContour;
        API_CWSegmentPatternData         cWSegPrimaryPattern;
        API_CWSegmentPatternData         cWSegSecondaryPattern;
        API_CWSegmentPatternCellData     *cWSegPatternCells;
        API_CWSegmentType                *cWallSegments;
        API_CWFrameType                  *cWallFrames;
        API_CWFrameType                  *cWallFrameDefaults;
        API_Guid                         *cWallFrameDefaultSymbs;
        API_CWPanelType                  *cWallPanels;
        API_CWPanelGridIDTable           *cWallPanelGridIDTable;
        API_CWPanelType                  *cWallPanelDefaults;
        API_Guid                         *cWallPanelDefaultSymbs;
        API_CWJunctionType               *cWallJunctions;
        API_CWAccessoryType              *cWallAccessories;
        API_StairRiserType               *stairRisers;
        API_StairTreadType               *stairTreads;
        API_StairStructureType           *stairStructures;
        API_StairBoundaryData            stairBoundary[2];
        API_StairPolylineData            stairBaseLine;
        API_StairPolylineData            stairWalkingLine;
        API_RailingNodeType              *railingNodes;
        API_RailingSegmentType           *railingSegments;
        API_RailingPostType              *railingPosts;
        API_RailingRailEndType           *railingRailEnds;
        API_RailingRailConnectionType    *railingRailConnections;
        API_RailingRailEndType           *railingHandrailEnds;
        API_RailingRailConnectionType    *railingHandrailConnections;
        API_RailingRailEndType           *railingToprailEnds;
        API_RailingRailConnectionType    *railingToprailConnections;
        API_RailingRailType              *railingRails;
        API_RailingToprailType           *railingToprails;
        API_RailingHandrailType          *railingHandrails;
        API_RailingPatternType           *railingPatterns;
        API_RailingInnerPostType         *railingInnerPosts;
        API_RailingPanelType             *railingPanels;
        API_RailingBalusterSetType       *railingBalusterSets;
        API_RailingBalusterType          *railingBalusters;
        double                           **polyZCoords;
        API_RoofEdgeTypeID               *roofEdgeTypes;
        API_OverriddenAttribute          *sideMaterials;
        API_Coord                        **additionalPolyCoords;
        Int32                            **additionalPolyPends;
        API_PolyArc                      **additionalPolyParcs;
        UInt32                           **additionalPolyVertexIDs;
        UInt32                           **additionalPolyEdgeIDs;
        UInt32                           **additionalPolyContourIDs;
        API_PivotPolyEdgeData            *pivotPolyEdges;
        API_ShellShapeData               shellShapes[2];
        API_ShellContourData             *shellContours;
        Modeler::Body                    *morphBody;
        API_OverriddenAttribute          *morphMaterialMapTable;
        GS::UniString                    *elemInfoString;
        API_BeamSegmentType              *beamSegments;
        API_ColumnSegmentType            *columnSegments;
        API_AssemblySegmentCutData       *assemblySegmentCuts;
        API_AssemblySegmentSchemeData    *assemblySegmentSchemes;
        API_AssemblySegmentProfileData   *assemblySegmentProfiles;
        API_SurfaceLoadCustomData   		*surfaceLoadCustomData;
    } API_ElementMemo;

Members

coords: Coordinate array (used for polygons, spline coordinates, etc.).
pends: Polygon endpoints; see API_Polygon for more information.
parcs: Polygon arcs; see API_PolyArc and API_Polygon for more information.
vertexIDs: Unique identifiers the polygon vertices (unique inside the polygon).
edgeIDs: Unique identifiers the polygon edges (unique inside the polygon).
contourIDs: Unique identifiers the polygon contours (unique inside the polygon).
params: Additional parameters for library part-based elements.
gables: Parameters of the cutting planes the element has been cut with.
edgeTrims: Trim data of slab/roof/shell edges. (Formerly roofSides.)
meshPolyZ: Z coordinates of mesh polygon points.
meshLevelCoords: Mesh level line coordinates.
meshLevelEnds: Mesh level line endpoints.
dimElems: Dimension elements.
bezierDirs: Bezier-spline directions.
textContent: Text content for textual elements.
textLineStarts: Text line starts array (indices into the text content).
beamHoles: Beam hole information.
linkList: Camera link list.
pictHdl: Picture content.
paragraphs: Paragraph informations for text and label element.
drawingData: Internal format drawing data of an API_DrawingType element.
customOrigProfile: The original custom profile data applied to the wall, beam, or column element, in HGX::VectorImage format (see API_ProfileAttrType).
stretchedProfile: The stretched profile actually used by the wall, beam, or column element, in HGX::VectorImage format (see API_ProfileAttrType).
customParams: Reserved for internal use.
intElevSegments: Segments of an interior elevation.
sectionSegmentMainCoords: Coordinates of the section/elevation/interior elevation main line.
sectionSegmentDistCoords: Coordinates of the section/elevation/interior elevation marked distant area line.
sectionSegmentDepthCoords: Coordinates of the section/elevation/interior elevation depth line.
wallWindows: Guid list of Window elements in the specified Wall (output only).
For getting this information more effectively, you had better use the ACAPI_Element_GetConnectedElements function.
wallDoors: Guid list of Door elements in the specified Wall (output only).
For getting this information more effectively, you had better use the ACAPI_Element_GetConnectedElements function.
cWSegGridMesh: Curtain wall segment grid mesh.
cWSegContour: The contour of Curtain Wall segments.
cWSegPrimaryPattern: Curtain Wall primary segment pattern.
cWSegSecondaryPattern: Curtain Wall secondary segment pattern.
cWSegPatternCells: Curtain Wall segment pattern cells.
cWallSegments: Curtain Wall segments.
cWallFrames: Curtain Wall frame instances.
cWallFrameDefaults: Curtain Wall custom frame defaults (categories/classes).
cWallFrameDefaultSymbs: Curtain Wall frame default (category/class) symbols.
cWallPanels: Curtain Wall panel instances.
cWallPanelGridIDTable: This table contains the grid mesh identifiers for each Curtain Wall panel instance (these grid mesh cells are partly or fully covered by the panel).
typedef GS::HashTable<API_Guid, GS::Array<API_GridElemID>> API_CWPanelGridIDTable;
cWallPanelDefaults: Curtain Wall panel defaults (categories/classes).
cWallPanelDefaultSymbs: Curtain Wall panel default (category/class) symbols.
cWallJunctions: Curtain Wall junction instances.
cWallAccessories: Curtain Wall accessory instances.
stairRisers: Stair Riser subelements.
stairTreads: Stair Tread subelements.
stairStructures: Stair Structure subelements.
stairBoundary: Stair boundaries (index 0 is the left, and 1 is the right).
stairBaseLine: The base line of a Stair element.
stairWalkingLine: The walking line of a Stair element.
stairCustomWalkLine: The customized walking line of a Stair element.
stairCenterWalkLine: The default, centered walking line of a Stair element.
railingNodes: Railing Node subelements.
railingSegments: Railing Segment subelements.
railingPosts: Railing Post subelements.
railingRailEnds: Rail End subelements.
railingRailConnections: Rail Connection subelements.
railingHandrailEnds: Handrail End subelements. Only filled for Railing elements. If a Railing Node element is queried, these can be found inside the Element’s structure.
railingHandrailConnections: Handrail Connection subelements. Only filled for Railing elements. If a Railing Node element is queried, these can be found inside the Element’s structure.
railingToprailEnds: Toprail End subelements. Only filled for Railing elements. If a Railing Node element is queried, these can be found inside the Element’s structure.
railingToprailConnections: Toprail Connection subelements. Only filled for Railing elements. If a Railing Node element is queried, these can be found inside the Element’s structure.
railingRails: Rail subelements.
railingToprails: Toprail subelements.
railingHandrails: Handrail subelements.
railingPatterns: Railing Pattern subelements.
railingInnerPosts: Inner Post subelements.
railingBalusterSets: Baluster Set subelements.
railingBalusters: Baluster subelements.
polyZCoords: Array for the Z coordinates of a coordinate array.
roofEdgeTypes: Roof edge types.
sideMaterials: Roof / Slab side materials.
additionalPolyCoords: Coordinate array of the pivot polygon of a Multi-plane Roof element (see API_PolyRoofData) or the found polygon of the zone element. In case of zones, it can be nullptr if zone does not have found polygon. Also this is output only parameter for zones. Can be accessed with the APIMemoMask_AdditionalPolygon memo mask.
additionalPolyPends: Polygon endpoints of the pivot polygon of a Multi-plane Roof element (see API_PolyRoofData) or the found polygon of the zone element. Can be accessed with the APIMemoMask_AdditionalPolygon memo mask. See also API_Polygon for more information.
additionalPolyParcs: Polygon arcs of the pivot polygon of a Multi-plane Roof element (see API_PolyRoofData) or the found polygon of the zone element. Can be accessed with the APIMemoMask_AdditionalPolygon memo mask. See also API_PolyArc and API_Polygon for more information.
additionalPolyVertexIDs: Unique identifiers the polygon vertices of the pivot polygon of a Multi-plane Roof element (see API_PolyRoofData). Not used for zones. Can be accessed with the APIMemoMask_AdditionalPolygon memo mask.
additionalPolyEdgeIDs: Unique identifiers the polygon edges of the pivot polygon of a Multi-plane Roof element (see API_PolyRoofData). Not used for zones. Can be accessed with the APIMemoMask_AdditionalPolygon memo mask.
additionalPolyContourIDs: Unique identifiers the polygon contours of the pivot polygon of a Multi-plane Roof element (see API_PolyRoofData). Not used for zones. Can be accessed with the APIMemoMask_AdditionalPolygon memo mask.
pivotPolyEdges: Multi-plane roof specific data associated to the edges of the pivot polygon. They contain geometry (angle, eavesOverHang) and attribute (material etc.) data for each segment (see API_PivotPolyEdgeData). Can be accessed with the APIMemoMask_PivotPolygon memo mask.
shellShapes: Shell specific data to describe the profiles that form the shell shape. Extruded and revolved shells use the first (0-indexed) record only, ruled shells use both. This is a required parameter to pass when creating a new shell element.
shellContours: Shell specific data to define body contour and hole contours to the shell element. If hasContour is true, the first record contains the body contour data. If the shell has holes (numHoles > 0), the following items of the array describe the hole contours (the first hole contour is located in the second (1-indexed) record if there is a body contour given, otherwise it is in the first (0-indexed) record).
morphBody: Morph element.
morphMaterialMapTable: Morph element.
elemInfoString: Info string of the element.
beamSegments: Beam segments.
columnSegments: Column segments.
assemblySegmentCuts: Cuts of segments.
assemblySegmentSchemes: Segment schemes.
assemblySegmentProfiles: Segment profiles.
surfaceLoadCustomData: Custom Surface Load contour data.

Remarks

See ACAPI_Element_GetMemo to find out which element type needs/provides which information in the memo.

If you retrieve an array of vertices, edges or contours with ACAPI_Element_GetMemo, do not change the IDs in these arrays. New vertices, edges and contours should be inserted with ID = 0.

Requirements

Version: API 2.1 or later

Header: APIdefs_Elements.h

Members

Remarks

Requirements

See Also