xypor/index.php

/*

    SPDX-FileCopyrightText: 2007 James B. Bowlin <bowlin@mindspring.com>

    SPDX-License-Identifier: BSD-3-Clause AND GPL-2.0-or-later

*/


#ifndef MESH_BUFFER_H

#define MESH_BUFFER_H


#include "typedef.h"


class HTMesh;


/** @class MeshBuffer

 * The sole purpose of a MeshBuffer is to hold storage space

 * for the results of an HTM inetersection and then allow multiple

 * MeshIterator's to walk through the result set.  The buffer space is allocated

 * when the MeshBuffer is created.  Mesh buffers will usually hang around for

 * the life of an HTMesh.  Each mesh buffer is re-usable.  Simply reset() it and

 * then fill it by append()'ing trixels.  A MeshIterator grabs the size() and

 * the buffer() so it can iterate over the results.

 */


class MeshBuffer

{

  public:

    MeshBuffer(HTMesh *mesh);


    ~MeshBuffer();


    /** @short prepare the buffer for a new result set

         */

    void reset() { m_size = m_error = 0; }


    /** @short add trixels to the buffer

         */

    int append(Trixel trixel);


    /** @short the location of the buffer for reading

         */

    const Trixel *buffer() const { return m_buffer; }


    /** @short the number of trixels in the result set

         */

    int size() const { return m_size; }


    /** @short returns the number of trixels that would have overflowed the

         * buffer.

         */

    int error() const { return m_error; }


    /** @short fills the buffer with consecutive integers

         */

    void fill();


  private:

    Trixel *m_buffer;

    int m_size;

    int maxSize;

    int m_error;

};


#endif

HTMesh
HTMesh was originally intended to be a simple interface to the HTM library for the KStars project tha...
Definition HTMesh.h:57

MeshBuffer
The sole purpose of a MeshBuffer is to hold storage space for the results of an HTM inetersection and...
Definition MeshBuffer.h:24

MeshBuffer::error
int error() const
returns the number of trixels that would have overflowed the buffer.
Definition MeshBuffer.h:49

MeshBuffer::buffer
const Trixel * buffer() const
the location of the buffer for reading
Definition MeshBuffer.h:40

MeshBuffer::size
int size() const
the number of trixels in the result set
Definition MeshBuffer.h:44

MeshBuffer::reset
void reset()
prepare the buffer for a new result set
Definition MeshBuffer.h:32

MeshBuffer::fill
void fill()
fills the buffer with consecutive integers
Definition MeshBuffer.cpp:37

MeshBuffer::append
int append(Trixel trixel)
add trixels to the buffer
Definition MeshBuffer.cpp:26