/*
 * E57Simple - public header of E57 Simple API for reading/writing .e57 files.
 *
 * Copyright (c) 2010 Stan Coleby (scoleby@intelisum.com)
 * Copyright (c) 2020 PTC Inc.
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#pragma once

//! @file E57SimpleWriter.h E57 Simple API for writing E57

#include "E57SimpleData.h"

namespace e57
{

   //! @brief Used for writing of the E57 file with E57 Simple API
   class E57_DLL Writer
   {
   public:
      //! @brief This function is the constructor for the writer class
      //! @param [in] filePath file path to E57 file
      //! @param [in] coordinateMetaData Information describing the Coordinate Reference System to be used for the file
      Writer( const ustring &filePath, const ustring &coordinateMetaData = {} );

      //! @brief This function returns true if the file is open
      bool IsOpen() const;

      //! @brief This function closes the file
      bool Close();

      //! @name Image2D
      //!@{

      //! @brief This function writes a new Image2D header
      //! @details The user needs to config a Image2D structure with all the camera information before making this call.
      //! @param [in,out] image2DHeader header metadata
      //! @return Returns the image2D index
      int64_t NewImage2D( Image2D &image2DHeader );

      //! @brief This function writes the actual image data
      //! @param [in] imageIndex picture block index given by the NewImage2D
      //! @param [in] imageType identifies the image format desired.
      //! @param [in] imageProjection identifies the projection desired.
      //! @param [in] buffer pointer the buffer
      //! @param [in] start position in the block to start writing
      //! @param [in] count size of desired chuck or buffer size
      //! @return Returns the number of bytes written
      int64_t WriteImage2DData( int64_t imageIndex, Image2DType imageType, Image2DProjection imageProjection,
                                void *buffer, int64_t start, int64_t count );

      //!@}

      //! @name Data3D
      //!@{

      //! @brief This function writes new Data3D header
      //! @details The user needs to config a Data3D structure with all the scanning information before making this
      //! call.
      //! @param [in,out] data3DHeader scan metadata
      //! @return Returns the index of the new scan's data3D block.
      int64_t NewData3D( Data3D &data3DHeader );

      //! @brief This function setups a writer to write the actual scan data
      //! @param [in] dataIndex index returned by NewData3D
      //! @param [in] pointCount Number of points to write (number of elements in each of the buffers)
      //! @param [in] buffers pointers to user-provided buffers
      //! @return returns a vector writer setup to write the selected scan data
      CompressedVectorWriter SetUpData3DPointsData( int64_t dataIndex, size_t pointCount,
                                                    const Data3DPointsData &buffers );

      //! @brief This function setups a writer to write the actual scan data
      //! @param [in] dataIndex index returned by NewData3D
      //! @param [in] pointCount Number of points to write (number of elements in each of the buffers)
      //! @param [in] buffers pointers to user-provided buffers
      //! @return returns a vector writer setup to write the selected scan data
      CompressedVectorWriter SetUpData3DPointsData( int64_t dataIndex, size_t pointCount,
                                                    const Data3DPointsData_d &buffers );

      //! @brief This function writes out the group data
      //! @param [in] dataIndex data block index given by the NewData3D
      //! @param [in] groupCount size of each of the buffers given
      //! @param [in] buffer of idElementValue index for this group
      //! @param [in] startPointIndex buffer with starting indices in to the "points" data vector for the groups
      //! @param [in] pointCount buffer with sizes of the groups given
      //! @return Return true if successful, false otherwise
      bool WriteData3DGroupsData( int64_t dataIndex, int64_t groupCount, int64_t *idElementValue,
                                  int64_t *startPointIndex, int64_t *pointCount );

      //!@}

      //! @name Foundation API file information
      //!@{

      //! @brief This function returns the file raw E57Root Structure Node
      StructureNode GetRawE57Root();
      //! @brief This function returns the raw Data3D Vector Node
      VectorNode GetRawData3D();
      //! @brief This function returns the raw Image2D Vector Node
      VectorNode GetRawImages2D();
      //! @brief This function returns the ram ImageFile Node which is need to add enhancements
      ImageFile GetRawIMF();

      //!@}

      //! @cond documentNonPublic   The following isn't part of the API, and isn't
      //! documented.
   protected:
      friend class WriterImpl;

      E57_OBJECT_IMPLEMENTATION( Writer ) // Internal implementation details, not part of API, must be last in object
      //! @endcond
   }; // end Writer class

} // end namespace e57