ImagePlanGeometry.h

// ImagePlanGeometry.h:
// --------------------
//

#ifndef __IPSDKIMAGE_IMAGEPLANGEOMETRY_H__
#define __IPSDKIMAGE_IMAGEPLANGEOMETRY_H__

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

#include <IPSDKImage/IPSDKImageExports.h>
#include <IPSDKImage/Image/ImageTypes.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>

namespace ipsdk {
namespace image {


class IPSDKIMAGE_API ImagePlanGeometry : public BaseSerializationObject
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKImage, ImagePlanGeometry)

public:
    ImagePlanGeometry();
    ~ImagePlanGeometry();

// methods
public:
    bool                        isInit() const;

    void                        init(const ipUInt64 sizeX,
                                     const ipUInt64 sizeY,
                                     const eImageBufferType& imageBufferType);

    ipUInt64                    getSizeX() const;

    ipUInt64                    getSizeY() const;

    ipUInt64                    getNbPixels() const;

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

    const eImageBufferType&     getBufferType() const;

    ipUInt64                    getFullMemorySize() const;

    void                        resize(const ipUInt64 sizeX,
                                       const ipUInt64 sizeY);

    void                        resize(const ipUInt64 sizeX,
                                       const ipUInt64 sizeY,
                                       const eImageBufferType& imageBufferType);

    void                        setImageBufferType(const eImageBufferType& imageBufferType);

    void                        clear();

// attributes
protected:
    ipUInt64            _sizeX;

    ipUInt64            _sizeY;

    eImageBufferType    _imageBufferType;

    bool                _bInit;
};


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


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_IMAGEPLANGEOMETRY_H__