stepw.hpp

Go to the documentation of this file.

#ifndef _STEPW_HEADER_
#define _STEPW_HEADER_
class stepw_ER;
 
 
DtkErrorStatus stepw_InitFile( const Dtk_string& inFileName, const char* inOriginatingSystem = " user ", const int inSchema = 0 );
 
DtkErrorStatus stepw_SetHeaderData( const int inNumItem, const wchar_t* inValItem );
 
DtkErrorStatus stepw_SetHeaderData( const int inNumItem, const Dtk_string& inValItem );
 
DtkErrorStatus stepw_SetModeFdt( const int inMode, const int inPolyline = 2 );
 
DtkErrorStatus stepw_SetModeProp( const int inMode );
 
DtkErrorStatus stepw_SetModeItemName( const int inMode );
 
DtkErrorStatus stepw_SetModeCompress( const int inMode );
 
DtkErrorStatus stepw_SetModeInfoFirstFace( bool inModeInfoFirstFace );
 
Dtk_ErrorStatus stepw_SetContextUnit( const int inLength, const int inAngle = 0 );
 
 
Dtk_ErrorStatus stepw_SetConversionLengthUnit( const int inLength );
 
Dtk_ErrorStatus stepw_SetContextTolerance( const double inTol );
 
Dtk_string stepw_GiveUniqueFileName( const Dtk_string& inFileName );
 
Dtk_ErrorStatus stepw_AddExternalReference( const Dtk_string& inProductName, const Dtk_string& inFileName, int& outID, Dtk_ID inInstCompId = 0 );
 
Dtk_ErrorStatus stepw_WriteExternalReference( const int inID );
 
int stepw_WhichProductID( const Dtk_string& inProductName );
 
Dtk_string stepw_GiveUniqueProductName( const Dtk_string& inProductName );
 
DtkErrorStatus stepw_InitProduct( const Dtk_string& inProductName, int& outAssignedID, Dtk_ID inProductUserID = 0 );
 
DtkErrorStatus stepw_SetProductLayerInfosSet( const Dtk_LayerInfosSetPtr inLayerInfoSet );
 
DtkErrorStatus stepw_AddInstance( const int inFatherProductID, const int inChildProductID, const Dtk_transfo& inPosition, const Dtk_string& inInstanceName );  // 0 OK, -1 ERROR
 
DtkErrorStatus stepw_AddInstanceWithInfo( const int inFatherProductID, const int inChildProductID, const Dtk_transfo& inPosition, const Dtk_string& inInstanceName, const Dtk_InfoPtr& inInstanceInfo );
 
DtkErrorStatus stepw_AddInstanceWithInfo( const int inFatherProductID, const int inChildProductID, const Dtk_transfo& inPosition, const Dtk_string& inInstanceName, const Dtk_InfoPtr& inInstanceInfo,
int& outInstanceID, const int inInstanceUserID = 0, const Dtk_string& inReferenceDesignator = "" );
 
 
SetAsDeprecated( "2025.4", "Use stepw_SetInstanceUserID instead." )
DtkErrorStatus stepw_SetAnchorInstance( const int inInstanceID, const int inInstanceUserID );
 
DtkErrorStatus stepw_SetInstanceUserID( const int inInstanceID, const int inInstanceUserID );
 
SetAsDeprecated( "2025.4", "Use stepw_WhichInstanceID instead." )
int  stepw_AnchorInstanceID( const int inUserID );
 
int  stepw_WhichInstanceID( const int inUserID );
 
DtkErrorStatus stepw_SetPartProperties( const Dtk_InfoPtr& inInfo, const int inItem );
 
Dtk_ErrorStatus stepw_InitPropertySet( const int inMode );
 
Dtk_ErrorStatus stepw_Add3DPartProperty( const Dtk_MetaDataPtr& inProperty );
 
DtkErrorStatus stepw_Init3DPart( const int inProductID );
 
void stepw_InitNodeContext( const int inNodeID );
 
void stepw_InitNodeContext( const int inNodeID, const Dtk_InfoPtr& inNodeInfo );
 
void stepw_EndNodeContext( const int unused = 0 );
 
Dtk_ErrorStatus stepw_SetNextSubBody( const int mode );
 
DtkErrorStatus stepw_Write3DPartBody( const Dtk_BodyPtr& inBody );
 
DtkErrorStatus stepw_Write3DPartBodyWithMesh( const Dtk_BodyPtr& inBody, const Dtk_MeshPtr& inMesh, const int inMode = 0 );
 
DtkErrorStatus stepw_Write3DConstructionGeometry( const Dtk_BodyPtr& inBody );
 
DtkErrorStatus stepw_Write3DAxisSystem( const Dtk_AxisSystemPtr& inAxis );
 
DtkErrorStatus stepw_Write3DPartMesh( const Dtk_MeshPtr& inMesh );
 
DtkErrorStatus stepw_Write3DPartMeshFromBody( const Dtk_MeshPtr& inMesh, const Dtk_BodyPtr& inBody );
 
DtkErrorStatus stepw_Add3DPartFDT( const Dtk_FdtPtr& inFDT );
 
DtkErrorStatus stepw_Add3DPartFDT( const Dtk_FdtPtr& inFDT, const Dtk_FdtPtr& inFDTGraf );
 
DtkErrorStatus stepw_Add3DPartFDT( const Dtk_FdtPtr& inFDT, const stepw_ER& inER );
 
 
Dtk_ErrorStatus stepw_Add3DModelDisplay( const Dtk_ModelDisplayPtr& inModelDisplay, const int inMode );
 
SetAsDeprecated( "2025.4", "Use stepw_Add3DModelDisplay and stepw_AddReference instead.")
Dtk_ErrorStatus stepw_Add3DFdtModelDisplay( const Dtk_ModelDisplayPtr& inModelDisplay, const Dtk_FdtPtr& inFDT );
 
 
DtkErrorStatus stepw_Write3DPartRoot();
 
DtkErrorStatus stepw_End3DPart();
 
DtkErrorStatus stepw_WriteAssemblyInstances( const int inID );  // inID must repeat that of InitProduct.
 
DtkErrorStatus stepw_EndProduct( const int inProductID );
 
 
DtkErrorStatus stepw_EndFile();
 
 
//Classes to describe element references inside a product or between products.
class stepw_ER //Placeholder for element reference
{
public:
     stepw_ER();
     void* m_pData;
};
 
class stepw_ERP //Placeholder for element reference path
{
public:
     stepw_ERP();
     void* m_pData;
};
 
DtkErrorStatus stepw_CreateReference( stepw_ER& inOutElementReference, const int inEntityID, const int inProductID = 0, const char* inReferenceKind = "");
 
DtkErrorStatus stepw_CreateReferenceToNode( stepw_ER& inOutElementReference, const int inNodeID, const int inProductID = 0, const char* inReferenceKind = "");
 
DtkErrorStatus stepw_AddReference( stepw_ER& inElementReference );
 
DtkErrorStatus stepw_CreateReferenceToFdt( stepw_ER& inOutElementReference, const int inEntityID, const int inProductID );
 
DtkErrorStatus stepw_CreateReferenceToGroup( stepw_ER& inOutElementReference, const int inEntityID, const int inProductID );
 
DtkErrorStatus stepw_CreateInstancePath( stepw_ERP& inOutElementReferencePath );
 
DtkErrorStatus stepw_AddInstanceToPath( stepw_ERP& inOutElementReferencePath, const int inInstanceID );
 
Dtk_ErrorStatus stepw_DefineInstancePath( stepw_ERP& inOutElementReferencePath, const Dtk_tab<Dtk_ID>& inInstancePath, const bool unused = false );
 
DtkErrorStatus stepw_SetReferencePath( stepw_ER& inOutElementReference, stepw_ERP& inElementReferencePath );
 
Dtk_ErrorStatus stepw_AddOverrideInstanceInfo( stepw_ERP& inElementReferencePath, Dtk_InfoPtr& inOverrideInfo );
 
DtkErrorStatus stepw_SetAnchorProduct( const int inProductID, const int inUserID );
 
int stepw_AnchorProductID( const int inUserID );
 
Dtk_ErrorStatus stepw_AddAnchorItem( const int inEntityID, const int inProductID, const Dtk_string& inGUID );
 
 
 
#endif