Coin: SoImage.h Source File

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

SoImage.h
1#ifndef COIN_SOIMAGE_H
2#define COIN_SOIMAGE_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/nodes/SoSubNode.h>
37#include <Inventor/nodes/SoShape.h>
38#include <Inventor/fields/SoSFInt32.h>
39#include <Inventor/fields/SoSFEnum.h>
40#include <Inventor/fields/SoSFImage.h>
41#include <Inventor/fields/SoSFString.h>
42
43class SoSensor;
44class SoFieldSensor;
45class SbImage;
46
47 class COIN_DLL_API SoImage : public SoShape {
48 typedef SoShape inherited;
49
50 SO_NODE_HEADER(SoImage);
51
52public:
53 static void initClass(void);
54 SoImage(void);
55
56 enum VertAlignment {
57 BOTTOM,
58 HALF,
59 TOP
60 };
61
62 enum HorAlignment {
63 LEFT,
64 CENTER,
65 RIGHT
66 };
67
68 SoSFInt32 width;
69 SoSFInt32 height;
70 SoSFEnum vertAlignment;
71 SoSFEnum horAlignment;
72 SoSFImage image;
73 SoSFString filename;
74
75 virtual void GLRender(SoGLRenderAction * action);
76 virtual void rayPick(SoRayPickAction * action);
77 virtual void getPrimitiveCount(SoGetPrimitiveCountAction * action);
78
79protected:
80 virtual ~SoImage();
81
82 virtual void generatePrimitives(SoAction * action);
83 virtual void computeBBox(SoAction * action, SbBox3f & box, SbVec3f & center);
84
85 virtual SbBool readInstance(SoInput * in, unsigned short flags);
86 virtual void notify(SoNotList * list);
87 int getReadStatus(void);
88 void setReadStatus(SbBool flag);
89
90private:
91 SbVec2s getSize(void) const;
92 static SbVec3f getNilpoint(SoState *state);
93 void getQuad(SoState *state, SbVec3f &v0, SbVec3f &v1,
94 SbVec3f &v2, SbVec3f &v3);
95
96 const unsigned char * getImage(SbVec2s & size, int & nc);
97 SbBool loadFilename(void);
98 SbBool readstatus;
99 SbImage * resizedimage;
100 SbBool resizedimagevalid;
101 class SoFieldSensor * filenamesensor;
102 SbBool transparency;
103 SbBool testtransparency;
104 void testTransparency(void);
105 static void filenameSensorCB(void *, SoSensor *);
106};
107
108#endif // !COIN_SOIMAGE_H
SbBox3f
The SbBox3f class is an abstraction for an axis aligned 3 dimensional box.
Definition SbBox3f.h:46
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
SbVec3f
The SbVec3f class is a 3 dimensional vector with floating point coordinates.
Definition SbVec3f.h:51
SoAction
The SoAction class is the base class for all traversal actions.
Definition SoAction.h:77
SoFieldSensor
The SoFieldSensor class detects changes to a field.
Definition SoFieldSensor.h:38
SoGLRenderAction
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition SoGLRenderAction.h:50
SoGetPrimitiveCountAction
The SoGetPrimitiveCountAction class counts the primitives in a scene.
Definition SoGetPrimitiveCountAction.h:44
SoImage::image
SoSFImage image
Definition SoImage.h:72
SoImage::VertAlignment
VertAlignment
Definition SoImage.h:56
SoImage::TOP
@ TOP
Definition SoImage.h:59
SoImage::HALF
@ HALF
Definition SoImage.h:58
SoImage::BOTTOM
@ BOTTOM
Definition SoImage.h:57
SoImage::getReadStatus
int getReadStatus(void)
Definition SoImage.cpp:668
SoImage::setReadStatus
void setReadStatus(SbBool flag)
Definition SoImage.cpp:677
SoImage::height
SoSFInt32 height
Definition SoImage.h:69
SoImage::filename
SoSFString filename
Definition SoImage.h:73
SoImage::horAlignment
SoSFEnum horAlignment
Definition SoImage.h:71
SoImage::HorAlignment
HorAlignment
Definition SoImage.h:62
SoImage::RIGHT
@ RIGHT
Definition SoImage.h:65
SoImage::LEFT
@ LEFT
Definition SoImage.h:63
SoImage::CENTER
@ CENTER
Definition SoImage.h:64
SoImage::width
SoSFInt32 width
Definition SoImage.h:68
SoImage::vertAlignment
SoSFEnum vertAlignment
Definition SoImage.h:70
SoImage::SoImage
SoImage(void)
Definition SoImage.cpp:254
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoNode::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoNode.cpp:1542
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoRayPickAction
The SoRayPickAction class does ray intersection with scene graphs.
Definition SoRayPickAction.h:50
SoSFEnum
The SoSFEnum class is a container for an enum value.
Definition SoSFEnum.h:40
SoSFImage
The SoSFImage class is used to store pixel images.
Definition SoSFImage.h:42
SoSFInt32
The SoSFInt32 class is a container for a 32-bit integer value.
Definition SoSFInt32.h:39
SoSFString
The SoSFString class is a container for an SbString.
Definition SoSFString.h:40
SoSensor
The SoSensor class is the abstract base class for all sensors.
Definition SoSensor.h:43
SoShape::SoShape
SoShape(void)
Definition SoShape.cpp:350
SoShape::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoShape.cpp:368
SoShape::getPrimitiveCount
virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action)
Definition SoShape.cpp:1354
SoShape::generatePrimitives
virtual void generatePrimitives(SoAction *action)=0
SoShape::notify
virtual void notify(SoNotList *nl)
Definition SoShape.cpp:1426
SoShape::GLRender
virtual void GLRender(SoGLRenderAction *action)
Definition SoShape.cpp:400
SoShape::computeBBox
virtual void computeBBox(SoAction *action, SbBox3f &box, SbVec3f &center)=0
SoShape::rayPick
virtual void rayPick(SoRayPickAction *action)
Definition SoShape.cpp:453
SoState
The SoState class manages the Coin scene graph traversal state data.
Definition SoState.h:44
SO_NODE_HEADER
#define SO_NODE_HEADER(classname)
Definition Coin_macros.dox:50