DATAKIT API  V2025.4
stepw.hpp File Reference

Go to the source code of this file.

Data Structures

class  stepw_ER
 
class  stepw_ERP
 

Functions

 SetAsDeprecated ("2025.4", "Use stepw_Add3DModelDisplay and stepw_AddReference instead.") Dtk_ErrorStatus stepw_Add3DFdtModelDisplay(const Dtk_ModelDisplayPtr &inModelDisplay
 Adds a view ( Dtk_ModelDisplay ) with a link to a FDT, in the current part context. More...
 
 SetAsDeprecated ("2025.4", "Use stepw_SetInstanceUserID instead.") DtkErrorStatus stepw_SetAnchorInstance(const int inInstanceID
 
 SetAsDeprecated ("2025.4", "Use stepw_WhichInstanceID instead.") int stepw_AnchorInstanceID(const int inUserID)
 
Dtk_ErrorStatus stepw_Add3DModelDisplay (const Dtk_ModelDisplayPtr &inModelDisplay, const int inMode)
 Adds a view ( Dtk_ModelDisplay ) in the current part context. More...
 
DtkErrorStatus stepw_Add3DPartFDT (const Dtk_FdtPtr &inFDT)
 Adds a FDT in the current part context. More...
 
DtkErrorStatus stepw_Add3DPartFDT (const Dtk_FdtPtr &inFDT, const Dtk_FdtPtr &inFDTGraf)
 Adds a FDT in the current part context, with a predefined graphic presentation. More...
 
DtkErrorStatus stepw_Add3DPartFDT (const Dtk_FdtPtr &inFDT, const stepw_ER &inER)
 Adds a FDT in the current part context, with an element reference (usually the target geometry). More...
 
Dtk_ErrorStatus stepw_Add3DPartProperty (const Dtk_MetaDataPtr &inProperty)
 Adds a roperty to a part (default), or to an entity, according to InitPropertySet mode. More...
 
Dtk_ErrorStatus stepw_AddAnchorItem (const int inEntityID, const int inProductID, const Dtk_string &inGUID)
 Registers an entity in the ANCHOR section, with an assigned GUID (optional). More...
 
Dtk_ErrorStatus stepw_AddExternalReference (const Dtk_string &inProductName, const Dtk_string &inFileName, int &outID, Dtk_ID inInstCompId=0)
 Declares a product to be written as an external reference (separated file). More...
 
DtkErrorStatus stepw_AddInstance (const int inFatherProductID, const int inChildProductID, const Dtk_transfo &inPosition, const Dtk_string &inInstanceName)
 Adds an instance of a product ( child ) in an assembly product ( father ). More...
 
DtkErrorStatus stepw_AddInstanceToPath (stepw_ERP &inOutElementReferencePath, const int inInstanceID)
 Appends an instance identifier to the element reference path. The instance identifier is provided by this library. More...
 
DtkErrorStatus stepw_AddInstanceWithInfo (const int inFatherProductID, const int inChildProductID, const Dtk_transfo &inPosition, const Dtk_string &inInstanceName, const Dtk_InfoPtr &inInstanceInfo)
 Adds an instance of a product ( child ) in an assembly product ( father ), with provided attributes. More...
 
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="")
 Adds an instance of a product ( child ) in an assembly product ( father ), with provided attributes. More...
 
Dtk_ErrorStatus stepw_AddOverrideInstanceInfo (stepw_ERP &inElementReferencePath, Dtk_InfoPtr &inOverrideInfo)
 Assigns information on an instance in multi-level assembly context. More...
 
DtkErrorStatus stepw_AddReference (stepw_ER &inElementReference)
 Registers the previously created element reference in the writer. More...
 
int stepw_AnchorProductID (const int inUserID)
 Finds the product having an ANCHOR section, by user identifier. More...
 
DtkErrorStatus stepw_CreateInstancePath (stepw_ERP &inOutElementReferencePath)
 Initializes a path for the element reference, identifying the sequence of instances to pass through. More...
 
DtkErrorStatus stepw_CreateReference (stepw_ER &inOutElementReference, const int inEntityID, const int inProductID=0, const char *inReferenceKind="")
 Creates a reference to an entity located in the designated Product/Part context, or current context if not specified. More...
 
DtkErrorStatus stepw_CreateReferenceToFdt (stepw_ER &inOutElementReference, const int inEntityID, const int inProductID)
 Creates a reference to an entity located in the designated Product/Part context. The reference target is known to be an FDT (Dtk_FDT). More...
 
DtkErrorStatus stepw_CreateReferenceToGroup (stepw_ER &inOutElementReference, const int inEntityID, const int inProductID)
 Creates a reference to an entity located in the designated Product/Part context. The reference target is known to be a feature (Dtk_Feature) (interpreted as a group of geometries). More...
 
DtkErrorStatus stepw_CreateReferenceToNode (stepw_ER &inOutElementReference, const int inNodeID, const int inProductID=0, const char *inReferenceKind="")
 Creates a reference to a whole node (Dtk_Node), located in the designated Product/Part context. More...
 
Dtk_ErrorStatus stepw_DefineInstancePath (stepw_ERP &inOutElementReferencePath, const Dtk_tab< Dtk_ID > &inInstancePath, const bool unused=false)
 Define the whole instance identifier sequence of the element reference path. More...
 
DtkErrorStatus stepw_End3DPart ()
 Ends the writing of a product 3D part. More...
 
DtkErrorStatus stepw_EndFile ()
 Ends the writing of the current STEP file. More...
 
void stepw_EndNodeContext (const int unused=0)
 Ends current node context. More...
 
DtkErrorStatus stepw_EndProduct (const int inProductID)
 Ends the writing of a product - calls WriteAssemblyInstances if not yet done. More...
 
Dtk_string stepw_GiveUniqueFileName (const Dtk_string &inFileName)
 Creates a unique file name for an external reference - applies to the current session (stepw_InitFile to stepw_EndFile). More...
 
Dtk_string stepw_GiveUniqueProductName (const Dtk_string &inProductName)
 Creates a unique product name. More...
 
DtkErrorStatus stepw_Init3DPart (const int inProductID)
 Initializes the writing of a 3D part for the designated product. More...
 
DtkErrorStatus stepw_InitFile (const Dtk_string &inFileName, const char *inOriginatingSystem=" user ", const int inSchema=0)
 Initializes a file to be written. More...
 
void stepw_InitNodeContext (const int inNodeID)
 Initializes the context to write entities in a node. More...
 
void stepw_InitNodeContext (const int inNodeID, const Dtk_InfoPtr &inNodeInfo)
 Initializes the context to write entities in a node. More...
 
DtkErrorStatus stepw_InitProduct (const Dtk_string &inProductName, int &outAssignedID, Dtk_ID inProductUserID=0)
 Initializes the definition context of a product. More...
 
Dtk_ErrorStatus stepw_InitPropertySet (const int inMode)
 Sets attachment mode for next property writing : the whole Part, or to the following entity to be written. More...
 
DtkErrorStatus stepw_SetAnchorProduct (const int inProductID, const int inUserID)
 Declares the product as having an ANCHOR section. If the designated product is already declared as such, sets its user-defined identifier. More...
 
Dtk_ErrorStatus stepw_SetContextTolerance (const double inTol)
 Sets length tolerance for the 3D geometry (uncertainty). More...
 
Dtk_ErrorStatus stepw_SetContextUnit (const int inLength, const int inAngle=0)
 Sets file units in which the geometries, properties are to be written. More...
 
Dtk_ErrorStatus stepw_SetConversionLengthUnit (const int inLength)
 Sets file units in which the geometries, properties are to be written, and apply the conversion factor (from MM). More...
 
DtkErrorStatus stepw_SetHeaderData (const int inNumItem, const Dtk_string &inValItem)
 Sets STEP file header fields value. More...
 
DtkErrorStatus stepw_SetHeaderData (const int inNumItem, const wchar_t *inValItem)
 Sets STEP file header fields value. More...
 
DtkErrorStatus stepw_SetInstanceUserID (const int inInstanceID, const int inInstanceUserID)
 Sets the designated instance its user-defined identifier. More...
 
DtkErrorStatus stepw_SetModeCompress (const int inMode)
 Selects a mode of writing compact or compressed step files. More...
 
DtkErrorStatus stepw_SetModeFdt (const int inMode, const int inPolyline=2)
 Activates/Deactivates writing of FDT. More...
 
DtkErrorStatus stepw_SetModeInfoFirstFace (bool inModeInfoFirstFace)
 On a solid or shell, allows the spreading of its first available face graphical attributes to the whole solid/shell. More...
 
DtkErrorStatus stepw_SetModeItemName (const int inMode)
 Selects a mode for topological 3D items naming policy (shells, faces, edges ). More...
 
DtkErrorStatus stepw_SetModeProp (const int inMode)
 Activates/Deactivates writing of properties : User Attributes, Product Data. More...
 
Dtk_ErrorStatus stepw_SetNextSubBody (const int mode)
 
DtkErrorStatus stepw_SetPartProperties (const Dtk_InfoPtr &inInfo, const int inItem)
 Defines properties to be attached directly to the product : considers the list of Dtk_Val in the Dtk_Info. More...
 
DtkErrorStatus stepw_SetProductLayerInfosSet (const Dtk_LayerInfosSetPtr inLayerInfoSet)
 Sets the LayerInfosSet to refer to when writing the current product. It uses its mapping between layer identifier and name. More...
 
DtkErrorStatus stepw_SetReferencePath (stepw_ER &inOutElementReference, stepw_ERP &inElementReferencePath)
 Assigns the element reference path to the element reference. More...
 
int stepw_WhichInstanceID (const int inUserID)
 Checks if an instance (known by its user-defined identifier), is already registered. More...
 
int stepw_WhichProductID (const Dtk_string &inProductName)
 Checks if a product (known by its unique name), is already registered. More...
 
DtkErrorStatus stepw_Write3DAxisSystem (const Dtk_AxisSystemPtr &inAxis)
 Writes an axis system of a 3D part, in STEP, it is a construction geometry based on an axis placement. More...
 
DtkErrorStatus stepw_Write3DConstructionGeometry (const Dtk_BodyPtr &inBody)
 Writes a body as a construction geometry of a 3D part, of any kind (solid, shell / faces, wireframe / points). More...
 
DtkErrorStatus stepw_Write3DPartBody (const Dtk_BodyPtr &inBody)
 Writes a body of a 3D part (3D content of a product), of any kind (solid, shell / faces, wireframe / points). More...
 
DtkErrorStatus stepw_Write3DPartBodyWithMesh (const Dtk_BodyPtr &inBody, const Dtk_MeshPtr &inMesh, const int inMode=0)
 Writes a body of a 3D part (3D content of a product), associated with a mesh. More...
 
DtkErrorStatus stepw_Write3DPartMesh (const Dtk_MeshPtr &inMesh)
 Writes a mesh of a 3D part (3D content of a product). More...
 
DtkErrorStatus stepw_Write3DPartMeshFromBody (const Dtk_MeshPtr &inMesh, const Dtk_BodyPtr &inBody)
 Writes a mesh of a 3D part (3D content of a product), coming from a body, without writing the body itself. More...
 
DtkErrorStatus stepw_Write3DPartRoot ()
 
DtkErrorStatus stepw_WriteAssemblyInstances (const int inID)
 Writes instances detained by a product. More...
 
Dtk_ErrorStatus stepw_WriteExternalReference (const int inID)
 Writes a product as an external reference. Only one per file for a given product. More...
 

Variables

const Dtk_FdtPtrinFDT
 
const int inInstanceUserID
 

Function Documentation

◆ SetAsDeprecated() [1/2]

SetAsDeprecated ( "2025.4"  ,
"Use stepw_SetInstanceUserID instead."   
) const
Deprecated:
Use stepw_SetInstanceUserID instead.

◆ SetAsDeprecated() [2/2]

SetAsDeprecated ( "2025.4"  ,
"Use stepw_WhichInstanceID instead."   
) const
Deprecated:
Use stepw_WhichInstanceID instead.

◆ stepw_SetNextSubBody()

Dtk_ErrorStatus stepw_SetNextSubBody ( const int  mode)

◆ stepw_Write3DPartRoot()

DtkErrorStatus stepw_Write3DPartRoot ( )

Variable Documentation

◆ inFDT

const Dtk_FdtPtr& inFDT

◆ inInstanceUserID

const int inInstanceUserID