BaseImageGeometry.h

// BaseImageGeometry.h:
// --------------------
//

#ifndef __IPSDKIMAGE_BASEIMAGEGEOMETRY_H__
#define __IPSDKIMAGE_BASEIMAGEGEOMETRY_H__

// suppression warnings
// warning C4251: 'ipsdk::image::BaseImageGeometry::_imageBufferType' : class 'ipsdk::image::eImageBufferType' needs to have dll-interface to be used by clients of class 'ipsdk::image::BaseImageGeometry'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKImage/IPSDKImageExports.h>
#include <IPSDKImage/Geometry/Component/VolumeGeometry.h>
#include <IPSDKImage/Geometry/Component/ColorGeometry.h>
#include <IPSDKImage/Geometry/Component/TemporalGeometry.h>
#include <IPSDKImage/Geometry/Plan/ImagePlanGeometry.h>
#include <IPSDKImage/Geometry/ImageGeometryTypes.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>

namespace ipsdk {
namespace image {


class IPSDKIMAGE_API BaseImageGeometry : public BaseSerializationObject
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITH_COPY(IPSDKImage, BaseImageGeometry)

    // friend class for protected access
    friend class BaseCompleteImage;
    friend class DiskPlanStorage;
    friend class UserPlanStorage;

public:
    BaseImageGeometry();
    virtual ~BaseImageGeometry() = 0;

// methods
public:
    virtual eImageGeometryType      getImageGeometryType() const = 0;

    bool                            isInit() const;

    const VolumeGeometry&           getVolumeGeometry() const;
    VolumeGeometry&                 getVolumeGeometry();
    const eVolumeGeometryType&      getVolumeGeometryType() const;
    ipUInt64                        getSizeZ() const;

    const ColorGeometry&            getColorGeometry() const;
    ColorGeometry&                  getColorGeometry();
    const eColorGeometryType&       getColorGeometryType() const;
    ipUInt64                        getSizeC() const;

    const TemporalGeometry&         getTemporalGeometry() const;
    TemporalGeometry&               getTemporalGeometry();
    const eTemporalGeometryType&    getTemporalGeometryType() const;
    ipUInt64                        getSizeT() const;

    ipUInt64                        getSizeX() const;
    ipUInt64                        getSizeY() const;

    ipUInt64                        getNbTotPlans() const;

    bool                            isValidPlanIdx(const ipUInt64 zPlanIdx,
                                                   const ipUInt64 cPlanIdx,
                                                   const ipUInt64 tPlanIdx) const;
    bool                            isValidPlanIdx(const PlanIndex& planIdx) const;

    bool                            isValidPixelIdx(const ipUInt64 x,
                                                    const ipUInt64 y) const;

    ipUInt64                        getNbPixels() const;

    ipUInt64                        getFullMemorySize() const;

    const eImageBufferType&         getBufferType() const;

    virtual const eImageBufferType& getBufferType(const ipUInt64 tPlanIdx) const;

    void                            resize(const VolumeGeometry& volumeGeometry,
                                           const ColorGeometry& colorGeometry,
                                           const TemporalGeometry& temporalGeometry,
                                           const ipUInt64 sizeX,
                                           const ipUInt64 sizeY);

    virtual void                    resize(const VolumeGeometry& volumeGeometry,
                                           const ColorGeometry& colorGeometry,
                                           const TemporalGeometry& temporalGeometry,
                                           const ipUInt64 sizeX,
                                           const ipUInt64 sizeY,
                                           const eImageBufferType& imageBufferType);

    virtual void                    setImageBufferType(const eImageBufferType& imageBufferType);

    ImagePlanGeometry               getPlanGeometry(const ipUInt64 tPlanIdx) const;

    ipUInt64                        getPlanNbPixels() const;

    ipUInt64                        getPlanMemorySize(const ipUInt64 tPlanIdx = 0) const;

    void                            setVolumeGeometryType(const eVolumeGeometryType& vType);
    void                            setColorGeometryType(const eColorGeometryType& cType);
    void                            setTemporalGeometryType(const eTemporalGeometryType& tType);

    void                            clear();

protected:
    void                            initBase(const VolumeGeometry& volumeGeometry,
                                             const ColorGeometry& colorGeometry,
                                             const TemporalGeometry& temporalGeometry,
                                             const ipUInt64 sizeX,
                                             const ipUInt64 sizeY,
                                             const eImageBufferType& imageBufferType);

    virtual void                    clearDerived() {}

// attributes
private:
    VolumeGeometry      _volumeGeometry;

    ColorGeometry       _colorGeometry;

    TemporalGeometry    _temporalGeometry;

    ipUInt64            _sizeX;
    ipUInt64            _sizeY;

    eImageBufferType    _imageBufferType;

    bool                _bInit;
};


inline bool
BaseImageGeometry::isInit() const
{
    return _bInit;
}


} // end of namespace image
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGEGEOMETRY_H__