ROI.h

Go to the documentation of this file.

#ifndef ROI_H
#define ROI_H
 
#include <string>
#include "Utility/Types.h"
 
namespace SocCamera
{
 
class ROI
{
public:
    ROI(int32_t anStartRow,
        int32_t anStartColumn,
        int32_t anWidth,
        int32_t anHeight);
 
    ROI();
 
    int32_t x() const { return mnStartColumn; }
    int32_t y() const { return mnStartRow; }
    int32_t width() const { return mnWidth; }
    int32_t height() const { return mnHeight; }
 
    int32 mnStartRow; // Related to the y-axis (vertical)
    int32 mnStartColumn; // Related to the x-axis (horizontal)
    int32 mnWidth; // Related to the x-axis (horizontal)
    int32 mnHeight; // Related to the y-axis (vertical)
 
    int32_t getEndRow() const { return mnStartRow + mnHeight - 1; }
 
    int32_t getEndColumn() const { return mnStartColumn + mnWidth - 1; }
 
    std::string toString() const;
 
    // Validation functions
 
    bool validateNonZero() const { return mnStartRow >= 0 && mnStartColumn >= 0 && mnWidth > 0 && mnHeight > 0; }
 
    bool validateBounds(int32_t anMaxWidth, int32_t anMaxHeight) const {
        // Total size of frame within bounds
        return (mnHeight + mnStartRow) <= anMaxHeight &&
                (mnWidth + mnStartColumn) <= anMaxWidth;
    }
 
    bool validateWidthIsMultiple(int32_t anStartColumnMultiple, int32_t anWidthMultiple) const {
        return (mnStartColumn % anStartColumnMultiple) == 0 &&
                (mnWidth % anWidthMultiple) == 0;
    }
 
    bool validateWidthIsMultiple(int32_t anMultiple) const { return validateWidthIsMultiple(anMultiple, anMultiple); }
 
    bool validateHeightIsMultiple(int32_t anStartRowMultiple, int32_t anHeightMultiple) const {
        return (mnStartRow % anStartRowMultiple) == 0 &&
                (mnHeight % anHeightMultiple) == 0;
    }
 
    bool validateHeightIsMultiple(int32_t anMultiple) const { return validateHeightIsMultiple(anMultiple, anMultiple); }
 
    bool validateWidthIsCentered(int32_t anMaxWidth) const { return (mnWidth + (2 * mnStartColumn)) == anMaxWidth; }
 
    bool validateHeightIsCentered(int32_t anMaxHeight) const { return (mnHeight + (2 * mnStartRow)) == anMaxHeight; }
};
 
}
 
#endif // ROI_H