Archicad 27 C++ API
|
This section collects functions that are used for different IFC related operations. More...
Classes | |
struct | API_IFCRelationshipData |
Contains IFC Entity relations which are specific for the IFC. The IFC Entities are represented by their GlobalId. More... | |
struct | API_IFCDifferenceGeneratorState |
State used in IFCDifference Generator. More... | |
struct | API_IFCEntityDescriptor |
Contains IFC Global ID and Archicad ID of an IFC Entity. More... | |
struct | API_IFCDifference |
Contains an IFC Difference. More... | |
Typedefs | |
typedef GSErrCode __ACENV_CALL | APIIFCRelationshipDataProc(GS::HashTable< API_Guid, API_IFCRelationshipData > *ifcRelationshipDataTable, const void *par1) |
User supplied callback procedure for helping BCF Import. | |
Functions | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetIFCIdentifier (const API_Guid &elementID, API_Guid &archicadIFCID, API_Guid &externalIFCID) |
Get IFC Identifier of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetElemListByIFCIdentifier (const API_Guid *archicadIFCID, const API_Guid *externalIFCID, GS::Array< API_Guid > &elements) |
Get elements having a certain IFC identifier. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetIFCType (const API_Guid &elementID, GS::UniString *ifcType, GS::UniString *typeObjectIFCType) |
Get IFC type and IfcTypeObject IFC type of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetIFCProperties (const API_Guid &guid_Element, bool storedOnly, GS::Array< API_IFCProperty > *properties) |
Get IFC properties of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_SetIFCProperty (const API_Guid &guid_Element, const API_IFCProperty &property) |
Set IFC property of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_RemoveIFCProperty (const API_Guid &guid_Element, const API_IFCProperty &property) |
Remove IFC property of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetIFCAttributes (const API_Guid &guid_Element, bool storedOnly, GS::Array< API_IFCAttribute > *attributes) |
Get IFC attributes of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_SetIFCAttribute (const API_Guid &guid_Element, const API_IFCAttribute &attribute) |
Set IFC attribute of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetIFCClassificationReferences (const API_Guid &guid_Element, bool storedOnly, GS::Array< API_IFCClassificationReference > *classificationReferences) |
Get IFC classificationreferences of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_SetIFCClassificationReference (const API_Guid &guid_Element, const API_IFCClassificationReference &classificationReference) |
Set IFC classificationreference of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_RemoveIFCClassificationReference (const API_Guid &guid_Element, const API_IFCClassificationReference &classificationReference) |
Remove IFC classificationreference of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetIFCPropertyValuePrimitiveType (const GS::UniString &valueType, API_IFCPropertyValuePrimitiveType *primitiveType) |
Get the primitive type of an IFC type. | |
GSErrCode __ACENV_CALL | ACAPI_IFC_IFCGuidToAPIGuid (const GS::UniString &ifcGuid, API_Guid &apiGuid) |
It converts an API_Guid to an IfcGloballyUniqueId string. | |
GSErrCode __ACENV_CALL | ACAPI_IFC_APIGuidToIFCGuid (const API_Guid &apiGuid, GS::UniString &ifcGuid) |
It converts an API_Guid to an IfcGloballyUniqueId string. | |
GSErrCode __ACENV_CALL | ACAPI_IFC_GetIFCRelationshipData (const API_IFCTranslatorIdentifier &ifcTranslatorIdentifier, API_IFCRelationshipData &ifcRelationshipData) |
It generates an IFC Relationship Data based on the input IFC Translator parameter. | |
GSErrCode __ACENV_CALL | ACAPI_IFC_GetIFCExportTranslatorsList (GS::Array< API_IFCTranslatorIdentifier > &ifcExportTranslators) |
Returns the valid IFC Export Translators. | |
GSErrCode __ACENV_CALL | ACAPI_IFC_GetIFCDifferenceState (const API_Guid &viewGuid, const API_IFCTranslatorIdentifier &ifcTranslatorIdentifier, API_IFCDifferenceGeneratorState &ifcDifferenceState) |
Generates an IFC Difference based on the input parameters. | |
GSErrCode __ACENV_CALL | ACAPI_IFC_GetIFCDifference (const API_IFCDifferenceGeneratorState &previousIFCDifferenceGeneratorState, const API_IFCDifferenceGeneratorState ¤tIFCDifferenceGeneratorState, API_IFCDifference &ifcDifference) |
Generates an IFC Difference based on the input parameters. | |
GSErrCode __ACENV_CALL | ACAPI_IFC_ComplementIFCDifferenceAndMergeIFCRelationshipData (const API_IFCRelationshipData &olderIfcRelationshipData, const API_IFCRelationshipData &newerIfcRelationshipData, API_IFCDifference &ifcDifference, API_IFCRelationshipData &mergedIfcRelationshipData) |
Augments the ifcDifference with previously deleted items and merges olderIfcRelationshipData with newerIfcRelationshipData. | |
GSErrCode __ACENV_CALL | ACAPI_IFC_InvokeIFCDifferenceExportSettingsDlg (API_Guid &viewGuid, API_IFCTranslatorIdentifier &ifcTranslatorIdentifier) |
It opens a dialog where a View and an IFC Export Translator can be selected. | |
This section collects functions that are used for different IFC related operations.
typedef GSErrCode __ACENV_CALL APIIFCRelationshipDataProc(GS::HashTable< API_Guid, API_IFCRelationshipData > *ifcRelationshipDataTable, const void *par1) |
User supplied callback procedure for helping BCF Import.
ifcRelationshipDataTable | [out] Gives back a Hashtable where the keys are the IFCProject's GlobalIds and the values are their API_IFCRelationshipData. |
par1 | [in] Optional parameter. |
GSErrCode __ACENV_CALL ACAPI_Element_GetElemListByIFCIdentifier | ( | const API_Guid * | archicadIFCID, |
const API_Guid * | externalIFCID, | ||
GS::Array< API_Guid > & | elements | ||
) |
Get elements having a certain IFC identifier.
archicadIFCID | [in] Archicad IFC ID - it can be nullptr |
externalIFCID | [in] External IFC ID - it can be nullptr |
elements | [out] GUID of the elements |
GSErrCode __ACENV_CALL ACAPI_Element_GetIFCAttributes | ( | const API_Guid & | guid_Element, |
bool | storedOnly, | ||
GS::Array< API_IFCAttribute > * | attributes | ||
) |
Get IFC attributes of an element.
guid_Element | [in] GUID of the element |
storedOnly | [in] Get only the core data without the derived content, must be false is most cases |
attributes | [out] IFC attributes of the element |
GSErrCode __ACENV_CALL ACAPI_Element_GetIFCClassificationReferences | ( | const API_Guid & | guid_Element, |
bool | storedOnly, | ||
GS::Array< API_IFCClassificationReference > * | classificationReferences | ||
) |
Get IFC classificationreferences of an element.
guid_Element | [in] GUID of the element |
storedOnly | [in] Get only the core data without the derived content, must be false is most cases |
classificationReferences | [out] IFC classificationreferences of the element |
GSErrCode __ACENV_CALL ACAPI_Element_GetIFCIdentifier | ( | const API_Guid & | elementID, |
API_Guid & | archicadIFCID, | ||
API_Guid & | externalIFCID | ||
) |
Get IFC Identifier of an element.
elementID | [in] GUID of the element |
archicadIFCID | [out] Archicad IFC ID of the element |
externalIFCID | [out] External IFC ID of the element |
GSErrCode __ACENV_CALL ACAPI_Element_GetIFCProperties | ( | const API_Guid & | guid_Element, |
bool | storedOnly, | ||
GS::Array< API_IFCProperty > * | properties | ||
) |
Get IFC properties of an element.
guid_Element | [in] GUID of the element |
storedOnly | [in] Get only the core data without the derived content, must be false is most cases |
properties | [out] IFC properties of the element |
GSErrCode __ACENV_CALL ACAPI_Element_GetIFCPropertyValuePrimitiveType | ( | const GS::UniString & | valueType, |
API_IFCPropertyValuePrimitiveType * | primitiveType | ||
) |
Get the primitive type of an IFC type.
valueType | [in] IFC type of the property value |
primitiveType | [out] Primitive type of the IFC type, see API_IFCPropertyAnyValue for values. |
GSErrCode __ACENV_CALL ACAPI_Element_GetIFCType | ( | const API_Guid & | elementID, |
GS::UniString * | ifcType, | ||
GS::UniString * | typeObjectIFCType | ||
) |
Get IFC type and IfcTypeObject IFC type of an element.
elementID | [in] GUID of the element |
ifcType | [out] IFC type of the element |
typeObjectIFCType | [out] IFC type of the IfcTypeObject of the element |
GSErrCode __ACENV_CALL ACAPI_Element_RemoveIFCClassificationReference | ( | const API_Guid & | guid_Element, |
const API_IFCClassificationReference & | classificationReference | ||
) |
Remove IFC classificationreference of an element.
guid_Element | [in] GUID of the element |
classificationReference | [in] IFC classificationreference to remove. |
ACAPI_Automation
- ACAPI_View_Rebuild function. GSErrCode __ACENV_CALL ACAPI_Element_RemoveIFCProperty | ( | const API_Guid & | guid_Element, |
const API_IFCProperty & | property | ||
) |
Remove IFC property of an element.
guid_Element | [in] GUID of the element |
property | [in] IFC property to remove. |
ACAPI_Automation
- ACAPI_View_Rebuild function. GSErrCode __ACENV_CALL ACAPI_Element_SetIFCAttribute | ( | const API_Guid & | guid_Element, |
const API_IFCAttribute & | attribute | ||
) |
Set IFC attribute of an element.
guid_Element | [in] GUID of the element |
attribute | [in] IFC attribute to modify. |
ACAPI_Automation
- ACAPI_View_Rebuild function. GSErrCode __ACENV_CALL ACAPI_Element_SetIFCClassificationReference | ( | const API_Guid & | guid_Element, |
const API_IFCClassificationReference & | classificationReference | ||
) |
Set IFC classificationreference of an element.
guid_Element | [in] GUID of the element |
classificationReference | [in] IFC classificationreference to add or modify. |
ACAPI_Automation
- ACAPI_View_Rebuild function. GSErrCode __ACENV_CALL ACAPI_Element_SetIFCProperty | ( | const API_Guid & | guid_Element, |
const API_IFCProperty & | property | ||
) |
Set IFC property of an element.
guid_Element | [in] GUID of the element |
property | [in] IFC property to add or modify. |
ACAPI_Automation
- ACAPI_View_Rebuild function. GSErrCode __ACENV_CALL ACAPI_IFC_APIGuidToIFCGuid | ( | const API_Guid & | apiGuid, |
GS::UniString & | ifcGuid | ||
) |
It converts an API_Guid to an IfcGloballyUniqueId string.
apiGuid | [in] API_Guid need to be converted. |
ifcGuid | [out] The resulting IfcGloballyUniqueId string. |
GSErrCode __ACENV_CALL ACAPI_IFC_ComplementIFCDifferenceAndMergeIFCRelationshipData | ( | const API_IFCRelationshipData & | olderIfcRelationshipData, |
const API_IFCRelationshipData & | newerIfcRelationshipData, | ||
API_IFCDifference & | ifcDifference, | ||
API_IFCRelationshipData & | mergedIfcRelationshipData | ||
) |
Augments the ifcDifference with previously deleted items and merges olderIfcRelationshipData with newerIfcRelationshipData.
olderIfcRelationshipData | [in] An olderly modified API_IFCRelationshipData. |
newerIfcRelationshipData | [in] A newerly modified API_IFCRelationshipData. |
ifcDifference | [in/out] The difference between the above two API_IFCRelationshipData. |
mergedIfcRelationshipData | [out] The merged result of the above two API_IFCRelationshipData. |
GSErrCode __ACENV_CALL ACAPI_IFC_GetIFCDifference | ( | const API_IFCDifferenceGeneratorState & | previousIFCDifferenceGeneratorState, |
const API_IFCDifferenceGeneratorState & | currentIFCDifferenceGeneratorState, | ||
API_IFCDifference & | ifcDifference | ||
) |
Generates an IFC Difference based on the input parameters.
previousIFCDifferenceGeneratorState | [in] Previous IFCDifference Generator state. |
currentIFCDifferenceGeneratorState | [in] Current IFCDifference Generator state. |
ifcDifference | [out] The resulting IFC Difference. |
GSErrCode __ACENV_CALL ACAPI_IFC_GetIFCDifferenceState | ( | const API_Guid & | viewGuid, |
const API_IFCTranslatorIdentifier & | ifcTranslatorIdentifier, | ||
API_IFCDifferenceGeneratorState & | ifcDifferenceState | ||
) |
Generates an IFC Difference based on the input parameters.
viewGuid | [in] Is a unique identifier of the View, which will be used for state generation. |
ifcTranslatorIdentifier | [in] IFC Export Translator identifier. |
ifcDifferenceState | [out] The resulting IFC Difference State. |
GSErrCode __ACENV_CALL ACAPI_IFC_GetIFCExportTranslatorsList | ( | GS::Array< API_IFCTranslatorIdentifier > & | ifcExportTranslators | ) |
Returns the valid IFC Export Translators.
ifcExportTranslators | [out] The resulting IFC Export Translators. |
GSErrCode __ACENV_CALL ACAPI_IFC_GetIFCRelationshipData | ( | const API_IFCTranslatorIdentifier & | ifcTranslatorIdentifier, |
API_IFCRelationshipData & | ifcRelationshipData | ||
) |
It generates an IFC Relationship Data based on the input IFC Translator parameter.
ifcTranslatorIdentifier | [in] Neccessery parameter for generate IFC Relationship Data. |
ifcRelationshipData | [out] The resulting IFC Relationship Data. |
GSErrCode __ACENV_CALL ACAPI_IFC_IFCGuidToAPIGuid | ( | const GS::UniString & | ifcGuid, |
API_Guid & | apiGuid | ||
) |
It converts an API_Guid to an IfcGloballyUniqueId string.
ifcGuid | [in] IfcGloballyUniqueId string need to be converted. |
apiGuid | [out] The resulting API_Guid. |
GSErrCode __ACENV_CALL ACAPI_IFC_InvokeIFCDifferenceExportSettingsDlg | ( | API_Guid & | viewGuid, |
API_IFCTranslatorIdentifier & | ifcTranslatorIdentifier | ||
) |
It opens a dialog where a View and an IFC Export Translator can be selected.
viewGuid | [in/out] A view Guid. Returns the selected view guid. |
ifcTranslatorIdentifier | [in/out] An IFC Export Translator. Returns the selected IFC Export Translator identifier. |