Coin: SoShape.h Source File

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

SoShape.h
1#ifndef COIN_SOSHAPE_H
2#define COIN_SOSHAPE_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/elements/SoMultiTextureCoordinateElement.h>
38#include <Inventor/SbMatrix.h>
39#include <Inventor/SbVec2s.h>
40#include <Inventor/SbBox3f.h>
41
42class SoPrimitiveVertex;
43class SoDetail;
44class SoPickedPoint;
45class SoFaceDetail;
46class SoState;
47class SoCoordinateElement;
48class SbVec2f;
49class SoMaterialBundle;
50class SoBoundingBoxCache;
51
52 class COIN_DLL_API SoShape : public SoNode {
53 typedef SoNode inherited;
54
55 SO_NODE_ABSTRACT_HEADER(SoShape);
56
57public:
58 static void initClass(void);
59
60 enum TriangleShape {
61 TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON,
62 // The rest of the enums are not part of the original Inventor API.
63 QUADS, QUAD_STRIP, POINTS, LINES, LINE_STRIP
64 };
65
66 virtual SbBool affectsState(void) const;
67 virtual void notify(SoNotList * nl);
68
69 virtual void getBoundingBox(SoGetBoundingBoxAction * action);
70 virtual void GLRender(SoGLRenderAction * action);
71 virtual void rayPick(SoRayPickAction * action);
72 virtual void callback(SoCallbackAction * action);
73 virtual void computeBBox(SoAction * action, SbBox3f & box,
74 SbVec3f & center) = 0;
75 virtual void getPrimitiveCount(SoGetPrimitiveCountAction * action);
76
77 static void getScreenSize(SoState * const state, const SbBox3f & boundingbox,
78 SbVec2s & rectsize);
79 static float getDecimatedComplexity(SoState * state, float complexity);
80 const SoBoundingBoxCache * getBoundingBoxCache(void) const;
81
82protected:
83 SoShape(void);
84 virtual ~SoShape();
85
86 float getComplexityValue(SoAction * action);
87 virtual void generatePrimitives(SoAction * action) = 0;
88 virtual SbBool shouldGLRender(SoGLRenderAction * action);
89 void beginSolidShape(SoGLRenderAction * action);
90 void endSolidShape(SoGLRenderAction * action);
91 void GLRenderBoundingBox(SoGLRenderAction * action);
92 SbBool shouldPrimitiveCount(SoGetPrimitiveCountAction * action);
93
94 SbBool shouldRayPick(SoRayPickAction * const action);
95 void computeObjectSpaceRay(SoRayPickAction * const action);
96 void computeObjectSpaceRay(SoRayPickAction * const action,
97 const SbMatrix & matrix);
98 virtual SoDetail * createTriangleDetail(SoRayPickAction * action,
99 const SoPrimitiveVertex * v1,
100 const SoPrimitiveVertex * v2,
101 const SoPrimitiveVertex * v3,
102 SoPickedPoint * pp);
103 virtual SoDetail * createLineSegmentDetail(SoRayPickAction * action,
104 const SoPrimitiveVertex * v1,
105 const SoPrimitiveVertex * v2,
106 SoPickedPoint * pp);
107 virtual SoDetail * createPointDetail(SoRayPickAction * action,
108 const SoPrimitiveVertex * v,
109 SoPickedPoint * pp);
110
111 void invokeTriangleCallbacks(SoAction * const action,
112 const SoPrimitiveVertex * const v1,
113 const SoPrimitiveVertex * const v2,
114 const SoPrimitiveVertex * const v3);
115 void invokeLineSegmentCallbacks(SoAction * const action,
116 const SoPrimitiveVertex * const v1,
117 const SoPrimitiveVertex * const v2);
118 void invokePointCallbacks(SoAction * const action,
119 const SoPrimitiveVertex * const v);
120 void beginShape(SoAction * const action, const TriangleShape shapetype,
121 SoDetail * const detail = NULL);
122 void shapeVertex(const SoPrimitiveVertex * const v);
123 void endShape(void);
124
125 void generateVertex(SoPrimitiveVertex * const pv,
126 const SbVec3f & point,
127 const SbBool useTexFunc,
128 const SoMultiTextureCoordinateElement * const tce,
129 const float s,
130 const float t,
131 const SbVec3f & normal);
132 void generateVertex(SoPrimitiveVertex * const pv,
133 const SbVec3f & point,
134 const SbBool useTexFunc,
135 const SoMultiTextureCoordinateElement * const tce,
136 const float s,
137 const float t,
138 const float r,
139 const SbVec3f & normal);
140
141 SbBool startVertexArray(SoGLRenderAction * action,
142 const SoCoordinateElement * coords,
143 const SbVec3f * pervertexnormals,
144 const SbBool texpervertex,
145 const SbBool colorpervertex);
146
147 void finishVertexArray(SoGLRenderAction * action,
148 const SbBool vbo,
149 const SbBool normpervertex,
150 const SbBool texpervertex,
151 const SbBool colorpervertex);
152private:
153 class SoShapeP * pimpl;
154 void validatePVCache(SoGLRenderAction * action);
155 void getBBox(SoAction * action, SbBox3f & box, SbVec3f & center);
156 void rayPickBoundingBox(SoRayPickAction * action);
157 friend class soshape_primdata; // internal class
158 friend class so_generate_prim_private; // a very private class
159};
160
161#endif // !COIN_SOSHAPE_H
SbBox3f
The SbBox3f class is an abstraction for an axis aligned 3 dimensional box.
Definition SbBox3f.h:46
SbMatrix
The SbMatrix class is a 4x4 dimensional representation of a matrix.
Definition SbMatrix.h:47
SbVec2f
The SbVec2f class is a 2 dimensional vector with floating point coordinates.
Definition SbVec2f.h:49
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
SoBoundingBoxCache
The SoBoundingBoxCache class is used to cache bounding boxes.
Definition SoBoundingBoxCache.h:41
SoCallbackAction
The SoCallbackAction class invokes callbacks at specific nodes.
Definition SoCallbackAction.h:80
SoCoordinateElement
The SoCoordinateElement class is yet to be documented.
Definition SoCoordinateElement.h:40
SoDetail
The SoDetail class is the superclass for all classes storing detailed information about particular sh...
Definition SoDetail.h:39
SoFaceDetail
The SoFaceDetail class is for storing detailed polygon information.
Definition SoFaceDetail.h:38
SoGLRenderAction
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition SoGLRenderAction.h:50
SoGetBoundingBoxAction
The SoGetBoundingBoxAction class calculates bounding boxes for nodes and subgraphs.
Definition SoGetBoundingBoxAction.h:45
SoGetPrimitiveCountAction
The SoGetPrimitiveCountAction class counts the primitives in a scene.
Definition SoGetPrimitiveCountAction.h:44
SoMaterialBundle
The SoMaterialBundle class simplifies material handling.
Definition SoMaterialBundle.h:42
SoMultiTextureCoordinateElement
The SoMultiTextureCoordinateElement class is yet to be documented.
Definition SoMultiTextureCoordinateElement.h:48
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoNode::notify
virtual void notify(SoNotList *l)
Definition SoNode.cpp:506
SoNode::getPrimitiveCount
virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action)
Definition SoNode.cpp:943
SoNode::getBoundingBox
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition SoNode.cpp:914
SoNode::callback
virtual void callback(SoCallbackAction *action)
Definition SoNode.cpp:1075
SoNode::affectsState
virtual SbBool affectsState(void) const
Definition SoNode.cpp:880
SoNode::rayPick
virtual void rayPick(SoRayPickAction *action)
Definition SoNode.cpp:1188
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoNode::GLRender
virtual void GLRender(SoGLRenderAction *action)
Definition SoNode.cpp:1003
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoPickedPoint
The SoPickedPoint class is used for specifying picked points.
Definition SoPickedPoint.h:48
SoPrimitiveVertex
The SoPrimitiveVertex class represents a single vertex of a generated primitive.
Definition SoPrimitiveVertex.h:43
SoRayPickAction
The SoRayPickAction class does ray intersection with scene graphs.
Definition SoRayPickAction.h:50
SoShape::endShape
void endShape(void)
Definition SoShape.cpp:1292
SoShape::invokePointCallbacks
void invokePointCallbacks(SoAction *const action, const SoPrimitiveVertex *const v)
Definition SoShape.cpp:1176
SoShape::createPointDetail
virtual SoDetail * createPointDetail(SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp)
Definition SoShape.cpp:977
SoShape::shapeVertex
void shapeVertex(const SoPrimitiveVertex *const v)
Definition SoShape.cpp:1279
SoShape::invokeLineSegmentCallbacks
void invokeLineSegmentCallbacks(SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2)
Definition SoShape.cpp:1101
SoShape::endSolidShape
void endSolidShape(SoGLRenderAction *action)
Definition SoShape.cpp:869
SoShape::finishVertexArray
void finishVertexArray(SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex)
Definition SoShape.cpp:1705
SoShape::beginShape
void beginShape(SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL)
Definition SoShape.cpp:1264
SoShape::SoShape
SoShape(void)
Definition SoShape.cpp:350
SoShape::invokeTriangleCallbacks
void invokeTriangleCallbacks(SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3)
Definition SoShape.cpp:989
SoShape::computeObjectSpaceRay
void computeObjectSpaceRay(SoRayPickAction *const action)
Definition SoShape.cpp:878
SoShape::beginSolidShape
void beginSolidShape(SoGLRenderAction *action)
Definition SoShape.cpp:854
SoShape::generateVertex
void generateVertex(SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoMultiTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal)
Definition SoShape.cpp:1302
SoShape::createTriangleDetail
virtual SoDetail * createTriangleDetail(SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
Definition SoShape.cpp:909
SoShape::getBoundingBoxCache
const SoBoundingBoxCache * getBoundingBoxCache(void) const
Definition SoShape.cpp:1452
SoShape::createLineSegmentDetail
virtual SoDetail * createLineSegmentDetail(SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp)
Definition SoShape.cpp:944
SoShape::generatePrimitives
virtual void generatePrimitives(SoAction *action)=0
SoShape::shouldGLRender
virtual SbBool shouldGLRender(SoGLRenderAction *action)
Definition SoShape.cpp:560
SoShape::TriangleShape
TriangleShape
Definition SoShape.h:60
SoShape::getDecimatedComplexity
static float getDecimatedComplexity(SoState *state, float complexity)
Definition SoShape.cpp:1364
SoShape::shouldPrimitiveCount
SbBool shouldPrimitiveCount(SoGetPrimitiveCountAction *action)
Definition SoShape.cpp:1400
SoShape::GLRenderBoundingBox
void GLRenderBoundingBox(SoGLRenderAction *action)
Definition SoShape.cpp:1374
SoShape::shouldRayPick
SbBool shouldRayPick(SoRayPickAction *const action)
Definition SoShape.cpp:831
SoShape::computeBBox
virtual void computeBBox(SoAction *action, SbBox3f &box, SbVec3f &center)=0
SoShape::startVertexArray
SbBool startVertexArray(SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)
Definition SoShape.cpp:1563
SoShape::getComplexityValue
float getComplexityValue(SoAction *action)
Definition SoShape.cpp:520
SoShape::getScreenSize
static void getScreenSize(SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize)
Definition SoShape.cpp:472
SoState
The SoState class manages the Coin scene graph traversal state data.
Definition SoState.h:44
SO_NODE_ABSTRACT_HEADER
#define SO_NODE_ABSTRACT_HEADER(classname)
Definition Coin_macros.dox:61