MeVisLabToolboxReference
SoView2DOverlay Class Reference

Draws an overlay image on the SoView2D. More...

#include <SoView2DOverlay.h>

Inheritance diagram for SoView2DOverlay:
SoView2DCallback SoView2DExtension

List of all members.

Public Member Functions

 SoView2DOverlay ()
 Constructor.
virtual void startDrawing (View2DSliceList *slicelist)
 reimplemented from SoView2DExtension
virtual void endDrawing (View2DSliceList *slicelist)
 reimplemented from SoView2DExtension
virtual void draw (View2DSliceList *dsl, View2DSlice *dslice, int slice)
 reimplemented from SoView2DExtension
virtual bool evalEvent (SoView2D *view2d, View2DSliceList *slicelist, View2DEvent *ec, View2DEventPhase phase)
 reimplemented from SoView2DExtension
void GLRender (SoGLRenderAction *action)
 reimplemented from SoNode, stores the LUT for later rendering

Static Public Member Functions

static void initClass ()
 inventor runtime type system

Public Attributes

SoSFMLImage image
 input image
SoSFBool cacheTextures
 flag if textures should be cached
SoSFEnum blendMode
 select the blend mode of the overlay
SoSFBool inheritFilterMode
 inherit filter mode
SoSFEnum filterMode
 filter mode for rendering
SoSFFloat alphaFactor
 set the alpha factor for drawing
SoSFColor baseColor
 set the base color which is multiplied with the overlay
SoSFBool overwriteCurrentTimePoint
 Should the current time point be overwritten?
SoSFInt32 timePoint
 select the timepoint of the input image to render
SoSFInt32 maxTimePoint
 maximum timepoint value available (maximum of timePoint field)
SoSFEnum lutPrecision
 defines the precision of the LUT
SoSFBool useWorldCoords
 if this flag is on, the overlay can also render correct subimage overlays if the image is parallel to the image rendered on SoView2D
SoSFBool applyLut
 if this flag is enabled, the overlay uses the lut that is present in the scene graph, default is true
SoSFBool isCheckerTiling
 If enabled, draws a checkerboard tile each.
SoSFInt32 checkerTileSize
 The size of the checkerboard tiles.
SoSFBool areCheckerTilesInverted
 Invert the checkerboard with this flag.

Protected Member Functions

virtual ~SoView2DOverlay ()
 Destructor.
virtual int getTimePoint (View2DSliceList *slicelist, int slice)
 Returns the current timepoint which is either the actual shown timepoint or the timepoint overwritten by the field overwriteTimePoint; The slice parameter is not used in the standard implementation but can be necessary in derived classes.

Protected Attributes

ml::LUTData< MLuint8 > * _lutData
 the lut data that is rendered
ml::LUTFunction_lutFunction
 the lut from the scene, stored by GLRender
bool _reloadData
 flag if data needs to be reloaded
int _id
 id for texture caching
int _oldTimePoint
 previous timepoint
bool _oldUseWorldCoords
 previous world coord flag
unsigned int _imageSerial
 serial number of last input image

Detailed Description

Draws an overlay image on the SoView2D.

SoView2DOverlay is derived from SoView2DCallback to allow others to register with the callback

Author:
Florian Link

Definition at line 43 of file SoView2DOverlay.h.


Constructor & Destructor Documentation

SoView2DOverlay::SoView2DOverlay ( )

Constructor.

virtual SoView2DOverlay::~SoView2DOverlay ( ) [protected, virtual]

Destructor.


Member Function Documentation

virtual void SoView2DOverlay::draw ( View2DSliceList dsl,
View2DSlice dslice,
int  slice 
) [virtual]

reimplemented from SoView2DExtension

Reimplemented from SoView2DCallback.

virtual void SoView2DOverlay::endDrawing ( View2DSliceList slicelist) [virtual]

reimplemented from SoView2DExtension

Reimplemented from SoView2DExtension.

virtual bool SoView2DOverlay::evalEvent ( SoView2D view2d,
View2DSliceList slicelist,
View2DEvent ec,
View2DEventPhase  phase 
) [virtual]

reimplemented from SoView2DExtension

Reimplemented from SoView2DCallback.

virtual int SoView2DOverlay::getTimePoint ( View2DSliceList slicelist,
int  slice 
) [protected, virtual]

Returns the current timepoint which is either the actual shown timepoint or the timepoint overwritten by the field overwriteTimePoint; The slice parameter is not used in the standard implementation but can be necessary in derived classes.

void SoView2DOverlay::GLRender ( SoGLRenderAction *  action) [virtual]

reimplemented from SoNode, stores the LUT for later rendering

Reimplemented from SoView2DExtension.

static void SoView2DOverlay::initClass ( ) [static]

inventor runtime type system

Reimplemented from SoView2DCallback.

virtual void SoView2DOverlay::startDrawing ( View2DSliceList slicelist) [virtual]

reimplemented from SoView2DExtension

Reimplemented from SoView2DExtension.


Member Data Documentation

int SoView2DOverlay::_id [protected]

id for texture caching

Definition at line 123 of file SoView2DOverlay.h.

unsigned int SoView2DOverlay::_imageSerial [protected]

serial number of last input image

Definition at line 129 of file SoView2DOverlay.h.

the lut data that is rendered

Definition at line 115 of file SoView2DOverlay.h.

the lut from the scene, stored by GLRender

Definition at line 118 of file SoView2DOverlay.h.

previous timepoint

Definition at line 125 of file SoView2DOverlay.h.

previous world coord flag

Definition at line 127 of file SoView2DOverlay.h.

bool SoView2DOverlay::_reloadData [protected]

flag if data needs to be reloaded

Definition at line 121 of file SoView2DOverlay.h.

set the alpha factor for drawing

Definition at line 61 of file SoView2DOverlay.h.

if this flag is enabled, the overlay uses the lut that is present in the scene graph, default is true

Definition at line 78 of file SoView2DOverlay.h.

Invert the checkerboard with this flag.

Definition at line 87 of file SoView2DOverlay.h.

set the base color which is multiplied with the overlay

Definition at line 63 of file SoView2DOverlay.h.

select the blend mode of the overlay

Definition at line 55 of file SoView2DOverlay.h.

flag if textures should be cached

Definition at line 53 of file SoView2DOverlay.h.

The size of the checkerboard tiles.

Definition at line 84 of file SoView2DOverlay.h.

filter mode for rendering

Definition at line 59 of file SoView2DOverlay.h.

input image

Definition at line 51 of file SoView2DOverlay.h.

inherit filter mode

Definition at line 57 of file SoView2DOverlay.h.

If enabled, draws a checkerboard tile each.

Definition at line 81 of file SoView2DOverlay.h.

defines the precision of the LUT

Definition at line 71 of file SoView2DOverlay.h.

maximum timepoint value available (maximum of timePoint field)

Definition at line 69 of file SoView2DOverlay.h.

Should the current time point be overwritten?

Definition at line 65 of file SoView2DOverlay.h.

select the timepoint of the input image to render

Definition at line 67 of file SoView2DOverlay.h.

if this flag is on, the overlay can also render correct subimage overlays if the image is parallel to the image rendered on SoView2D

Definition at line 75 of file SoView2DOverlay.h.


The documentation for this class was generated from the following file: