CMultiImage.h

Go to the documentation of this file.

//==============================================================================
/*
    Software License Agreement (BSD License)
    Copyright (c) 2003-2016, CHAI3D.
    (www.chai3d.org)

    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
    copyright notice, this list of conditions and the following
    disclaimer in the documentation and/or other materials provided
    with the distribution.

    * Neither the name of CHAI3D nor the names of its contributors may
    be used to endorse or promote products derived from this software
    without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE. 

    \author    <http://www.chai3d.org>
    \author    Sebastien Grange
    \version   3.2.0 $Rev: 2147 $
*/
//==============================================================================

//------------------------------------------------------------------------------
#ifndef CMultiImageH
#define CMultiImageH
//------------------------------------------------------------------------------
#include "graphics/CImage.h"
//------------------------------------------------------------------------------
#include <string>
#include <vector>
//------------------------------------------------------------------------------
namespace chai3d {
//------------------------------------------------------------------------------

//==============================================================================
//==============================================================================

//------------------------------------------------------------------------------
class cMultiImage;
typedef std::shared_ptr<cMultiImage> cMultiImagePtr;
//------------------------------------------------------------------------------

//==============================================================================
//==============================================================================
class cMultiImage : public cImage
{
    //--------------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //--------------------------------------------------------------------------

public:

    cMultiImage();

    virtual ~cMultiImage();

    static cMultiImagePtr create() { return (std::make_shared<cMultiImage>()); }


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - GENERAL COMMANDS:
    //--------------------------------------------------------------------------

public:

    cMultiImagePtr copy();

    bool allocate(const unsigned int a_width,
                  const unsigned int a_height,
                  const unsigned int a_slices,
                  const GLenum a_format = GL_RGB,
                  const GLenum a_type = GL_UNSIGNED_BYTE);

    void erase() { cleanup(); }

    virtual unsigned int getImageCount() const { return (unsigned int)(m_imageCount);  }

    bool convert(const unsigned int a_newFormat);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - MULTIMAGE SELECTION:
    //--------------------------------------------------------------------------

public:

    virtual unsigned long getCurrentIndex() { return m_currentIndex; }

    virtual bool selectImage(unsigned long a_index);

    bool addImage(cImage &a_image, unsigned long a_index=-1);

    bool removeImage(unsigned long a_index);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - MANIPULATING PIXELS:
    //--------------------------------------------------------------------------

public:

    virtual void setTransparentColor(const cColorb &a_color,
        const unsigned char a_transparencyLevel);

    virtual void setTransparentColor(const unsigned char a_r,
        const unsigned char a_g,
        const unsigned char a_b,
        const unsigned char a_transparencyLevel)  { cColorb color(a_r, a_g, a_b); setTransparentColor(color, a_transparencyLevel); }

    virtual void setTransparency(const unsigned char a_transparencyLevel);

    virtual void flipHorizontal();


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - MANIPULATING VOXELS:
    //--------------------------------------------------------------------------

public:

    virtual void getVoxelLocation(const cVector3d& a_texCoord, int& a_voxelX, int& a_voxelY, int& a_voxelZ, bool a_clampToImageSize = true) const;

    virtual void getVoxelLocationInterpolated(const cVector3d& a_texCoord, double& a_voxelX, double& a_voxelY, double& a_voxelZ, bool a_clampToImageSize = true) const;

    virtual unsigned char* getVoxelData(const unsigned int a_x,
        const unsigned int a_y,
        const unsigned int a_z) const;

    virtual bool getVoxelColor(const unsigned int a_x,
        const unsigned int a_y,
        const unsigned int a_z,
        cColorb& a_color) const;

    virtual bool getVoxelColor(const unsigned int a_x,
        const unsigned int a_y,
        const unsigned int a_z,
        cColorf& a_color) const;

    virtual bool getVoxelColorInterpolated(const double a_x,
        const double a_y,
        const double a_z,
        cColorb& a_color) const;

    virtual bool getVoxelColorInterpolated(const double a_x,
        const double a_y,
        const double a_z,
        cColorf& a_color) const;

    virtual void setVoxelColor(const unsigned int a_x,
        const unsigned int a_y,
        const unsigned int a_z,
        const cColorb& a_color);

    virtual void setVoxelColor(const unsigned int a_x,
        const unsigned int a_y,
        const unsigned int a_z,
        const unsigned char a_r,
        const unsigned char a_g,
        const unsigned char a_b) { cColorb color(a_r, a_g, a_b); setVoxelColor(a_x, a_y, a_z, color); }

    virtual void setVoxelColor(const unsigned int a_x,
        const unsigned int a_y,
        const unsigned int a_z,
        const unsigned char a_grayLevel);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - MEMORY DATA:
    //--------------------------------------------------------------------------

public:

    inline unsigned char* getArray() { return (m_array); }


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - FILES:
    //--------------------------------------------------------------------------

public:

    virtual bool loadFromFile(const std::string& a_filename);
    
    virtual int loadFromFiles(const std::vector<std::string>& a_filename);

    virtual int loadFromFiles(const std::string& a_basename, const std::string& a_extension, unsigned long a_max = 9999);

    virtual bool addFromFile(const std::string& a_filename, unsigned long a_index=-1);

    virtual bool saveToFiles(const std::string& a_basename, const std::string& a_extension);


    //--------------------------------------------------------------------------
    // PROTECTED  METHODS:
    //--------------------------------------------------------------------------

protected:

    void defaults();

    void cleanup();

    virtual bool addFromFilePrealloc(const std::string& a_filename, unsigned long a_index);

    bool addImagePrealloc(cImage &a_image, unsigned long a_index);


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS:
    //--------------------------------------------------------------------------

protected:

    unsigned char* m_array;

    unsigned long m_imageCount;

    unsigned long m_currentIndex;
};

//------------------------------------------------------------------------------
} // namespace chai3d
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
#endif
//------------------------------------------------------------------------------