Coin: SoSFImage.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoSFImage.h
1#ifndef COIN_SOSFIMAGE_H
2#define COIN_SOSFIMAGE_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/fields/SoSField.h>
37#include <Inventor/fields/SoSubField.h>
38#include <Inventor/SbVec2s.h>
39
40class SbImage;
41
42 class COIN_DLL_API SoSFImage : public SoSField {
43 typedef SoSField inherited;
44
45 SO_SFIELD_CONSTRUCTOR_HEADER(SoSFImage);
46 SO_SFIELD_REQUIRED_HEADER(SoSFImage);
47
48public:
49 enum CopyPolicy {
50 COPY,
51 NO_COPY,
52 NO_COPY_AND_DELETE,
53 NO_COPY_AND_FREE
54 };
55
56 static void initClass(void);
57
58 const unsigned char * getValue(SbVec2s & size, int & nc) const;
59 const SbImage & getValue() const;
60
61 void setValue(const SbVec2s & size, const int nc,
62 const unsigned char * pixels, CopyPolicy copypolicy = COPY);
63
64 int operator==(const SoSFImage & field) const;
65 int operator!=(const SoSFImage & field) const { return ! operator == (field); }
66
67 unsigned char * startEditing(SbVec2s & size, int & nc);
68 void finishEditing(void);
69
70 void setSubValue(const SbVec2s & dims, const SbVec2s & offset, unsigned char * pixels);
71 void setSubValues(const SbVec2s * dims, const SbVec2s * offsets, int num, unsigned char ** pixelblocks);
72 unsigned char * getSubTexture(int idx, SbVec2s & dims, SbVec2s & offset) const;
73 SbBool hasSubTextures(int & numsubtextures);
74
75 void setNeverWrite(SbBool flag);
76 SbBool isNeverWrite(void) const;
77
78 SbBool hasTransparency(void) const;
79
80private:
81 virtual SbBool readValue(SoInput * in);
82 virtual void writeValue(SoOutput * out) const;
83
84 class SoSFImageP * pimpl;
85};
86
87#endif // !COIN_SOSFIMAGE_H
SbImage
The SbImage class is an abstract data type for 2D and 3D images.
Definition SbImage.h:46
SbVec2s
The SbVec2s class is a 2 dimensional vector with short integer coordinates.
Definition SbVec2s.h:51
SoField::readValue
virtual SbBool readValue(SoInput *in)=0
SoField::operator==
int operator==(const SoField &f) const
Definition SoField.cpp:1639
SoField::writeValue
virtual void writeValue(SoOutput *out) const =0
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51
SoSFImage
The SoSFImage class is used to store pixel images.
Definition SoSFImage.h:42
SoSFImage::operator!=
int operator!=(const SoSFImage &field) const
Definition SoSFImage.h:65
SoSField
The SoSField class is the base class for fields which contains only a single value.
Definition SoSField.h:38
SoSField::initClass
static void initClass(void)
Definition SoSField.cpp:137