ASCII and Binary Stereo Lithography File writers. More...

#include <WriteSTL.hpp>

Inheritance diagram for moab::WriteSTL:

Collaboration diagram for moab::WriteSTL:

Public Member Functions
	WriteSTL (Interface *impl)
	Constructor. More...

virtual	~WriteSTL ()
	Destructor. More...

ErrorCode	write_file (const char file_name, const bool overwrite, const FileOptions &opts, const EntityHandle output_list, const int num_sets, const std::vector< std::string > &qa_list, const Tag *tag_list=NULL, int num_tags=0, int export_dimension=3)
	writes out a file More...

Public Member Functions inherited from moab::WriterIface
virtual	~WriterIface ()

Static Public Member Functions
static WriterIface *	factory (Interface *)
	factory method forSTL writer More...

Protected Types
enum	ByteOrder { STL_BIG_ENDIAN , STL_LITTLE_ENDIAN , STL_UNKNOWN_BYTE_ORDER }

Protected Member Functions
ErrorCode	ascii_write_triangles (FILE *file, const char header[81], const Range &triangles, int precision)
	Write list of triangles to an STL file. More...

ErrorCode	binary_write_triangles (FILE *file, const char header[81], ByteOrder byte_order, const Range &triangles)
	Write list of triangles to an STL file. More...

ErrorCode	get_triangle_data (const double vtx_coords[9], float v1[3], float v2[3], float v3[3], float n[3])
	Given an array of vertex coordinates for a triangle, pass back individual point coordinates as floats and calculate triangle normal. More...

ErrorCode	get_triangle_data (const double vtx_coords[9], CartVect &v1, CartVect &v2, CartVect &v3, CartVect &n)

Protected Attributes
Interface *	mbImpl
	interface instance More...

WriteUtilIface *	mWriteIface

Private Member Functions
ErrorCode	make_header (char header[81], const std::vector< std::string > &qa_list)
	Construct 80-byte, null-terminated description string from qa_list. Unused space in header will be null-char padded. More...

ErrorCode	get_triangles (const EntityHandle *set_array, int set_array_length, Range &triangles)
	Get triangles to write from input array of entity sets. If no sets, gets all triangles. More...

FILE *	open_file (const char *name, bool overwrite, bool binary)
	Open a file, respecting passed overwrite value and subclass-specified value for need_binary_io(). More...

Detailed Description

ASCII and Binary Stereo Lithography File writers.

Author: Jason Kraftcheck

This writer will write only the MBTRI elements in the mesh. It will not decompose other 2-D elements into triangles, nor will it skin the mesh or do any other high-level operation to generate triangles from 3-D elements.

Binary files will be written with a little-endian byte order by default. The byte order can be controlled with writer options.

Definition at line 42 of file WriteSTL.hpp.

Member Enumeration Documentation

◆ ByteOrder

enum moab::WriteSTL::ByteOrder

protected

Enumerator
STL_BIG_ENDIAN
STL_LITTLE_ENDIAN
STL_UNKNOWN_BYTE_ORDER

Definition at line 67 of file WriteSTL.hpp.

     {
         STL_BIG_ENDIAN,
         STL_LITTLE_ENDIAN,
         STL_UNKNOWN_BYTE_ORDER
     };

Constructor & Destructor Documentation

◆ WriteSTL()

WriteSTL::WriteSTL ( Interface * impl )

Constructor.

Definition at line 59 of file WriteSTL.cpp.

                                     : mbImpl( impl )
 {
     impl->query_interface( mWriteIface );
 }

References mWriteIface, and moab::Interface::query_interface().

Referenced by factory().

◆ ~WriteSTL()

WriteSTL::~WriteSTL ( )

virtual

Destructor.

Definition at line 64 of file WriteSTL.cpp.

 {
     mbImpl->release_interface( mWriteIface );
 }

References mbImpl, mWriteIface, and moab::Interface::release_interface().

Member Function Documentation

◆ ascii_write_triangles()

ErrorCode WriteSTL::ascii_write_triangles	(	FILE *	file,
		const char	header[81],
		const Range &	triangles,
		int	precision
	)

protected

Write list of triangles to an STL file.

Definition at line 234 of file WriteSTL.cpp.

 {
     const char solid_name[] = "MOAB";
  
     char myheader[81] = "solid ";
     strcat( myheader, solid_name );
     strncat( myheader, header, 80 );
  
     if( EOF == fputs( myheader, file ) || EOF == fputs( "\n", file ) ) return MB_FILE_WRITE_ERROR;
  
     ErrorCode rval;
     double coords[9];
     CartVect v1, v2, v3, n;
     for( Range::const_iterator iter = triangles.begin(); iter != triangles.end(); ++iter )
     {
         const EntityHandle* conn;
         int num_vtx;
  
         rval = mbImpl->get_connectivity( *iter, conn, num_vtx );
         if( MB_SUCCESS != rval ) return rval;
         if( num_vtx != 3 ) return MB_FAILURE;
  
         rval = mbImpl->get_coords( conn, 3, coords );
         if( MB_SUCCESS != rval ) return rval;
  
         rval = get_triangle_data( coords, v1, v2, v3, n );
         if( MB_SUCCESS != rval ) return rval;
  
         fprintf( file, "facet normal %e %e %e\n", n[0], n[1], n[2] );
         fprintf( file, "outer loop\n" );
         fprintf( file, "vertex %.*e %.*e %.*e\n", prec, (float)v1[0], prec, (float)v1[1], prec, (float)v1[2] );
         fprintf( file, "vertex %.*e %.*e %.*e\n", prec, (float)v2[0], prec, (float)v2[1], prec, (float)v2[2] );
         fprintf( file, "vertex %.*e %.*e %.*e\n", prec, (float)v3[0], prec, (float)v3[1], prec, (float)v3[2] );
         fprintf( file, "endloop\n" );
         fprintf( file, "endfacet\n" );
     }
  
     fprintf( file, "endsolid %s\n", solid_name );
     return MB_SUCCESS;
 }

References moab::Range::begin(), moab::Range::end(), ErrorCode, moab::Interface::get_connectivity(), moab::Interface::get_coords(), get_triangle_data(), MB_FILE_WRITE_ERROR, MB_SUCCESS, and mbImpl.

Referenced by write_file().

◆ binary_write_triangles()

ErrorCode WriteSTL::binary_write_triangles	(	FILE *	file,
		const char	header[81],
		ByteOrder	byte_order,
		const Range &	triangles
	)

protected

Write list of triangles to an STL file.

Definition at line 284 of file WriteSTL.cpp.

 {
     ErrorCode rval;
     if( 1 != fwrite( header, 80, 1, file ) ) return MB_FILE_WRITE_ERROR;
  
     // Default to little endian if byte_order == UNKNOWN_BYTE_ORDER
     const bool want_big_endian = ( byte_order == STL_BIG_ENDIAN );
     const bool am_big_endian   = !SysUtil::little_endian();
     const bool swap_bytes      = ( want_big_endian == am_big_endian );
  
     if( triangles.size() > INT_MAX )  // Can't write that many triangles
         return MB_FAILURE;
  
     uint32_t count = (uint32_t)triangles.size();
     if( swap_bytes ) SysUtil::byteswap( &count, 1 );
     if( 1 != fwrite( &count, 4, 1, file ) ) return MB_FILE_WRITE_ERROR;
  
     double coords[9];
     BinTri tri;
     tri.pad[0] = tri.pad[1] = '\0';
     for( Range::const_iterator iter = triangles.begin(); iter != triangles.end(); ++iter )
     {
         const EntityHandle* conn;
         int num_vtx;
  
         rval = mbImpl->get_connectivity( *iter, conn, num_vtx );
         if( MB_SUCCESS != rval ) return rval;
         if( num_vtx != 3 ) return MB_FAILURE;
  
         rval = mbImpl->get_coords( conn, 3, coords );
         if( MB_SUCCESS != rval ) return rval;
  
         rval = get_triangle_data( coords, tri.vertex1, tri.vertex2, tri.vertex3, tri.normal );
         if( MB_SUCCESS != rval ) return rval;
  
         if( swap_bytes )
         {
             SysUtil::byteswap( tri.normal, 3 );
             SysUtil::byteswap( tri.vertex1, 3 );
             SysUtil::byteswap( tri.vertex2, 3 );
             SysUtil::byteswap( tri.vertex3, 3 );
         }
  
         if( 1 != fwrite( &tri, 50, 1, file ) ) return MB_FILE_WRITE_ERROR;
     }
  
     return MB_SUCCESS;
 }

References moab::Range::begin(), moab::SysUtil::byteswap(), moab::Range::end(), ErrorCode, moab::Interface::get_connectivity(), moab::Interface::get_coords(), get_triangle_data(), moab::SysUtil::little_endian(), MB_FILE_WRITE_ERROR, MB_SUCCESS, mbImpl, moab::BinTri::normal, moab::BinTri::pad, moab::Range::size(), STL_BIG_ENDIAN, moab::SysUtil::swap_bytes(), moab::BinTri::vertex1, moab::BinTri::vertex2, and moab::BinTri::vertex3.

Referenced by write_file().

◆ factory()

WriterIface * WriteSTL::factory ( Interface * iface )

static

factory method forSTL writer

Definition at line 54 of file WriteSTL.cpp.

 {
     return new WriteSTL( iface );
 }

References iface, and WriteSTL().

Referenced by moab::ReaderWriterSet::ReaderWriterSet().

◆ get_triangle_data() [1/2]

ErrorCode WriteSTL::get_triangle_data	(	const double	vtx_coords[9],
		CartVect &	v1,
		CartVect &	v2,
		CartVect &	v3,
		CartVect &	n
	)

protected

Definition at line 221 of file WriteSTL.cpp.

 {
     v1 = coords;
     v2 = coords + 3;
     v3 = coords + 6;
  
     n = ( v2 - v1 ) * ( v3 - v1 );
  
     n.normalize();
  
     return MB_SUCCESS;
 }

References MB_SUCCESS, and moab::CartVect::normalize().

◆ get_triangle_data() [2/2]

ErrorCode WriteSTL::get_triangle_data	(	const double	vtx_coords[9],
		float	v1[3],
		float	v2[3],
		float	v3[3],
		float	n[3]
	)

protected

Given an array of vertex coordinates for a triangle, pass back individual point coordinates as floats and calculate triangle normal.

Definition at line 207 of file WriteSTL.cpp.

 {
     CartVect cv1, cv2, cv3, cn;
     ErrorCode rval = get_triangle_data( coords, cv1, cv2, cv3, cn );
     if( MB_SUCCESS != rval ) return rval;
  
     cv1.get( v1 );
     cv2.get( v2 );
     cv3.get( v3 );
     cn.get( n );
  
     return MB_SUCCESS;
 }

References ErrorCode, moab::CartVect::get(), and MB_SUCCESS.

Referenced by ascii_write_triangles(), and binary_write_triangles().

◆ get_triangles()

ErrorCode WriteSTL::get_triangles	(	const EntityHandle *	set_array,
		int	set_array_length,
		Range &	triangles
	)

private

Get triangles to write from input array of entity sets. If no sets, gets all triangles.

Definition at line 190 of file WriteSTL.cpp.

 {
     if( !set_array || 0 == set_array_length ) return mbImpl->get_entities_by_type( 0, MBTRI, triangles );
  
     const EntityHandle* iter = set_array;
     const EntityHandle* end  = iter + set_array_length;
     for( ; iter != end; ++iter )
     {
         Range r;
         ErrorCode rval = mbImpl->get_entities_by_type( *iter, MBTRI, r, true );
         if( MB_SUCCESS != rval ) return rval;
         triangles.merge( r );
     }
  
     return MB_SUCCESS;
 }

References ErrorCode, moab::Interface::get_entities_by_type(), MB_SUCCESS, mbImpl, MBTRI, and moab::Range::merge().

Referenced by write_file().

◆ make_header()

ErrorCode WriteSTL::make_header	(	char	header[81],
		const std::vector< std::string > &	qa_list
	)

private

Construct 80-byte, null-terminated description string from qa_list. Unused space in header will be null-char padded.

Definition at line 172 of file WriteSTL.cpp.

 {
     memset( header, 0, 81 );
  
     std::string result;
     for( std::vector< std::string >::const_iterator i = qa_list.begin(); i != qa_list.end(); ++i )
     {
         result += " ";
         result += *i;
     }
  
     size_t len = result.size();
     if( len > 80 ) len = 80;
     memcpy( header, result.c_str(), len );
  
     return MB_SUCCESS;
 }

References MB_SUCCESS.

Referenced by write_file().

◆ open_file()

FILE * WriteSTL::open_file	(	const char *	name,
		bool	overwrite,
		bool	binary
	)

private

Open a file, respecting passed overwrite value and subclass-specified value for need_binary_io().

Definition at line 134 of file WriteSTL.cpp.

 {
     // Open file with write access, and create it if it doesn't exist.
     int flags = O_WRONLY | O_CREAT;
     // Select behavior if the named file already exists. If
     // overwrite is true, truncate the file. If it is false,
     // make the call to open() fail.
     if( overwrite )
         flags |= O_TRUNC;
     else
         flags |= O_EXCL;
         // If platform defines a "binary" bit in the file access
         // flags (i.e. we're building on windows), then set it
         // if we're writing a binary file.
 #ifdef O_BINARY
     if( binary ) flags |= O_BINARY;
 #endif
  
     // Give everyone read and write, but not execute, permission.
     // These are not the final permissions for the file. Permissions
     // are removed according to the user's umask. All we want to
     // say here is that the executable bits should not be set because
     // this isn't an executable file. Everything else is a user
     // preference and should be left up to the umask.
     int creat_mode = _S_IREAD | _S_IWRITE;
  
     // Open the file.
     int fd = open( name, flags, creat_mode );
     if( fd < 0 )
     {
         MB_SET_ERR_RET_VAL( name << ": " << strerror( errno ), NULL );
     }
     FILE* result = fdopen( fd, binary ? "wb" : "w" );
     if( !result ) close( fd );
  
     return result;
 }

References _S_IREAD, _S_IWRITE, and MB_SET_ERR_RET_VAL.

Referenced by write_file().

◆ write_file()

ErrorCode WriteSTL::write_file	(	const char *	file_name,
		const bool	overwrite,
		const FileOptions &	opts,
		const EntityHandle *	output_list,
		const int	num_sets,
		const std::vector< std::string > &	qa_list,
		const Tag *	tag_list = `NULL`,
		int	num_tags = `0`,
		int	export_dimension = `3`
	)

virtual

writes out a file

Implements moab::WriterIface.

Definition at line 69 of file WriteSTL.cpp.

 {
     char header[81];
     Range triangles;
     ErrorCode rval;
  
     if( tag_list && num_tags )
     {
         MB_SET_ERR( MB_TYPE_OUT_OF_RANGE, "STL file does not support tag data" );
     }
  
     rval = make_header( header, qa_list );
     if( MB_SUCCESS != rval ) return rval;
  
     rval = get_triangles( ent_handles, num_sets, triangles );
     if( MB_SUCCESS != rval ) return rval;
  
     if( triangles.empty() )
     {
         MB_SET_ERR( MB_ENTITY_NOT_FOUND, "No triangles to write" );
     }
  
     bool is_ascii = false, is_binary = false;
     if( MB_SUCCESS == opts.get_null_option( "ASCII" ) ) is_ascii = true;
     if( MB_SUCCESS == opts.get_null_option( "BINARY" ) ) is_binary = true;
     if( is_ascii && is_binary )
     {
         MB_SET_ERR( MB_FAILURE, "Conflicting options: BINARY ASCII" );
     }
  
     bool big_endian = false, little_endian = false;
     if( MB_SUCCESS == opts.get_null_option( "BIG_ENDIAN" ) ) big_endian = true;
     if( MB_SUCCESS == opts.get_null_option( "LITTLE_ENDIAN" ) ) little_endian = true;
     if( big_endian && little_endian )
     {
         MB_SET_ERR( MB_FAILURE, "Conflicting options: BIG_ENDIAN LITTLE_ENDIAN" );
     }
     ByteOrder byte_order = big_endian ? STL_BIG_ENDIAN : little_endian ? STL_LITTLE_ENDIAN : STL_UNKNOWN_BYTE_ORDER;
  
     FILE* file = open_file( file_name, overwrite, is_binary );
     if( !file ) return MB_FILE_DOES_NOT_EXIST;
  
     if( is_binary )
         rval = binary_write_triangles( file, header, byte_order, triangles );
     else
     {
         // Get precision for node coordinates
         int precision;
         if( MB_SUCCESS != opts.get_int_option( "PRECISION", precision ) ) precision = DEFAULT_PRECISION;
  
         rval = ascii_write_triangles( file, header, triangles, precision );
     }
  
     fclose( file );
     return rval;
 }

References ascii_write_triangles(), moab::SysUtil::big_endian(), binary_write_triangles(), moab::DEFAULT_PRECISION, moab::Range::empty(), ErrorCode, moab::FileOptions::get_int_option(), moab::FileOptions::get_null_option(), get_triangles(), moab::SysUtil::little_endian(), make_header(), MB_ENTITY_NOT_FOUND, MB_FILE_DOES_NOT_EXIST, MB_SET_ERR, MB_SUCCESS, MB_TYPE_OUT_OF_RANGE, open_file(), STL_BIG_ENDIAN, STL_LITTLE_ENDIAN, and STL_UNKNOWN_BYTE_ORDER.

Member Data Documentation

◆ mbImpl

Interface* moab::WriteSTL::mbImpl

protected

interface instance

Definition at line 87 of file WriteSTL.hpp.

Referenced by ascii_write_triangles(), binary_write_triangles(), get_triangles(), and ~WriteSTL().

◆ mWriteIface

WriteUtilIface* moab::WriteSTL::mWriteIface

protected

Definition at line 88 of file WriteSTL.hpp.

Referenced by WriteSTL(), and ~WriteSTL().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ ByteOrder

Constructor & Destructor Documentation

◆ WriteSTL()

◆ ~WriteSTL()

Member Function Documentation

◆ ascii_write_triangles()

◆ binary_write_triangles()

◆ factory()

◆ get_triangle_data() [1/2]

◆ get_triangle_data() [2/2]

◆ get_triangles()

◆ make_header()

◆ open_file()

◆ write_file()

Member Data Documentation

◆ mbImpl

◆ mWriteIface