Entities — General
Functions common to every entity: enumeration, shared attributes (layer, colour, linetype, lineweight), transforms and editing.
103 functions.
CadEntityCopyCreates a copy of the entity, offset by the given delta.
CadEntityEraseErases the entity from the drawing.
CadEntityExplodeExplodes the entity into its primitive components.
CadEntityExtendExtend target hEnt to the nearest boundary edge; the end nearest (x,y) is the one that grows.
CadEntityGetBlinkReturns the blink of the entity.
CadEntityGetBordColorReturns the bord colour of the entity.
CadEntityGetBorderReturns the border of the entity.
CadEntityGetBottomReturns the bottom of the entity.
CadEntityGetColorReturns the colour of the entity.
CadEntityGetDeletedReturns the deleted of the entity.
CadEntityGetExDataReturns the ex data of the entity.
CadEntityGetExDataPtr64-bit ABI: a raw in-place pointer cannot be expressed as a 32-bit VHANDLE without truncation, so the fast-pointer accessor is unsupported here — use the safe Get/PutExData copy path instead.
CadEntityGetExDataSizeReturns the ex data size of the entity.
CadEntityGetFilledReturns the filled of the entity.
CadEntityGetGripReturns the grip of the entity.
CadEntityGetIDReturns the i d of the entity.
CadEntityGetLayerIDReturns the layer i d of the entity.
CadEntityGetLeftReturns the left of the entity.
CadEntityGetLinetypeIDPer-entity linetype (enum <-> api_linetype handle).
CadEntityGetLineweightReturns the lineweight of the entity.
CadEntityGetLockedReturns the locked of the entity.
CadEntityGetLtScaleReturns the lt scale of the entity.
CadEntityGetNumPathsReturns the number of paths of the entity.
CadEntityGetPageIDReturns the page i d of the entity.
CadEntityGetParkDataReturns the park data of the entity.
CadEntityGetPathSizeReturns the path size of the entity.
CadEntityGetRightReturns the right of the entity.
CadEntityGetSelectedReturns the selected of the entity.
CadEntityGetTopReturns the top of the entity.
CadEntityGetTypeReturns the type of the entity.
CadEntityGetUserDataReturns the user data of the entity.
CadEntityGetVerReturns the vertex of the entity.
CadEntityGetVisibleReturns the visibility of the entity.
CadEntityMirrorMirrors the entity across the axis through the two points.
CadEntityMoveMoves the entity by the given delta.
CadEntityMoveGripMoves one grip point of the entity (grip editing).
CadEntityPutBlinkSets the blink of the entity.
CadEntityPutBordColorSets the bord colour of the entity.
CadEntityPutBorderSets the border of the entity.
CadEntityPutColorSets the colour of the entity.
CadEntityPutExDataSets the ex data of the entity.
CadEntityPutFilledSets the filled of the entity.
CadEntityPutLayerIDSets the layer i d of the entity.
CadEntityPutLinetypeIDSets the linetype i d of the entity.
CadEntityPutLineweightSets the lineweight of the entity.
CadEntityPutLockedSets the locked of the entity.
CadEntityPutLtScaleSets the lt scale of the entity.
CadEntityPutPageIDSets the page i d of the entity.
CadEntityPutParkDataSets the park data of the entity.
CadEntityPutUserDataSets the user data of the entity.
CadEntityPutVisibleSets the visibility of the entity.
CadEntityRotateRotates the entity around the given centre.
CadEntityScaleScales the entity around the given centre.
CadEntitySwapSwaps the database (draw) order of two entities.
CadEntityToBottomSends the entity to the bottom of the draw order.
CadEntityToTopDraw order (z-order).
CadEntityTrimTrim target hEnt at the cutting edge(s); the clicked side (x,y) is removed (AutoCAD parity, trim_math.md §6).
CadGetEntityByCursorReturns the by cursor of the entity.
CadGetEntityByIDReturns the by i d of the entity.
CadGetEntityByPointReturns the by point of the entity.
CadGetEntityByPointInReturns the by point in of the entity.
CadGetEntityByPtrhPtr is already an entity handle in yucad's addressing — validate + echo it.
CadGetEntityByUserDataReturns the by user data of the entity.
CadGetEntityCountReturns the count of the entity.
CadGetFirstBlockReturns the first block definition for enumeration (see the matching GetNext).
CadGetFirstDimStyleReturns the first dimension style for enumeration (see the matching GetNext).
CadGetFirstEntityCadGetEntityByPoint / CadGetEntityByCursor are screen-space picks that need the view transform — implemented in api_window.cpp (has the view).
CadGetFirstLayerReturns the first layer for enumeration (see the matching GetNext).
CadGetFirstLinetypeLinetype table navigation (handle = index+1).
CadGetFirstMlineStyleReturns the first multiline style for enumeration (see the matching GetNext).
CadGetFirstPageReturns the first page (layout) for enumeration (see the matching GetNext).
CadGetFirstPntStyleReturns the first point style for enumeration (see the matching GetNext).
CadGetFirstTStyleReturns the first text style for enumeration (see the matching GetNext).
CadGetNextBlockReturns the block definition following the given one during enumeration.
CadGetNextDimStyleReturns the dimension style following the given one during enumeration.
CadGetNextEntityReturns the entity following the given one during enumeration.
CadGetNextLayerReturns the layer following the given one during enumeration.
CadGetNextLinetypeReturns the linetype following the given one during enumeration.
CadGetNextMlineStyleReturns the multiline style following the given one during enumeration.
CadGetNextPageReturns the page (layout) following the given one during enumeration.
CadGetNextPntStyleReturns the point style following the given one during enumeration.
CadGetNextTStyleReturns the text style following the given one during enumeration.
CadSelClearRemoves all content of the selection set.
CadSelColorSets the highlight colour used for selected entities.
CadSelCopyCreates a copy of every entity in the selection set, offset by the given delta.
CadSelCountReturns the number of selection sets.
CadSelDrawCadRecentDialog is implemented in api_window.cpp (it owns the Qt dialog).
CadSelectByDistSelects entities within a distance of a point.
CadSelectByLayerSelects every entity on the given layer.
CadSelectByPageSelect every model-space entity tagged with this page id (CadEntityPutPageID).
CadSelectByPolygonSelect/unselect entities inside the polygon defined by hEnt (a Polyline).
CadSelectByPolylineSelect/unselect entities crossed by the polyline hEnt.
CadSelectEntityAdds the entity to the selection set.
CadSelEraseErases every entity in the selection set from the drawing.
CadSelExplodeExplodes every entity in the selection set into its primitive components.
CadSelGetFirstPtrReturns the first selection set ptr for enumeration (see the matching GetNext).
CadSelGetNextPtrReturns the selection set ptr following the given one during enumeration.
CadSelJoinJoin the selected Line/Arc/Polyline entities into one polyline by endpoint proximity (join_polyline.md); erases the consumed sources; returns the new polyline handle.
CadSelMakeGripsShows grips on every entity in the selection set.
CadSelMirrorMirrors every entity in the selection set across the axis through the two points.
CadSelMoveMoves every entity in the selection set by the given delta.
CadSelRotateRotates every entity in the selection set around the given centre.
CadSelScaleScales every entity in the selection set around the given centre.