Logo Search packages:      
Sourcecode: blender version File versions  Download package

BSP_CSGUserData.h

/**
 * $Id: BSP_CSGUserData.h,v 1.7 2005/10/28 20:18:56 intrr Exp $
 * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version. The Blender
 * Foundation also sells licenses for use in proprietary software under
 * the Blender License.  See http://www.blender.org/BL/ for information
 * about this.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL/BL DUAL LICENSE BLOCK *****
 */

#ifndef BSP_CSGUserData_h
#define BSP_CSGUserData_h

#include <vector>

/**
 * This data represents a continuous block of 
 * data of unknown type. This holds the user
 * data during a BSP operation.
 */

00043 class BSP_CSGUserData 
{
public :

      /**
       * width defines the size in bytes of a
       * single element (record) of user data
       */

      BSP_CSGUserData(
            const int width
      );

      /**
       * Reserve some space in the array
       */
            void
      Reserve(
            int size
      );

      /**
       * Add a new uninitialized record to the end of the 
       * array
       */

            void
      IncSize(
      );

      /**
       * duplicate a recod and insert it into the end of the array
       * returns the index of the new record. Make sure that the
       * record does not belong to this buffer as this can cause errors.
       */

            int
      Duplicate(
            void *
      );

            void
      Duplicate(
            int record_index
      );

      /**
       * Copies the record at position pos in the array to the
       * memory pointed to by output
       */

            void
      Copy(
            void *output,
            int pos
      );    

      /// Return the width of an individual record

            int
      Width(
      ) const;


      /// return the current number of records stored in the array.
            int
      Size(
      ) const;


      /// return a pointer to the start of the nth record in the array.

            void *
      operator [] (
            const int pos
      );

private :

      /// Private - force use of public constructor only.

      BSP_CSGUserData(
      );


      /// The block of data.
00129       std::vector<char> m_data;
      /// The width of a record in this array.
00131       int m_width;
};


#endif


Generated by  Doxygen 1.6.0   Back to index