SoImageVizEngine Class Reference
[Engines]

Abstract base class for all ImageViz engines. More...

#include <ImageViz/Engines/SoImageVizEngine.h>

Inheritance diagram for SoImageVizEngine:

List of all members.

Classes
struct	EventArg
	Structure given to callback when an event is raised. More...
Public Types
enum	ComputeMode {   MODE_2D = 0,   MODE_3D = 1,   MODE_AUTO = 2 }
enum	Neighborhood3d {   CONNECTIVITY_6 = 0,   CONNECTIVITY_18 = 1,   CONNECTIVITY_26 = 2 }
Public Member Functions
virtual SoType	getTypeId () const
virtual void	startEvaluate ()
virtual void	waitEvaluate ()
virtual void	abortEvaluate ()
virtual bool	isEvaluating ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SbEventHandler< EventArg & >	onBegin
SbEventHandler< EventArg & >	onEnd
SbEventHandler< EventArg & >	onProgress

---

Detailed Description

Abstract base class for all ImageViz engines.

SEE ALSO

SoEngine

---

Member Enumeration Documentation

enum SoImageVizEngine::ComputeMode

Compute Mode This enum specifies whether the main input will be interpreted as a 3D volume or a stack of 2D images for processing.

Enumerator:

MODE_2D	The engine processes the input image as a stack of 2D images (slice by slice).
MODE_3D	The engine processes the input image as a 3D volume.
MODE_AUTO	The inputs determine if the processing should be applied in 2D or 3D mode. Depending on the expected results, it may be necessary to set explicitly MODE_2D or MODE_3D.

enum SoImageVizEngine::Neighborhood3d

Neighborhood Connectivity 3D.

Enumerator:

CONNECTIVITY_6	Voxels with a common face are considered connected.
CONNECTIVITY_18	Voxels with at least one common edge are considered connected.
CONNECTIVITY_26	Voxels with at least one common vertex are considered connected.

---

Member Function Documentation

virtual void SoImageVizEngine::abortEvaluate

(

)

[virtual]

Abort current processing as soon as possible.

If no processing is currently running, do nothing.

static SoType SoImageVizEngine::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoEngine.

virtual SoType SoImageVizEngine::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

virtual bool SoImageVizEngine::isEvaluating

(

)

[virtual]

Returns true if the engine evaluation is in progress.

virtual void SoImageVizEngine::startEvaluate

(

)

[virtual]

Evaluate engine and dependencies in another thread without blocking the current one.

Event onEnd is raised when processing ends and result is available.

virtual void SoImageVizEngine::waitEvaluate

(

)

[virtual]

Wait for the end of engine evaluation.

This method blocks the current thread.

---

Member Data Documentation

SbEventHandler<EventArg&> SoImageVizEngine::onBegin

Event raised when the processing begins.

SbEventHandler<EventArg&> SoImageVizEngine::onEnd

Event raised when processing ends and the result is available.

Important note: Do not use waitEvaluate() method in this event because this can cause a dead-lock during evaluation.

SbEventHandler<EventArg&> SoImageVizEngine::onProgress

Event raised while processing is running.

Nb: This event is regularly called during processing. It can be used to observe progression of the computing (e.g. to display a progress bar).

---

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

• ImageViz/Engines/SoImageVizEngine.h