Archicad 27 C++ API
|
Functions related the the server application and various project-related events, such as saving or publishing the project. More...
Classes | |
struct | API_NewProjectPars |
Parameters to open a new project. More... | |
struct | API_FileOpenPars |
Parameters to open a new project file. More... | |
struct | API_SavePars_Archive |
Parameters to save the current project as archive file. More... | |
struct | API_SavePars_PlanDump |
Contains the different options for saving a plan dump from Archicad. More... | |
struct | API_SavePars_Object |
Contains the different options for saving an Archicad object, lamp, door, or window. More... | |
struct | API_SavePars_Picture |
Contains the different options for saving pictures from Archicad. More... | |
struct | API_IFCTranslatorIdentifier |
IFC Translator Identifier. More... | |
struct | API_SavePars_Ifc |
Parameters to save the current project as an Ifc file. More... | |
struct | API_SavePars_Pdf |
Contains the different page options for saving to pdf file. More... | |
struct | API_SavePars_Saf |
Contains the export filter type for the SAF file. More... | |
struct | API_FileSavePars |
Parameters to save the current project file. More... | |
struct | API_PrintStampType |
Printing header/footer parameters. More... | |
struct | API_PrintPars |
Printing parameters. More... | |
struct | API_PublishPars |
Publishing parameters. More... | |
struct | API_ProjectInfo |
Contains information about the current project. More... | |
struct | API_UserInfo |
Information on a registered Team Member. More... | |
struct | API_SharingInfo |
Project sharing parameters. More... | |
struct | API_MiscAppInfo |
Miscellaneous information of the application. More... | |
struct | API_MiscPrinterInfo |
Miscellaneous information of the selected printer. More... | |
struct | API_MiscPlotterInfo |
Miscellaneous information of the selected plotter. More... | |
Typedefs | |
typedef GSErrCode __ACENV_CALL | APIProjectEventHandlerProc(API_NotifyEventID notifID, Int32 param) |
Callback function to receive notifications on changes of the project. | |
Enumerations | |
enum | API_FTypeID { APIFType_None , APIFType_PlanFile , APIFType_A_PlanFile , APIFType_Bak_PlanFile , APIFType_PlanFile600 , APIFType_A_PlanFile600 , APIFType_PlanFile650 , APIFType_A_PlanFile650 , APIFType_PlanFile700 , APIFType_A_PlanFile700 , APIFType_TabListFile , APIFType_ObjectFile , APIFType_DoorFile , APIFType_WindowFile , APIFType_GDLFile , APIFType_2DLinesFile , APIFType_PNGFile , APIFType_BMPFile , APIFType_TIFFFile , APIFType_JPEGFile , APIFType_GIFFile , APIFType_EMFFile , APIFType_WMFFile , APIFType_PlanFile800 , APIFType_A_PlanFile800 , APIFType_PlanFile810 , APIFType_A_PlanFile810 , APIFType_PlanFile900 , APIFType_A_PlanFile900 , APIFType_PlanFile1000 , APIFType_A_PlanFile1000 , APIFType_PlanFile1100 , APIFType_A_PlanFile1100 , APIFType_PlanFile1200 , APIFType_A_PlanFile1200 , APIFType_IfcFile , APIFType_PlanFile1300 , APIFType_A_PlanFile1300 , APIFType_PlanFile1400 , APIFType_A_PlanFile1400 , APIFType_PlanFile1500 , APIFType_A_PlanFile1500 , APIFType_PlanFile1600 , APIFType_A_PlanFile1600 , APIFType_PlanFile1700 , APIFType_A_PlanFile1700 , APIFType_PlanFile1800 , APIFType_A_PlanFile1800 , APIFType_PdfFile , APIFType_PlanFile1900 , APIFType_A_PlanFile1900 , APIFType_PlanFile2000 , APIFType_A_PlanFile2000 , APIFType_PlanFile2100 , APIFType_A_PlanFile2100 , APIFType_PlanFile2200 , APIFType_A_PlanFile2200 , APIFType_PlanFile2300 , APIFType_A_PlanFile2300 , APIFType_PlanFile2400 , APIFType_A_PlanFile2400 , APIFType_PlanFile2500 , APIFType_A_PlanFile2500 , APIFType_PlanFile2600 , APIFType_A_PlanFile2600 , APIFType_SafFile } |
Available file format identifiers for automated functions. More... | |
enum | API_ConvModID { APIConvMod_TextGDL , APIConvMod_MemGDL , APIConvMod_SymTxtGDL , APIConvMod_SymBinGDL , APIConvMod_SideGDL , APIConvMod_DragGDL } |
Represents the type of the Archicad object to be saved. More... | |
enum | API_IfcTypeID { API_IFC , API_IFCZIP } |
Defines type of file format for IFC Export. More... | |
enum | API_ElementsToIfcExportID { API_EntireProject = 1 , API_VisibleElementsOnAllStories , API_AllElementsOnCurrentStorey , API_VisibleElementsOnCurrentStorey , API_SelectedElementsOnly , API_FilteredElements } |
Selected elements for IFC export. More... | |
enum | API_ElementsToSAFExportID { API_SAFSelectedElementsOnly = 1 , API_SAFEntireProject , API_SAFVisibleElements } |
Selected elements for SAF export. More... | |
enum | API_NotifyEventID { APINotify_New = 0x00000001 , APINotify_NewAndReset = 0x00000002 , APINotify_Open = 0x00000004 , APINotify_PreSave = 0x00000008 , APINotify_Save = 0x00000010 , APINotify_Close = 0x00000020 , APINotify_Quit = 0x00000040 , APINotify_TempSave = 0x00000080 , APINotify_SendChanges = 0x00008000 , APINotify_ReceiveChanges = 0x00010000 , APINotify_ChangeProjectDB = 0x00040000 , APINotify_ChangeWindow = 0x00080000 , APINotify_ChangeFloor = 0x00100000 , APINotify_ChangeLibrary = 0x00200000 , APINotify_AllInputFinished = 0x00400000 , APINotify_UnitChanged = 0x00800000 , APINotify_SideviewCreated = 0x01000000 , APINotify_SideviewRebuilt = 0x02000000 , APINotify_PropertyVisibilityChanged = 0x04000000 , APINotify_ClassificationVisibilityChanged = 0x08000000 , APINotify_ShowIn3DChanged = 0x10000000 } |
Possible values for notifications on project events. More... | |
enum | API_NotifyViewEventID { APINotifyView_Inserted = 0x00000001 , APINotifyView_Modified = 0x00000002 , APINotifyView_Deleted = 0x00000004 , APINotifyView_Opened = 0x00000008 , APINotifyView_Begin = 0x00000010 , APINotifyView_End = 0x00000020 } |
Possible values for notifications on Project Navigator events. More... | |
Functions | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_NewProject (const API_NewProjectPars *newProjectPars) |
Opens a new plan. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Open (const API_FileOpenPars *fileOpenPars) |
Opens a new project file. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Close (const Int32 magicCode=0) |
Closes the current project window. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Save () |
Saves the content of the current window in different file formats. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Save (const API_FileSavePars *fileSavePars) |
Saves the content of the current window in different file formats. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Save (const API_FileSavePars *fileSavePars, const API_SavePars_Archive *formatPars) |
Saves the content of the current window in different file formats. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Save (const API_FileSavePars *fileSavePars, const API_SavePars_PlanDump *formatPars) |
Saves the content of the current window in different file formats. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Save (const API_FileSavePars *fileSavePars, const API_SavePars_Object *formatPars) |
Saves the content of the current window in different file formats. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Save (const API_FileSavePars *fileSavePars, const API_SavePars_Picture *formatPars) |
Saves the content of the current window in different file formats. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Save (const API_FileSavePars *fileSavePars, const API_SavePars_Ifc *formatPars, API_IFCRelationshipData *resultData=nullptr) |
Saves the content of the current window in different file formats. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Save (const API_FileSavePars *fileSavePars, const API_SavePars_Pdf *formatPars) |
Saves the content of the current window in different file formats. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Save (const API_FileSavePars *fileSavePars, const API_SavePars_Saf *formatPars) |
Saves the content of the current window in different file formats. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_ReloadLibraries () |
Resets and loads the active libraries. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Print (const API_PrintPars *printPars=nullptr) |
Prints the content of the current window. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Quit (Int32 magicCode) |
Terminates the server application. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_SaveAsModuleFile (const IO::Location *location, GS::Array< API_Elem_Head > *elemHead=nullptr) |
Saves the selected elements into a module file. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Publish (const API_PublishPars *publishPars, const GS::Array< API_Guid > *selectedLinks=nullptr) |
Publishes a publisher set. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_Project (API_ProjectInfo *projectInfo) |
Returns information on the current project file. | |
GSErrCode __ACENV_CALL | ACAPI_Teamwork_ProjectSharing (API_SharingInfo *sharingInfo) |
Returns the project sharing data in the case of a TeamWork project. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_GetMiscAppInfo (API_MiscAppInfo *miscAppInfo) |
Gets miscellaneous information about application. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_GetMiscPrinterInfo (API_MiscPrinterInfo *miscPrinterInfo) |
Gets miscellaneous information about current printer. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_GetMiscPlotterInfo (API_MiscPlotterInfo *miscPlotterInfo) |
Gets miscellaneous information about plotter. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_GetPrinterPars (API_PrintPars *printPars) |
Retrieves the current printer settings. | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_AdditionalFileWasCreated (const IO::Location &path) |
Informs Archicad about the additionally created file during exporting or publishing. Required for handling them with the target file. (E.g. uploading to BIMcloud together.) | |
GSErrCode __ACENV_CALL | ACAPI_ProjectOperation_CatchProjectEvent (GSFlags eventTypes, APIProjectEventHandlerProc *handlerProc) |
Register or unregister your add-on to be notified of application and project events. | |
Functions related the the server application and various project-related events, such as saving or publishing the project.
typedef GSErrCode __ACENV_CALL APIProjectEventHandlerProc(API_NotifyEventID notifID, Int32 param) |
Callback function to receive notifications on changes of the project.
notifID | [in] The type of the project event the notification is for. |
param | [in] This parameter is valid only if the notifID is APINotify_ChangeLibrary . If an individual library part has changed in the library (e.g. it was added to the library), then this parameter contains the index of that library part. This parameter is also valid if notifID is APINotify_ChangeProjectDB , and contains a code for the cause of the event. |
param | Event cause |
---|---|
0 | Other |
1 | Floor(s) edited |
2 | Merge |
enum API_ConvModID |
Represents the type of the Archicad object to be saved.
Selected elements for IFC export.
enum API_FTypeID |
Available file format identifiers for automated functions.
enum API_IfcTypeID |
Defines type of file format for IFC Export.
enum API_NotifyEventID |
Possible values for notifications on project events.
Possible values for notifications on Project Navigator events.
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_AdditionalFileWasCreated | ( | const IO::Location & | path | ) |
Informs Archicad about the additionally created file during exporting or publishing. Required for handling them with the target file. (E.g. uploading to BIMcloud together.)
path | [in] The path to the created file. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_CatchProjectEvent | ( | GSFlags | eventTypes, |
APIProjectEventHandlerProc * | handlerProc | ||
) |
Register or unregister your add-on to be notified of application and project events.
eventTypes | [in] A combination of different API_NotifyEventID values, specifying the types of project events you are interested in. |
handlerProc | [in] The callback procedure to call when notifications are sent out on different project events. Specifying nullptr here means you don't need the notifications any more. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Close | ( | const Int32 | magicCode = 0 | ) |
Closes the current project window.
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_GetMiscAppInfo | ( | API_MiscAppInfo * | miscAppInfo | ) |
Gets miscellaneous information about application.
miscAppInfo | [out] Miscellaneous information of the application |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_GetMiscPlotterInfo | ( | API_MiscPlotterInfo * | miscPlotterInfo | ) |
Gets miscellaneous information about plotter.
miscPlotterInfo | [out] Miscellaneous information of the selected plotter |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_GetMiscPrinterInfo | ( | API_MiscPrinterInfo * | miscPrinterInfo | ) |
Gets miscellaneous information about current printer.
miscPrinterInfo | [out] Miscellaneous information of the selected printer |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_GetPrinterPars | ( | API_PrintPars * | printPars | ) |
Retrieves the current printer settings.
printPars | [out] the printing parameters |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_NewProject | ( | const API_NewProjectPars * | newProjectPars | ) |
Opens a new plan.
newProjectPars | [in] Parameters for opening a new project. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Open | ( | const API_FileOpenPars * | fileOpenPars | ) |
Opens a new project file.
fileOpenPars | [in] Parameters for opening a project file. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Print | ( | const API_PrintPars * | printPars = nullptr | ) |
Prints the content of the current window.
printPars | [in] Control parameters; optional, if missing, the current defaults will be used |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Project | ( | API_ProjectInfo * | projectInfo | ) |
Returns information on the current project file.
projectInfo | [out] Project file and teamwork project specific data. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Publish | ( | const API_PublishPars * | publishPars, |
const GS::Array< API_Guid > * | selectedLinks = nullptr |
||
) |
Publishes a publisher set.
publishPars | [in] Control parameters; the guid member identifies the set to be published. |
selectedLinks | [in] Optional parameter; publish only these items. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Quit | ( | Int32 | magicCode | ) |
Terminates the server application.
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_ReloadLibraries | ( | ) |
Resets and loads the active libraries.
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Save | ( | ) |
Saves the content of the current window in different file formats.
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Save | ( | const API_FileSavePars * | fileSavePars | ) |
Saves the content of the current window in different file formats.
fileSavePars | [in] Parameters of the saved file; optional, if not passed default settings will be used |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Save | ( | const API_FileSavePars * | fileSavePars, |
const API_SavePars_Archive * | formatPars | ||
) |
Saves the content of the current window in different file formats.
fileSavePars | [in] Parameters of the saved file; optional, if not passed default settings will be used |
formatPars | [in] Parameters of the requested format. It can be either API_SavePars_Archive, API_SavePars_Ifc, API_SavePars_Plandump , API_SavePars_Object, API_SavePars_Picture, API_SavePars_Pdf or an API_SavePars_Saf record. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Save | ( | const API_FileSavePars * | fileSavePars, |
const API_SavePars_Ifc * | formatPars, | ||
API_IFCRelationshipData * | resultData = nullptr |
||
) |
Saves the content of the current window in different file formats.
fileSavePars | [in] Parameters of the saved file; optional, if not passed default settings will be used |
formatPars | [in] Parameters of the requested format. It can be either API_SavePars_Archive, API_SavePars_Ifc, API_SavePars_Plandump , API_SavePars_Object, API_SavePars_Picture, API_SavePars_Pdf or an API_SavePars_Saf record. |
resultData | [out] Parameter for output data. Optionally it can be an API_IFCRelationshipData pointer while saving IFC. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Save | ( | const API_FileSavePars * | fileSavePars, |
const API_SavePars_Object * | formatPars | ||
) |
Saves the content of the current window in different file formats.
fileSavePars | [in] Parameters of the saved file; optional, if not passed default settings will be used |
formatPars | [in] Parameters of the requested format. It can be either API_SavePars_Archive, API_SavePars_Ifc, API_SavePars_Plandump , API_SavePars_Object, API_SavePars_Picture, API_SavePars_Pdf or an API_SavePars_Saf record. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Save | ( | const API_FileSavePars * | fileSavePars, |
const API_SavePars_Pdf * | formatPars | ||
) |
Saves the content of the current window in different file formats.
fileSavePars | [in] Parameters of the saved file; optional, if not passed default settings will be used |
formatPars | [in] Parameters of the requested format. It can be either API_SavePars_Archive, API_SavePars_Ifc, API_SavePars_Plandump , API_SavePars_Object, API_SavePars_Picture, API_SavePars_Pdf or an API_SavePars_Saf record. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Save | ( | const API_FileSavePars * | fileSavePars, |
const API_SavePars_Picture * | formatPars | ||
) |
Saves the content of the current window in different file formats.
fileSavePars | [in] Parameters of the saved file; optional, if not passed default settings will be used |
formatPars | [in] Parameters of the requested format. It can be either API_SavePars_Archive, API_SavePars_Ifc, API_SavePars_Plandump , API_SavePars_Object, API_SavePars_Picture, API_SavePars_Pdf or an API_SavePars_Saf record. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Save | ( | const API_FileSavePars * | fileSavePars, |
const API_SavePars_PlanDump * | formatPars | ||
) |
Saves the content of the current window in different file formats.
fileSavePars | [in] Parameters of the saved file; optional, if not passed default settings will be used |
formatPars | [in] Parameters of the requested format. It can be either API_SavePars_Archive, API_SavePars_Ifc, API_SavePars_Plandump , API_SavePars_Object, API_SavePars_Picture, API_SavePars_Pdf or an API_SavePars_Saf record. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_Save | ( | const API_FileSavePars * | fileSavePars, |
const API_SavePars_Saf * | formatPars | ||
) |
Saves the content of the current window in different file formats.
fileSavePars | [in] Parameters of the saved file; optional, if not passed default settings will be used |
formatPars | [in] Parameters of the requested format. It can be either API_SavePars_Archive, API_SavePars_Ifc, API_SavePars_Plandump , API_SavePars_Object, API_SavePars_Picture, API_SavePars_Pdf or an API_SavePars_Saf record. |
GSErrCode __ACENV_CALL ACAPI_ProjectOperation_SaveAsModuleFile | ( | const IO::Location * | location, |
GS::Array< API_Elem_Head > * | elemHead = nullptr |
||
) |
Saves the selected elements into a module file.
location | [in] Specifies the module file to be saved |
elemHead | [in] Elements to save into the module. Optional parameter, can be nullptr - in this case the current selection is saved |
GSErrCode __ACENV_CALL ACAPI_Teamwork_ProjectSharing | ( | API_SharingInfo * | sharingInfo | ) |
Returns the project sharing data in the case of a TeamWork project.
sharingInfo | data of the registered members of the team project |