Archicad 27 C++ API
|
Functions exposing the Issue management and BCF import-export functionalities. More...
Classes | |
struct | API_MarkUpType |
Represents a Mark-Up entry. More... | |
struct | API_MarkUpCommentType |
Represents a comment attached to a Mark-Up entry. More... | |
Enumerations | |
enum | API_MarkUpCommentStatusID { APIComment_Error = 0 , APIComment_Warning , APIComment_Info , APIComment_Unknown } |
Describes the various options for Mark-Up comment status. More... | |
enum | API_MarkUpComponentTypeID { APIMarkUpComponent_Creation = 0 , APIMarkUpComponent_Highlight , APIMarkUpComponent_Deletion , APIMarkUpComponent_Modification } |
Describes the type of a component attached to a Mark-Up entry. More... | |
Functions | |
GSErrCode __ACENV_CALL | ACAPI_Markup_Create (API_MarkUpType &markUp) |
Creates new Mark-Up entry. | |
GSErrCode __ACENV_CALL | ACAPI_Markup_GetList (const API_Guid &elemGuid, GS::Array< API_MarkUpType > *markUpList, bool *asCorrected=nullptr) |
Returns the existing Mark-Up entries which the given element is attached to. | |
GSErrCode __ACENV_CALL | ACAPI_Markup_Delete (const API_Guid &markUpGuid, bool acceptAllElements=false) |
Deletes an existing Issue. | |
GSErrCode __ACENV_CALL | ACAPI_Markup_AttachElements (const API_Guid &markUpGuid, const GS::Array< API_Guid > &elemList, API_MarkUpComponentTypeID type, GS::HashTable< API_Guid, API_Guid > *modificationElemTable=nullptr) |
Attach elements to an existing Mark-Up as corrected or highlighted elements. | |
GSErrCode __ACENV_CALL | ACAPI_Markup_DetachElements (const API_Guid &markUpGuid, const GS::Array< API_Guid > &elemList) |
Detach elements from an existing Mark-Up. | |
GSErrCode __ACENV_CALL | ACAPI_Markup_GetAttachedElements (const API_Guid &markUpGuid, API_MarkUpComponentTypeID type, GS::Array< API_Guid > &attachedElements) |
Returns the corrected and highlighted elements of the given Mark-Up. | |
GSErrCode __ACENV_CALL | ACAPI_Markup_AddComment (const API_Guid &markUpGuid, API_MarkUpCommentType &comment) |
Adds a new comment to the given Mark-Up. | |
GSErrCode __ACENV_CALL | ACAPI_Markup_GetComments (const API_Guid &markUpGuid, GS::Array< API_MarkUpCommentType > *commentList) |
Returns the comments attached to the given Mark-Up entry. | |
GSErrCode __ACENV_CALL | ACAPI_Markup_ExportToBCF (const IO::Location &fileLoc, const GS::Array< API_Guid > &markupEntryIds, const bool useExternalId=false, const bool alignBySurveyPoint=true) |
Exports a BCF file to specified location. | |
GSErrCode __ACENV_CALL | ACAPI_Markup_ImportFromBCF (const IO::Location &fileLoc, const bool silentMode, APIIFCRelationshipDataProc *ifcRelationshipDataProc, const void *par1, const bool openMarkUpPalette=false, const bool alignBySurveyPoint=true) |
Imports a BCF file. | |
Functions exposing the Issue management and BCF import-export functionalities.
Describes the various options for Mark-Up comment status.
Describes the type of a component attached to a Mark-Up entry.
GSErrCode __ACENV_CALL ACAPI_Markup_AddComment | ( | const API_Guid & | markUpGuid, |
API_MarkUpCommentType & | comment | ||
) |
Adds a new comment to the given Mark-Up.
markUpGuid | [in] GUID of the existing Mark-Up. |
comment | [in/out] The parameters of the new comment. The guid and creaTime will be filled by this function. |
GSErrCode __ACENV_CALL ACAPI_Markup_AttachElements | ( | const API_Guid & | markUpGuid, |
const GS::Array< API_Guid > & | elemList, | ||
API_MarkUpComponentTypeID | type, | ||
GS::HashTable< API_Guid, API_Guid > * | modificationElemTable = nullptr |
||
) |
Attach elements to an existing Mark-Up as corrected or highlighted elements.
markUpGuid | [in] GUID of the existing Mark-Up. |
elemList | [in] The list of elements to attach. |
type | [in] Attach the elements with the given Component type. |
modificationElemTable | [in/out] Optional parameter, used only when APIMarkUpComponent_Modification is passed in type parameter. The table of the original and the modified element pairs. |
GSErrCode __ACENV_CALL ACAPI_Markup_Create | ( | API_MarkUpType & | markUp | ) |
Creates new Mark-Up entry.
markUp | [in/out] The parameters of the new Mark-Up. The GUID and time stamp typed fields will be filled by this function. |
ACAPI_Markup_Change
function to change and ACAPI_Markup_Delete function to delete an existing Mark-Up entry. Elements can be attached to the Mark-Up using ACAPI_Markup_AttachElements and comment can be added with ACAPI_Markup_AddComment function. GSErrCode __ACENV_CALL ACAPI_Markup_Delete | ( | const API_Guid & | markUpGuid, |
bool | acceptAllElements = false |
||
) |
Deletes an existing Issue.
markUpGuid | [in] GUID of an existing Issue. |
acceptAllElements | [in] Accept all entry suggestions before the delete operation. |
GSErrCode __ACENV_CALL ACAPI_Markup_DetachElements | ( | const API_Guid & | markUpGuid, |
const GS::Array< API_Guid > & | elemList | ||
) |
Detach elements from an existing Mark-Up.
markUpGuid | [in] GUID of the existing Mark-Up. |
elemList | [in] The list of elements to detach. |
GSErrCode __ACENV_CALL ACAPI_Markup_ExportToBCF | ( | const IO::Location & | fileLoc, |
const GS::Array< API_Guid > & | markupEntryIds, | ||
const bool | useExternalId = false , |
||
const bool | alignBySurveyPoint = true |
||
) |
Exports a BCF file to specified location.
fileLoc | [in] The location of the BCF file. |
markupEntryIds | [in] An Array containing the MarkUp Entry identifiers to export. |
useExternalId | [in] Use external IFC ID or Archicad IFC ID as referenced in BCF topics. |
alignBySurveyPoint | [in] Align BCF views by Archicad Survey Point or Archicad Project Origin. |
GSErrCode __ACENV_CALL ACAPI_Markup_GetAttachedElements | ( | const API_Guid & | markUpGuid, |
API_MarkUpComponentTypeID | type, | ||
GS::Array< API_Guid > & | attachedElements | ||
) |
Returns the corrected and highlighted elements of the given Mark-Up.
markUpGuid | [in] GUID of the existing Mark-Up. |
type | [in] Return the attached elements with the given Component type. |
attachedElements | [out] The list of the attachedElements elements of the Mark-Up. |
GSErrCode __ACENV_CALL ACAPI_Markup_GetComments | ( | const API_Guid & | markUpGuid, |
GS::Array< API_MarkUpCommentType > * | commentList | ||
) |
Returns the comments attached to the given Mark-Up entry.
markUpGuid | [in] GUID of the existing Mark-Up. |
commentList | [out] The list of the comments. |
GSErrCode __ACENV_CALL ACAPI_Markup_GetList | ( | const API_Guid & | elemGuid, |
GS::Array< API_MarkUpType > * | markUpList, | ||
bool * | asCorrected = nullptr |
||
) |
Returns the existing Mark-Up entries which the given element is attached to.
elemGuid | [in] The GUID of the element or APINULLGuid to list all Mark-Ups. |
markUpList | [out] The list of Mark-Up(s). |
asCorrected | [out] Returns whether the given element is a corrected or highlighted element in the listed Mark-Up(s). |
GSErrCode __ACENV_CALL ACAPI_Markup_ImportFromBCF | ( | const IO::Location & | fileLoc, |
const bool | silentMode, | ||
APIIFCRelationshipDataProc * | ifcRelationshipDataProc, | ||
const void * | par1, | ||
const bool | openMarkUpPalette = false , |
||
const bool | alignBySurveyPoint = true |
||
) |
Imports a BCF file.
fileLoc | [in] The location of the BCF file. |
silentMode | [in] Execute the import in silent mode, if its value is true then there will be no error or warning dialogs. |
ifcRelationshipDataProc | [in] Optional user defined callback function which will supply API_IFCRelationshipData needed by BCF import when topics refers to element components like IFCBuildingElementParts. For more details see APIIFCRelationshipDataProc. |
par1 | [in] Optional parameter what will be passed for ifcRelationshipDataProc callback function. |
openMarkUpPalette | [in] Open MarkUp Palette after import or not. |
alignBySurveyPoint | [in] Align BCF views by Archicad Survey Point or Archicad Project Origin. |