Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoVolumeRender.h
Go to the documentation of this file.
1/*=======================================================================
2 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
3 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
4 *** ***
5 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
6 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
7 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
8 *** ***
9 *** RESTRICTED RIGHTS LEGEND ***
10 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
11 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
12 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
13 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
14 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
15 *** ***
16 *** COPYRIGHT (C) 1996-2023 BY FEI S.A.S, ***
17 *** BORDEAUX, FRANCE ***
18 *** ALL RIGHTS RESERVED ***
19**=======================================================================*/
20/*=======================================================================
21** Author : P. ESTRADE (Mar 2000)
22**=======================================================================*/
23#ifndef _SO_VOLUME_RENDER_
24#define _SO_VOLUME_RENDER_
25
26#include <Inventor/caches/SoCache.h>
37#include <Inventor/SbBox.h>
38
39#include <Inventor/STL/vector>
40#include <Inventor/STL/map>
41
43
44#include <VolumeViz/LDM/SoLDMTileID.h>
45
46class SbProjection;
47class SoFrameBufferObject;
48class SoGLProgramGLSL;
49class SoGLTexture;
50class SoVRImageSpaceEffects;
51class SoLDMTileID;
52class SoLdmSubDivisionIsosurfacePolicy;
53class SoLdmSubDivisionPolicy;
54class SoLdmSubDivisionTransferFunctionPolicy;
55class SoShaderProgram;
56class SoVolumeGroup;
58class SoVolumeRenderInterface;
59class SoVolumeRenderRaycast;
60class SoVolumeRenderLdm;
61class SoVolumeRenderLdm;
62class SoVolumeRenderPaging;
64class SoVolumeStateVr;
66class SoNodeSensor;
67class SoVolumeOffscreenImpl;
68
69#ifdef _WIN32
70#pragma warning( push )
71#pragma warning(disable:4251)
72#endif
73
794
795 public:
796
819
820
865
897
911
921
940
949
950
968
980
998
1009
1081
1089
1123
1152
1170
1175
1194
1198 typedef AbortCode SoVolumeRenderAbortCB(int totalElems, int thisElem, void *userData);
1199
1219 void setAbortCallback( SoVolumeRenderAbortCB *func, void *userData = NULL);
1220
1221
1222#if 1 SoDEPRECATED
1243SoDEPRECATED
1250SoDEPRECATED
1257
1258#endif
1260#if 1 SoDEPRECATED
1270
1271#endif
1273/*****************************************************************************/
1274private:
1276 virtual void computeBBox(SoAction *, SbBox3f &box, SbVec3f &center);
1277
1279 virtual void rayPick(SoRayPickAction *action);
1280
1281/*****************************************************************************/
1282private:
1283
1285 static void initClass();
1286
1288 static void exitClass();
1289
1293 SoVolumeRenderingQuality* getVolumeRenderingQuality( SoState* state ) const;
1294
1298 SoVolumeOffscreenImpl* getVolumeOffscreenImpl() const;
1299
1300#if 1 SoDEPRECATED
1303
1304#endif
1308 bool needOivDepth(SoState* state);
1309
1314 bool needRttColor(SoState* state) const;
1315
1318 bool needRttEdgeDetect(SoState* state) const;
1319
1322 bool needRttBoundaryDepth(SoState* state) const;
1323
1326 bool needRttBoundaryColor(SoState* state) const;
1327
1329 SamplingAlignment getSamplingAlignment(SoState* state) const;
1330
1332 void removeDsFromRegList(SoDataSet* pDs);
1333
1335 virtual void notify(SoNotList *list);
1336
1340 void onUserInteractionChange(SoState*state, bool stopMoving);
1341
1342/*****************************************************************************/
1343 private:
1344 // Destructor
1345 virtual ~SoVolumeRender();
1346
1347 void createVolumeRender( SoState* state );
1348
1349 void generatePrimitives(SoAction *action);
1350
1351 void doRendering(SoGLRenderAction *action);
1352
1353 void setupVolumeRenderInterface(SoState* state);
1354
1355 SoDetail *createTriangleDetail(SoRayPickAction *,
1356 const SoPrimitiveVertex *v1,
1357 const SoPrimitiveVertex *,
1358 const SoPrimitiveVertex *,
1359 SoPickedPoint *);
1360
1365 void beginOffscreenRendering( SoGLRenderAction* action );
1366
1371 void endOffscreenRendering( SoGLRenderAction* action );
1372
1376 void setupFrontToBackGlState(SoState* state);
1377
1382 SbBool shouldGLRender(SoGLRenderAction *renderAction, SbBool isPointsOrLines);
1383
1384/*****************************************************************************/
1385SoINTERNAL private:
1386
1388 virtual void ldmAction(SoLdmValuationAction* action);
1389
1390/*****************************************************************************/
1391private:
1392
1393#if 1 SoDEPRECATED
1395 SoSFBool useEarlyZ;SoDEPRECATED
1397 SoSFInt32 numEarlyZPasses;SoDEPRECATED
1399 SoSFBool gpuVertexGen;
1400#endif
1403 void fillDetail(SoRayPickAction* rpa, SoVolumeRenderDetail* detail, const SoLDM::DataSetIdPair& idPair);
1404
1405 void genPrimDataSet(SoAction* action, const SoLDM::DataSetIdPair& idPair);
1406
1408 bool canSubdivideTiles(SoState* state);
1409
1411 bool isRaycastingEnabled(SoState* state) const;
1412
1413 SoVolumeRenderAbortCB *m_abortCBfunc;
1414 void *m_abortCBuserData;
1415 void GLRenderTex2D3D(SoGLRenderAction* action);
1416
1420 void useOffscreenRendering(SoGLRenderAction* action);
1421
1425 void initInternalShaders();
1426
1427 void setupDepthPeelingTextures(SoGLRenderAction *action);
1428
1429 void rayPickDataSet(SoRayPickAction* action, const SoLDM::DataSetIdPair& idPair);
1430
1432 SoVRImageSpaceEffects* m_imageSpaceEffects;
1433
1440 int m_vpScale;
1441
1444 int m_lowScreenResScale;
1445
1446 SoShaderParameter1i *m_opacityTex;
1447 SoGLProgramGLSL* m_binaryOpacityComposeShader;
1448
1449 SoShaderProgram* m_writeFragShader;
1450
1451 SoVolumeIsosurface* m_volumeIsosurface;
1452
1456 void deleteShadersFboTextures();
1457
1461 void updateLowResScale( SoState* state );
1462
1466 void registerCtxId(const SoLDM::DsVector &dsVector, int ctxId);
1467
1471 void unregisterCtxId(const SoLDM::DsVector &dsVector, int ctxId);
1472
1474 bool m_useLowResMove;
1475
1477 bool m_useLowNumSliceMove;
1478
1479 SoVolumeRenderLdm* m_vriLdm;
1480 SoVolumeRenderRaycast* m_vriRaycast;
1481 SoVolumeRenderInterface* m_vri;
1482
1483 bool m_frontToBackComposition;
1484
1485 // List of dataset gathered in previous valuation action
1486 SoLDM::DsVector m_prevDsList;
1487
1488 // Callback to manage deletion of dataset
1489 static void volDataDeleteCB(void* data, SoSensor *sensor);
1490
1491 // ctxId attached to this volumeRender. Set by ValuationAction.
1492 int m_prevRegisteredCtxId;
1493
1494 SoVolumeStateVr* m_vs;
1495
1496 SoVolumeOffscreenImpl* m_volumeOffscreenImpl;
1497
1498 // Associate a Node sensor to each DataSet managed
1499 std::map<SoDataSet*, SoNodeSensor*> m_mapDsSensor;
1500
1501 friend class SoVolumeRenderLdm;
1503
1504 SoRef<SoGroup> m_depthPeelingSG;
1505 SoRef<SoGroup> m_depthPeelingColorTexGroup;
1506 SoRef<SoTextureUnit> m_depthPeelingColorTexUnit;
1507 SoRef<SoGroup> m_depthPeelingDepthTexGroup;
1508 SoRef<SoTextureUnit> m_depthPeelingDepthTexUnit;
1509};
1510
1511#if defined(_WIN32)
1512#pragma warning( pop )
1513#endif
1514
1515#endif // _SO_VOLUME_RENDER_
1516
1517
#define SoINTERNAL
#define SO_NODE_HEADER(className)
Definition SoSubNode.h:151
3D box class.
Definition SbBox.h:649
Base class for coordinate projection classes.
3D vector class.
Definition SbVec.h:932
Abstract base class for all actions.
Definition SoAction.h:132
<a href="IconLegend.html"><img src="extLDM.gif" alt="Large Data Management" border="0"></a> Data set...
Definition SoDataSet.h:139
Base class for describing detail information about a shape node.
Definition SoDetail.h:99
Renders a scene graph using Open Inventor's Render Engine.
<a href="IconLegend.html"><img src="extLDM.gif" alt="Large Data Management" border="0"></a> Tile ID
Definition SoLDMTileID.h:63
friend class SoLdmValuationAction
Definition SoLdmShape.h:84
Multiple-value field containing any number of int32_t integers.
Definition SoMFInt32.h:88
Sensor class that can be attached to Open Inventor nodes.
Represents point on surface of picked object.
Represents a vertex of a generated primitive.
Intersects objects with a ray cast into scene.
Smart pointer for any class inheriting SoRefCounter.
Definition SoRef.h:90
Single-value field containing a set of bit flags.
Field containing a single Boolean value.
Definition SoSFBool.h:79
Field containing an enumerated value.
Definition SoSFEnum.h:89
Field containing a floating-point value.
Definition SoSFFloat.h:78
Field containing a int32_t integer.
Definition SoSFInt32.h:80
Field containing a three-dimensional vector.
Definition SoSFVec3f.h:80
Abstract base class for Open Inventor sensors.
Definition SoSensor.h:97
<a href="IconLegend.html"><img src="extTGS.gif" alt="VSG extension" border="0"></a> Uniform shader p...
<a href="IconLegend.html"><img src="extTGS.gif" alt="VSG extension" border="0"></a> Shader program p...
Traversal state.
Definition SoState.h:74
Groups multiple volumes to be volume rendered in the same scene.
<a href="IconLegend.html"><img src="extVR.gif" alt="VolumeViz" border="0"></a> Isosurface property n...
<a href="IconLegend.html"><img src="extVR.gif" alt="VolumeViz" border="0"></a> Stores detail informa...
<a href="IconLegend.html"><img src="extVR.gif" alt="VolumeViz" border="0"></a> Renders data volumes ...
SoSFEnum renderMode
Specifies how the voxels along each sampling ray are combined to form the final image.
SoSFInt32 numSlices
Specifies the number of samples along each ray.
SoVolumeRender()
Constructor.
SoSFBool subdivideTile
If true, LDM tiles will be subdivided for rendering.
NumSlicesControl
Number of samples control mode.
@ MANUAL
Use the number of samples specified by the numSlices field.
@ MAIN_AXIS
Use a number of samples computed as follows: n = complexity * 2 * volumeDataDimension[mainVisibl...
@ AUTOMATIC
(Recommended) Use a number of samples computed as follows: If numSlices is greater than zero,...
@ ALL
Use all samples The number of samples depends on the viewing direction.
SoSFEnum samplingAlignment
Specifies which technique to use to align rayCast samples.
friend class SoVolumeRenderLdm
AbortCode
Abort code for callback.
@ SKIP
The current slice is not drawn.
@ ABORT
The render action of the SoVolumeRender node is aborted.
@ CONTINUE
Continue rendering as usual.
SoDEPRECATED SoSFBool lighting
Indicates if lighting is required.
SoSFBool fixedNumSlicesInRoi
When this field is set to FALSE (the default), the number of samples set by numSlices is the number o...
SoDEPRECATED SoSFFloat lightIntensity
Light intensity in the range [0-1].
SoSFFloat opacityThreshold
Specifies a threshold opacity (alpha) value that defines voxels considered to be "solid" (non-transpa...
SoDEPRECATED SoSFBool viewAlignedSlices
Indicates if samples should be computed in a view-aligned manner.
SamplingAlignment
Sampling alignment.
@ VIEW_ALIGNED
Samples are located on planes perpendicular to the view direction.
@ BOUNDARY_ALIGNED
Samples are located on shells aligned with the volume's internal "boundary".
@ DATA_ALIGNED
Samples are located on planes perpendicular to one axis of the volume.
@ SMOOTH_BOUNDARY_ALIGNED
Similar to BOUNDARY_ALIGNED but uses a cubic interpolation to compute the boundary,...
SoSFBitMask lowResMode
Sets the method to use when moving in low resolution.
SoSFBool opacityCorrection
Controls whether opacity correction is done.
SoSFEnum numSlicesControl
Controls how the number of samples along each ray is determined.
LowResMode
Method to use when moving in low resolution.
@ DECREASE_SCREEN_RESOLUTION
Downscale the screen resolution of the volume when moving by the factor defined in lowScreenResolutio...
@ DECREASE_NONE
No low resolution mode when moving.
@ DECREASE_SLICES
Decrease the number of samples according to SoComplexity::value when moving.
SoSFInt32 projectedTileSubdivision
When doing volume projection (see SoProjection), only the geometry (corner vertices) of the LDM tiles...
void setAbortCallback(SoVolumeRenderAbortCB *func, void *userData=NULL)
Sets callback to call during texture map rendering to test for an abort condition.
friend class SoVolumeRenderRaycast
RenderMode
Composition mode.
@ MAX_INTENSITY_PROJECTION
Maximum intensity projection (MIP).
@ MAX_INTENSITY_DIFFERENCE_ACCUMULATION
Maximum Intensity Difference Accumulation (MIDA).
@ INTENSITY_DIFFERENCE_ACCUMULATION
Intensity Difference Accumulation.
@ MIN_INTENSITY_PROJECTION
Minimum intensity projection (MinIP).
@ AVERAGE_INTENSITY_PROJECTION
Average Intensity projection (AIP).
@ VOLUME_RENDERING
Alpha compositing (Default).
@ MAX_GRADIENT_DIFFERENCE_ACCUMULATION
Maximum Gradient Difference Accumulation.
@ SUM_INTENSITY_PROJECTION
Ray sum intensity projection (RSP).
@ GRADIENT_DIFFERENCE_ACCUMULATION
Gradient Difference Accumulation.
SoSFInt32 lowScreenResolutionScale
If lowResMode is DECREASE_SCREEN_RESOLUTION, render the volume at a lower screen resolution.
AbortCode SoVolumeRenderAbortCB(int totalElems, int thisElem, void *userData)
SoDEPRECATED SoSFVec3f lightDirection
Light direction (relative to the volume).
SoMFInt32 dataSetIds
Specifies the list of volumes on which volume rendering is applied.
<a href="IconLegend.html"><img src="extVR.gif" alt="VolumeViz" border="0"></a> Volume rendering qual...
<a href="IconLegend.html"><img src="extVR.gif" alt="VolumeViz" border="0"></a> Abstract base class f...
int SbBool
Boolean type.
Definition SbBase.h:87
std::pair< SoDataSet *, int > DataSetIdPair
Pair containing an SoDataset and its dataSetId.
Definition SoLDM.h:71
std::vector< SoDataSet * > DsVector
Vector of SoDataSet.
Definition SoLDM.h:56