Coin: SoSFImage3.h Source File

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

SoSFImage3.h
1#ifndef COIN_SOSFIMAGE3_H
2#define COIN_SOSFIMAGE3_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/SbVec3s.h>
39
40 class COIN_DLL_API SoSFImage3 : public SoSField {
41 typedef SoSField inherited;
42
43 SO_SFIELD_CONSTRUCTOR_HEADER(SoSFImage3);
44 SO_SFIELD_REQUIRED_HEADER(SoSFImage3);
45
46public:
47 static void initClass(void);
48
49 const unsigned char *getValue(SbVec3s &size, int &nc) const;
50 void setValue(const SbVec3s &size, const int nc,
51 const unsigned char *bytes);
52
53 int operator==(const SoSFImage3 & field) const;
54 int operator!=(const SoSFImage3 & field) const {
55 return ! operator == (field);
56 }
57
58 unsigned char * startEditing(SbVec3s &size, int &nc);
59 void finishEditing(void);
60
61private:
62 virtual SbBool readValue(SoInput *in);
63 virtual void writeValue(SoOutput *out) const;
64
65 class SbImage *image;
66};
67
68#endif // !COIN_SOSFIMAGE3_H
SbImage
The SbImage class is an abstract data type for 2D and 3D images.
Definition SbImage.h:46
SbVec3s
The SbVec3s class is a 3 dimensional vector with short integer coordinates.
Definition SbVec3s.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
SoSFImage3
The SoSFImage3 class is used to store 3D (volume) images.
Definition SoSFImage3.h:40
SoSFImage3::operator!=
int operator!=(const SoSFImage3 &field) const
Definition SoSFImage3.h:54
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