NDEVR
API Documentation
QCustomImage.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Widgets
28File: QCustomImage
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/Image.h>
34#include <QImage>
35namespace NDEVR
36{
41 class QCustomImage : public Image
42 {
43 public:
48 {}
49
53 QCustomImage(const QImage& image)
54 {
55 m_image = image;
56 }
57
61 void setImage(const QImage& image)
62 {
63 m_image = image;
64 }
65
69 const QImage& qImage() const
70 {
71 return m_image;
72 }
73
77 QImage& qImage()
78 {
79 return m_image;
80 }
81
87 uint01* scanLine(uint04 index) final override
88 {
89 return m_image.scanLine(index);
90 }
91
95 Vector<2, uint04> size() const final override
96 {
97 return Vector<2, uint04>(m_image.width(), m_image.height());
98 }
99
100 QImage m_image;
101 };
102}
A root class that stores an an array of pixel data that can be displayed as an Image.
Definition Image.h:40
uint01 * scanLine(uint04 index) final override
Returns a pointer to the pixel data of the specified scan line.
QCustomImage()
Constructs an empty QCustomImage.
Vector< 2, uint04 > size() const final override
Returns the width and height of the image.
QImage m_image
The underlying Qt image data.
QCustomImage(const QImage &image)
Constructs a QCustomImage from an existing QImage.
const QImage & qImage() const
Returns a const reference to the underlying QImage.
void setImage(const QImage &image)
Sets the underlying QImage.
QImage & qImage()
Returns a mutable reference to the underlying QImage.
A fixed-size array with N dimensions used as the basis for geometric and mathematical types.
Definition Vector.hpp:62
The primary namespace for the NDEVR SDK.
uint32_t uint04
-Defines an alias representing a 4 byte, unsigned integer -Can represent exact integer values 0 throu...
uint8_t uint01
-Defines an alias representing a 1 byte, unsigned integer -Can represent exact integer values 0 throu...