UserImage.h

// UserImage.h:
// ------------
//

#ifndef __IPSDKIMAGE_USERIMAGE_H__
#define __IPSDKIMAGE_USERIMAGE_H__

// suppression warnings
// warning C4251: 'ipsdk::image::UserImage::_pUserImage' : class 'boost::shared_ptr<T>' needs to have dll-interface to be used by clients of class 'ipsdk::image::UserImage'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKImage/Image/BaseCompleteImage.h>
#include <IPSDKImage/Image/User/UserImageTypes.h>

namespace ipsdk {
namespace image {


class IPSDKIMAGE_API UserImage : public BaseCompleteImage
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITHOUT_COPY(IPSDKImage, UserImage);

    // friend class for protected members access
    friend boost::shared_ptr<UserImage> boost::make_shared<UserImage>();

// predefined public types
public:
    static const eImageType::domain g_imageType = eImageType::eIT_User;

protected:
    UserImage();

public:
    ~UserImage();
    
// methods
public:
    eImageType                      getImageType() const;

    ipBool                          isGpuImage() const;

    ipBool                          isDiskImage() const;

    virtual BoolResult              init(const UserImageAccessorPtr& pUserImageAccessor);

    virtual BoolResult                  init(const BaseImageGeometry& geometry);

    eImageAccessMode                getAccessMode() const;

    const BaseUserImageAccessor&    getUserImageAccessor() const;

    BoolResult                      resize(const BaseImageGeometry& geometry);

protected:
    void                            createImagePlans(const BaseImageGeometry& geometry,
                                                     PlanStorageColl3d& imagePlans);

    void                            clearDerived();

// attributes
protected:
    UserImageAccessorPtr    _pUserImageAccessor;
};


inline eImageType
UserImage::getImageType() const
{
    return g_imageType;
}

inline ipBool
UserImage::isGpuImage() const
{
    return false;
}

inline ipBool
UserImage::isDiskImage() const
{
    return false;
}


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_USERIMAGE_H__