S3D.export


The S3D.export namespace provides functions to export data and files from your s3d_model.


S3D.export.model.csv#

Exports a specific element type from the s3d_model (e.g. nodes, members, plates) as a CSV-formatted string.

important

S3D.model.set must be called earlier in the session.

KeyTypeAcceptsDescription
element_typestringNodes, Members, Plates, Meshed Plates, Supports, Materials, SectionsThe model element type to export as CSV.
Sample input for S3D.export.model.csv
{
"function": "S3D.export.model.csv",
"arguments": {
"element_type": "Members"
}
}

The response will return the CSV data as a string.

Sample response for S3D.export.model.csv
{
"data": "Member,Node A,Node B,Section,Material\n1,1,2,W14x808,Structural Steel\n2,2,3,W14x808,Structural Steel\n",
"status": 0,
"function": "S3D.export.model.csv"
}


S3D.export.model.dxf#

Exports the s3d_model as a DXF file.

important

S3D.model.set must be called earlier in the session.

KeyTypeAcceptsDescriptionDefault
scalefloate.g. 1Scale factor applied to the exported geometry.1
vertical_zbooleantrue, falseIf true, treats the Z axis as vertical instead of Y.false
timeoutintegerMillisecondsHow long to wait for the export to complete before timing out.60000
Sample input for S3D.export.model.dxf
{
"function": "S3D.export.model.dxf",
"arguments": {
"scale": 1,
"vertical_z": false
}
}

The response will return the raw DXF file content as a string.

Sample response for S3D.export.model.dxf
{
"status": 0,
"msg": "DXF File Generated Successfully",
"data": {
"file": "999\r\nCreated By SkyCiv\r\n0\r\nSECTION\r\n2\r\nHEADER\r\n...\r\n0\r\nENDSEC\r\n0\r\nEOF\r\n"
},
"function": "S3D.export.model.dxf"
}


S3D.export.model.stl#

Exports the s3d_model as an STL file, using the current 3D renderer geometry. This function takes no required arguments.

important

S3D.model.set must be called earlier in the session.

KeyTypeAcceptsDescriptionDefault
timeoutintegerMillisecondsHow long to wait for the export to complete before timing out.60000
Sample input for S3D.export.model.stl
{
"function": "S3D.export.model.stl"
}

The response will return the raw STL file content as a string.

Sample response for S3D.export.model.stl
{
"status": 0,
"msg": "STL File exported successfully",
"data": "solid exported\n\tfacet normal 0 -1 0\n\t\touter loop\n\t\t\tvertex 0.19 0 31.68\n\t\t\tvertex 0.19 0 31.57\n\t\t\tvertex 0.21 0 31.57\n\t\tendloop\n\tendfacet\n\t...\nendsolid exported",
"function": "S3D.export.model.stl"
}