DATAKIT API  V2025.1
Igesw Namespace Reference

Exported APIs for IGES (.igs) Write Library. More...

Data Structures

class  IgesMetaData
 

Functions

DtkErrorStatus EndWrite ()
 Creation of the output file and free the Iges Writer
More...
 
DtkErrorStatus InitWrite (const Dtk_string &inOutputFile, const Dtk_string &inLogFile, IgesMetaData inHeaderInformations)
 Initialize the Iges Writer
More...
 
Dtk_ErrorStatus InstanciatePrototype (Dtk_ID inProtoIndex, const Dtk_transfo &inPlacement, const Dtk_InfoPtr &inInstanceInfos, Dtk_Char8 inDependancyFlag, Dtk_ID &outInstanceIndex)
 Write a Instance 408 figure entity
More...
 
Dtk_ErrorStatus WriteEntity (const Dtk_EntityPtr &inEntity, Dtk_Char8 inDependancyFlag, Dtk_tab< Dtk_ID > &outIndices)
 Write an entity
More...
 
Dtk_ErrorStatus WritePrototype (const Dtk_tab< Dtk_ID > &inIndices, const Dtk_InfoPtr &inProtoInfos, Dtk_ID &outProtoIndex)
 Write a Prototype 308 subfigure entity
More...
 

Detailed Description

Exported APIs for IGES (.igs) Write Library.

Function Documentation

◆ EndWrite()

DtkErrorStatus Igesw::EndWrite ( )

Creation of the output file and free the Iges Writer

Returns
dtkNoError if it is OK.
Remarks
used as the last function used for the writer.

◆ InitWrite()

DtkErrorStatus Igesw::InitWrite ( const Dtk_string inOutputFile,
const Dtk_string inLogFile,
IgesMetaData  inHeaderInformations 
)

Initialize the Iges Writer

Returns
dtkNoError if it is OK.
Parameters
[in]inOutputFile: Output file name
[in]inLogFile: Log file
[in]inHeaderInformations: StartSection and Global Section information
Remarks
This function is the first call for the writer, it must me called after Dtk_API::StartAPI(...)

◆ InstanciatePrototype()

Dtk_ErrorStatus Igesw::InstanciatePrototype ( Dtk_ID  inProtoIndex,
const Dtk_transfo inPlacement,
const Dtk_InfoPtr inInstanceInfos,
Dtk_Char8  inDependancyFlag,
Dtk_ID outInstanceIndex 
)

Write a Instance 408 figure entity

Parameters
[in]inProtoIndex: Prototype to be Instanciate
[in]inPlacement: Matrix Placement
[in]inInstanceInfos: Instance infos (Name ,Color , layer)
[in]inDependancyFlag: 0 for independant instance / 1 for instance to add in another Prototype
[out]outInstanceIndex: ID of 308 written
Returns
dtkNoError if it is OK.

◆ WriteEntity()

Dtk_ErrorStatus Igesw::WriteEntity ( const Dtk_EntityPtr inEntity,
Dtk_Char8  inDependancyFlag,
Dtk_tab< Dtk_ID > &  outIndices 
)

Write an entity

Parameters
[in]inEntity: The Entity to be written
[in]inDependancyFlag: 0 for independant entities / 1 for entities to add in Prototype
[out]outIndices: IDs of entity written
Returns
dtkNoError if it is OK.
Remarks
This function is used to write entities.

◆ WritePrototype()

Dtk_ErrorStatus Igesw::WritePrototype ( const Dtk_tab< Dtk_ID > &  inIndices,
const Dtk_InfoPtr inProtoInfos,
Dtk_ID outProtoIndex 
)

Write a Prototype 308 subfigure entity

Parameters
[in]inIndices: Entities IDs to add to 308
[in]inProtoInfos: Prototype infos (Name ,Color , layer)
[out]outProtoIndex: ID of 308 written
Returns
dtkNoError if it is OK.