Parameters & Globals
Process-global parameters (CAD_GL_*), current-drawing defaults and remaining getters/setters.
299 functions.
CadAccelSetDefaultAccel set default.
CadAccelSetKeyBinds a keyboard accelerator to a command id.
CadAddBoundaryVecad CadAddBoundary — boundary Polyline from existing objects that form an enclosed area around (X,Y).
CadAddBoundPolygonVecad CadAddBoundPolygon — same seed-point trace, closed as a filled polygon.
CadAddCustPropAdds a row to the custom-entity property table (call inside a CEntGetProps callback).
CadAddEdgeRegister hEnt as a cutting/boundary edge for the next Trim/Extend.
CadAddLayoutCreate (or fetch) a named paper-space layout; returns its 0-based index.
CadAddPageCreates a new page (layout) and returns its handle.
CadAddPntStyleCreates a new point style and returns its handle.
CadAddViewportAdd a viewport (a window on the sheet onto the engineering model) to a layout.
CadAddWTextCreates a new window-formatted text (WTEXT) entity and returns its handle.
CadAddWText2Creates a new window-formatted text (WTEXT) entity — 2 and returns its handle.
CadAddXLineCreates an infinite construction line (xline) through two points.
CadAddXrefAttaches an external-reference drawing (xref).
CadCboxCreateCreates a yucad-owned combo-box control (layer / colour / linetype selector) inside a host panel.
CadCboxSetActiveCbox set active.
CadCbPastePastes the clipboard content into the drawing at the given offset and selects the pasted entities.
CadClearVerticesEmpties the global vertex buffer (see CadAddVertex).
CadConvertAcadFileConvert one DXF file to another (read + write through the clean-room DXF I/O).
CadCoordDispToModelCoordinate disp to model.
CadCoordDispToWinCoordinate disp to win.
CadCoordModelToDispCoordinate model to disp.
CadCoordModelToWinCoordinate model to win.
CadCoordWinToDispCoordinate win to disp.
CadCoordWinToModelCoordinate win to model.
CadCountBlocksReturns the number of block definitions.
CadCountDimStylesReturns the number of dimension styles.
CadCountEntitiesTable counts (Vecad CadCount*).
CadCountLayersReturns the number of layers.
CadCountLinetypesReturns the number of linetypes.
CadCountMlineStylesReturns the number of multiline styles.
CadCountPagesReturns the number of page (layout)s.
CadCountPntStylesReturns the number of point styles.
CadCountTStylesReturns the number of text styles.
CadDeleteCadDelete destroys the whole VeCAD object (alias of CadDestroy, void).
CadDeleteBlockDeletes the block definition.
CadDeleteDimStyleDeletes the dimension style.
CadDeleteLayerTable deletions (Vecad CadDelete<Table>).
CadDeleteLinetypeDeletes the linetype.
CadDeleteMlineStyleDeletes the multiline style.
CadDeletePageDeletes the page (layout).
CadDeletePntStyleDeletes the point style.
CadDeleteTStyleDeletes the text style.
CadDialogOpenFileNative Qt open/save file dialogs; write the chosen UTF-8 path into szOut.
CadDialogSaveFileDialog save file.
CadDistModelToWinDistance conversions model<->window pixels via the view's zoom.
CadDistWinToModelDist win to model.
CadEngraveGenerates an engraving (fill-stroke) block from the selected entities.
CadExecuteVecad's universal command runner.
CadFontsListEnumerates the available fonts through the host callback.
CadFreeLibraryUnloads a plugin DLL loaded with CadLoadLibrary.
CadGetAngleUnitReturns the angle unit the ABI speaks (default: radians).
CadGetAutoSelReturns whether click-selection (auto-select) is enabled.
CadGetAutoSelRectGet auto sel rectangle.
CadGetBlockByIDReturns the by i d of the block definition.
CadGetBlockByNameReturns the by name of the block definition.
CadGetBrushReturns the current fill-brush handle.
CadGetCharQualityGet char quality.
CadGetCmdParamSizeless param channel (the ABI gives no byte count) — cannot copy safely.
CadGetCrossSizeReturns the crosshair size (percent of the window).
CadGetCurBlockGet current block.
CadGetCurColorCurrent entity colour (ACI) + lineweight applied to new entities.
CadGetCurDimStyleGet current dim style.
CadGetCurLayerGet current layer.
CadGetCurLinetypeGet current linetype.
CadGetCurLweightGet current lineweight.
CadGetCurMlineStyleGet current mline style.
CadGetCurPageGet current page.
CadGetCurPntStyleGet current point style.
CadGetCurTStyleGet current t style.
CadGetCurveQualityGet curve quality.
CadGetDefaultDirGet default direction.
CadGetDefaultFontGet default font.
CadGetDescrReturns the drawing's description string.
CadGetDescrLenGet description length.
CadGetDimStyleByIDReturns the by i d of the dimension style.
CadGetDimStyleByNameReturns the by name of the dimension style.
CadGetDirtyReturns whether the drawing has unsaved changes.
CadGetDistScalePer-document distance scale (Vecad CadGet/PutDistScale).
CadGetDrawCheckStepGet draw check step.
CadGetDrawOnlyCurLayerGet draw only current layer.
CadGetDwgVersionFormat-version getters (Vecad CadGetDwg/DxfVersion).
CadGetDxfDecPrecGet dxf dec prec.
CadGetDxfVersionGet dxf version.
CadGetEntitiesByPointReturns the by point of the entity.
CadGetEntitiesByRectReturns the by rectangle of the entity.
CadGetErrorReturns the last error code.
CadGetErrorStrCopies the text of the last error into the caller's buffer.
CadGetExDataReturns the drawing's application-data blob.
CadGetExDataPtrGet ex data ptr.
CadGetExDataSizeDocument-level extended-data blob.
CadGetExtentBottomGet extent bottom.
CadGetExtentLeftAliases (Left=Xmin, Right=Xmax, Bottom=Ymin, Top=Ymax).
CadGetExtentRectGet extent rectangle.
CadGetExtentRightGet extent right.
CadGetExtentTopReturns the top (maximum Y) of the drawing extents.
CadGetExtentXmaxGet extent xmax.
CadGetExtentXminGet extent xmin.
CadGetExtentYmaxGet extent ymax.
CadGetExtentYminGet extent ymin.
CadGetExtentZmaxGet extent zmax.
CadGetExtentZminGet extent zmin.
CadGetFileFilterGet file filter.
CadGetFileNameReturns the drawing's current file name.
CadGetGripColorGet grip colour.
CadGetGripSizeReturns the grip-box half-size in pixels.
CadGetImageBorderReturns the border of the raster image entity.
CadGetInterPointsGet inter points.
CadGetLayerByIDReturns the by i d of the layer.
CadGetLayerByNameReturns the by name of the layer.
CadGetLayerWndVisibleReturns the wnd visibility of the layer.
CadGetLayoutCountNumber of paper-space layouts (for building a Model | Layout… tab strip).
CadGetLayoutNameName of layout `idx` into szName (caller-allocated).
CadGetLicenseEditionRegistered edition (1 = Standard, 2 = Pro, 3 = Enterprise), or 0 if unregistered.
CadGetLicenseExpiryLicence expiry as YYYYMMDD (0 = perpetual / unregistered).
CadGetLicenseNameLicensee (company) name of the registered licence, into a caller buffer.
CadGetLinetypeByBlockReturns the by block of the linetype.
CadGetLinetypeByIDReturns the by i d of the linetype.
CadGetLinetypeByLayerReturns the by layer of the linetype.
CadGetLinetypeByNameReturns the by name of the linetype.
CadGetLinetypeContinuousReturns the continuous of the linetype.
CadGetLwDefaultReturns the default lineweight for new entities.
CadGetLwDisplayReturns whether lineweights are displayed.
CadGetLwScaleReturns the lineweight display scale.
CadGetMinCharFSizeGet min char f size.
CadGetMinCharSizeGet min char size.
CadGetMinEntSizeGet min ent size.
CadGetMiterLimitGet miter limit.
CadGetMlineStyleByIDReturns the by i d of the multiline style.
CadGetMlineStyleByNameReturns the by name of the multiline style.
CadGetOwnerReturns the host-defined owner value attached to the drawing.
CadGetPageByIDReturns the by i d of the page (layout).
CadGetPageByNameReturns the by name of the page (layout).
CadGetParamReturns a global engine parameter (CAD_GL_*).
CadGetPathFileNameCHM-documented name for the path-stripped filename — same as ShortFileName.
CadGetPenNo GDI pen/brush objects — drawing is OpenGL.
CadGetPickboxSizeGet pickbox size.
CadGetPickEntityVecad CadGetPickEntity — the entity under the cursor (last pick).
CadGetPntStyleByIDReturns the by i d of the point style.
CadGetPntStyleByNameReturns the by name of the point style.
CadGetPointModeDocument point display mode (PDMODE) + size (PDSIZE).
CadGetPointSizeReturns the size of the point.
CadGetReadOnlyReturns whether the drawing is read-only.
CadGetReturnVarReturns the numeric result variable of the last command (Vecad legacy; defaults to 0).
CadGetReturnXReturns the X coordinate of the last command's result point.
CadGetReturnYReturns the Y coordinate of the last command's result point.
CadGetReturnZReturns the Z coordinate of the last command's result point.
CadGetSelByLayerReturns the by layer of the selection set.
CadGetSelColorReturns the colour of the selection set.
CadGetSelInsideReturns the inside of the selection set.
CadGetSelLineReturns the line of the selection set.
CadGetSelShiftAddReturns the shift add of the selection set.
CadGetShortFileNameGet short file name.
CadGetShowCrossDisplay / selection scalar settings (process-global, no hDwg).
CadGetShowSysCursorGet show sys cursor.
CadGetTStyleByIDReturns the by i d of the text style.
CadGetTStyleByNameReturns the by name of the text style.
CadGetUnselAfterEditGet unsel after edit.
CadGetUseGripsReturns whether grip editing is enabled.
CadGetVBStringReturns the engine's string result (Visual Basic-safe accessor).
CadGetViewCoefsZoom/pan step coefficients used by the zoom/pan commands.
CadGetWinBottomReturns the bottom of the host window.
CadGetWindowThe CAD viewport's native window handle (HWND as void*).
CadGetWindowSizeReturns the size of the host window.
CadGetWinLeftReturns the left of the host window.
CadGetWinRectReturns the rectangle of the host window.
CadGetWinRightReturns the right of the host window.
CadGetWinTopReturns the top of the host window.
CadHelpSmall informational Qt windows.
CadInvalidateViewportMark a viewport's engineering content stale so the paper-space renderer re-asks the host on the next repaint.
CadIsRegisteredWhether a valid licence is currently registered.
CadLibraryBrowserCreateLibrary browser create.
CadLoadColorsLoads a colour palette from a file.
CadLoadLibraryLoads a host plugin DLL.
CadMagGetPosMag get position.
CadMagGetScaleReturns the magnifier window's zoom factor.
CadMagGetShowMagnifier loupe (process-global view widget settings, no hDwg).
CadMagGetSizeReturns the magnifier window's size.
CadMagPutPosMag put position.
CadMagPutScaleSets the magnifier window's zoom factor.
CadMagPutShowShows or hides the magnifier window.
CadMagPutSizeSets the magnifier window's size.
CadMenuAddCreates a new context menu and returns its handle.
CadMenuClearRemoves all content of the context menu.
CadPluginImageReadPlugin image read.
CadPluginsDlgShows the plugins dialog.
CadProfileGetNameProfile get name.
CadProfileLoadLoads a named settings profile (the global CAD_GL_* parameters).
CadProfileSaveProfiles persist as a small named marker file (yucad has no broad settings serialization yet — the named profile round-trips via a real file op).
CadPropWndCreateProperties window (Vecad "Properties" dock) — a live property grid for the current selection, embedded into the host panel like the layer tree.
CadPurgeVecad CadPurge — deletes entities / named objects by Mode (vecad CHM Funcs/CadPurge.htm).
CadPutDescrSets the drawing's description string.
CadPutDirtySets or clears the drawing's modified (unsaved-changes) flag.
CadPutDistScaleSets the distance scale factor applied by measurement functions.
CadPutDrawOnlyCurLayerPut draw only current layer.
CadPutExDataAttaches an application-data blob to the drawing.
CadPutFileNameSets the drawing's file name (used by subsequent saves).
CadPutLwDefaultSets the default lineweight for new entities.
CadPutLwDisplayShows or hides lineweight display.
CadPutLwScaleSets the lineweight display scale.
CadPutOwnerAttaches a host-defined owner value to the drawing.
CadPutPaintMarkLegacy paint-mark toggle (accepted for Vecad compatibility).
CadPutPointModeSets the mode of the point.
CadPutPointSizeSets the size of the point.
CadPutReadOnlyMarks the drawing read-only or writable.
CadRasterizeRasterize a WORLD region to an image at the given resolution.
CadRecentAddAdds a file to the most-recently-used list.
CadRecentDialog"Recent Files List" dialog (Vecad CadRecentDialog).
CadRecentLoadLoads the most-recently-used file list.
CadRecentSaveSaves the most-recently-used file list.
CadRegisterRegister the SDK licence.
CadRegistrationEnters the licence / registration key.
CadSaveColorsPersist / load the 256-entry palette as text (one decimal COLORREF per line).
CadSeekColorCadSeekColor is the same nearest-index search under its other Vecad name.
CadSetAngleUnitSets the angle unit used by all angle-taking / returning functions.
CadSetAutoSelEnables or disables click-selection (auto-select).
CadSetAutoSelRectSet auto sel rectangle.
CadSetBlinkTimeSets the blink interval for blinking entities, in milliseconds.
CadSetCharQualitySet char quality.
CadSetCrossSizeSets the crosshair size (percent of the window).
CadSetCurBlockSet current block.
CadSetCurColorSet current colour.
CadSetCurDimStyleSet current dim style.
CadSetCurDimStyleByIDSet current dim style by i d.
CadSetCurDimStyleByNameSet current dim style by name.
CadSetCurLayerSet current layer.
CadSetCurLayerByIDSet current layer by i d.
CadSetCurLayerByNameSet current layer by name.
CadSetCurLinetypeSet current linetype.
CadSetCurLinetypeByIDSet current linetype by i d.
CadSetCurLinetypeByNameSet current linetype by name.
CadSetCurLweightSet current lineweight.
CadSetCurMlineStyleSet current mline style.
CadSetCurMlineStyleByIDSet current mline style by i d.
CadSetCurMlineStyleByNameSet current mline style by name.
CadSetCurPageSet current page.
CadSetCurPageByIDSet current page by i d.
CadSetCurPageByNameSet current page by name.
CadSetCurPntStyleSet current point style.
CadSetCurPntStyleByIDSet current point style by i d.
CadSetCurPntStyleByNameSet current point style by name.
CadSetCurTStyleSet the active text style — new TEXT / MTEXT seed from it.
CadSetCurTStyleByIDSet current t style by i d.
CadSetCurTStyleByNameSet current t style by name.
CadSetCurveQualitySet curve quality.
CadSetCustPropUpdates the value of a custom-entity property row.
CadSetCustPropModeSets a custom-entity property row read-only or editable.
CadSetDefaultDirSet default direction.
CadSetDefaultFontSet default font.
CadSetDrawCheckStepSet draw check step.
CadSetDwgVersionSet dwg version.
CadSetDxfDecPrecSet dxf dec prec.
CadSetDxfVersionSet dxf version.
CadSetFileFilterSet file filter.
CadSetGripColorSet grip colour.
CadSetGripSizeSets the grip-box half-size in pixels.
CadSetImageBorderSets the border of the raster image entity.
CadSetMinCharFSizeSet min char f size.
CadSetMinCharSizeSet min char size.
CadSetMinEntSizeSet min ent size.
CadSetMiterLimitSet miter limit.
CadSetMsgTitleMessage-box title, blink interval, current profile name (process-global).
CadSetOffsetDistanceSet offset distance.
CadSetParamSets a global engine parameter (CAD_GL_*) and returns the previous value.
CadSetPickboxSizeSet pickbox size.
CadSetPlineMarkVecad CadSetPlineMark — a temporary GIS highlight drawn ALONG hEnt's contour from `Start` for `Len` drawing units (Len==0 => a point marker).
CadSetPolygonSidesSet polygon sides.
CadSetReturnDblSets the numeric result a host callback hands back to the engine.
CadSetReturnIntSets the integer result a host callback hands back to the engine.
CadSetReturnStrSets the string result a host callback hands back to the engine.
CadSetSelByLayerSets the by layer of the selection set.
CadSetSelColorSets the colour of the selection set.
CadSetSelInsideSets the inside of the selection set.
CadSetSelLineSets the line of the selection set.
CadSetSelShiftAddSets the shift add of the selection set.
CadSetShowCrossShows or hides the crosshair cursor.
CadSetShowSysCursorSet show sys cursor.
CadSetSpaceSwitch the live view's drawing space: -1 = model, >= 0 = a paper-space layout (Model / Layout tabs).
CadSetStringString table by id (CadSetString sets; CadGetVBString reads into a buffer).
CadSetSystemCursorSet system cursor.
CadSetTextAlignSets the align of the text entity.
CadSetTextBackwardCurrent-text flags for new TEXT (return the previous value).
CadSetTextHeightSets the height of the text entity.
CadSetTextObliqueSets the oblique of the text entity.
CadSetTextRotAngleSets the rotation angle of the text entity.
CadSetTextUpsideDownSets the upside down of the text entity.
CadSetTextWidthSets the width of the text entity.
CadSetUnselAfterEditSet unsel after edit.
CadSetUseGripsEnables or disables grip editing.
CadSetViewCoefsSets the coefs of the view.
CadSHX2YUCFConverts an SHX font file to yucad's native .yucf font format (offline content tool).
CadTipOfTheDayShows the tip-of-the-day window.
CadTTF2YUCFConverts a TrueType font to yucad's native .yucf font format (offline content tool).
CadUndoOffEnters bulk-load mode: turns off undo recording and drops the current history.
CadUndoOnLeaves bulk-load mode: restores normal undo recording and fires one full repaint of every view.
CadXrefGetPathReturns the file path of the external reference.
CadXrefGetStatusXref get status.
CadXrefPutPathSets the file path of the external reference.
CadXrefReloadLoad (or refresh) the external drawing into the xref block's entities.