OpenWalnut
1.5.0dev
|
This module builds the base for fast raytracing of isosurfacesin OpenWalnut. More...
#include <WMIsosurfaceRaytracer.h>
Public Member Functions | |
WMIsosurfaceRaytracer () | |
Default constructor. More... | |
virtual | ~WMIsosurfaceRaytracer () |
Destructor. More... | |
virtual const std::string | getName () const |
Gives back the name of this module. More... | |
virtual const std::string | getDescription () const |
Gives back a description of this module. More... | |
virtual std::shared_ptr< WModule > | factory () const |
Due to the prototype design pattern used to build modules, this method returns a new instance of this method. More... | |
virtual const char ** | getXPMIcon () const |
Get the icon for this module in XPM format. More... | |
Public Member Functions inherited from WModule | |
WModule () | |
Constructs a new WModule instance. More... | |
virtual | ~WModule () |
Destructor. More... | |
const InputConnectorList & | getInputConnectors () const |
Gives back input connectors. More... | |
std::shared_ptr< WModuleInputConnector > | getInputConnector (std::string name) |
Finds the named connector for the module. More... | |
std::shared_ptr< WModuleInputConnector > | findInputConnector (std::string name) |
Finds the named connector for the module. More... | |
const OutputConnectorList & | getOutputConnectors () const |
Gives back output connectors. More... | |
std::shared_ptr< WModuleOutputConnector > | getOutputConnector (std::string name) |
Finds the named connector for the module. More... | |
std::shared_ptr< WModuleOutputConnector > | findOutputConnector (std::string name) |
Finds the named connector for the module. More... | |
std::shared_ptr< WModuleConnector > | getConnector (std::string name) |
Finds the named connector for the module. More... | |
std::shared_ptr< WModuleConnector > | findConnector (std::string name) |
Finds the named connector for the module. More... | |
std::shared_ptr< WProperties > | getProperties () const |
Return a pointer to the properties object of the module. More... | |
std::shared_ptr< WProperties > | getInformationProperties () const |
Return a pointer to the information properties object of the module. More... | |
const WBoolFlag & | isInitialized () const |
Determines whether the module instance is properly initialized. More... | |
const WBoolFlag & | isUseable () const |
Checks whether the module instance is ready to be used. More... | |
const WBoolFlag & | isAssociated () const |
Checks whether this module is associated with an container. More... | |
const WBoolFlag & | isReady () const |
Checks whether this module is ready. More... | |
const WBoolFlag & | isReadyOrCrashed () const |
This is the logical or of isReady and isCrashed. More... | |
const WBoolFlag & | isRunning () const |
Returns a flag denoting whether the thread currently is running or nor. More... | |
void | waitRestored () |
This method waits for the module to be restored completely. More... | |
bool | isRestoreNeeded () const |
Check whether this module is in restore mode. More... | |
void | setRestoreNeeded (bool restore=true) |
Change the restore mode. More... | |
void | reportRestoreComplete () |
Called by loaders to tell the module that loading has been completed. More... | |
std::shared_ptr< WModuleContainer > | getAssociatedContainer () const |
The container this module is associated with. More... | |
virtual boost::signals2::connection | subscribeSignal (MODULE_SIGNAL signal, t_ModuleGenericSignalHandlerType notifier) |
Connects a specified notify function with a signal this module instance is offering. More... | |
virtual boost::signals2::connection | subscribeSignal (MODULE_SIGNAL signal, t_ModuleErrorSignalHandlerType notifier) |
Connects a specified notify function with a signal this module instance is offering. More... | |
virtual std::shared_ptr< WProgressCombiner > | getRootProgressCombiner () |
Gets the modules base progress. More... | |
virtual MODULE_TYPE | getType () const |
Gets the type of the module. More... | |
void | disconnect () |
Completely disconnects all connected connectors of this module. More... | |
WCombinerTypes::WDisconnectList | getPossibleDisconnections () |
Gives a list of all WDisconnectCombiners possible. More... | |
boost::filesystem::path | getLocalPath () const |
Returns the local path of the module. More... | |
boost::filesystem::path | getLibPath () const |
Returns the absolute path to the library containing this module. More... | |
std::string | getPackageName () const |
Returns the name of the package the module belongs to, The package name basically is the name of the library containing this and maybe other modules. More... | |
bool | isDeprecated () const |
Checks whether the module was marked as deprecated. More... | |
std::string | getDeprecationMessage () const |
Queries the deprecation message of a module if specified. More... | |
virtual WModuleMetaInformation::ConstSPtr | getMetaInformation () const |
The meta information of this module. More... | |
const std::string & | getUUID () const |
Get the UUID of the module instance. More... | |
WPropString | getRuntimeName () const |
Returns the name the user has given this module. More... | |
const WRequirement * | checkRequirements () const |
This method checks whether all the requirements of the module are complied. More... | |
virtual boost::signals2::connection | subscribeSignal (THREAD_SIGNAL signal, t_ThreadErrorSignalHandlerType notifier) |
Connects a specified notify function with a signal this thread instance is offering. More... | |
Public Member Functions inherited from WThreadedRunner | |
WThreadedRunner () | |
Default constructor. More... | |
virtual | ~WThreadedRunner () |
Destructor. More... | |
virtual void | run () |
Run thread. More... | |
void | run (THREADFUNCTION f) |
Run thread. More... | |
void | wait (bool requestFinish=false) |
Wait for the thread to be finished. More... | |
virtual void | requestStop () |
This method's purpose is to request a stop without waiting for it. More... | |
virtual boost::signals2::connection | subscribeSignal (THREAD_SIGNAL signal, t_ThreadErrorSignalHandlerType notifier) |
Connects a specified notify function with a signal this thread instance is offering. More... | |
const WBoolFlag & | isCrashed () const |
Checks whether this thread has been crashed. More... | |
const std::string & | getCrashMessage () const |
Get the message of the exception finally causing the crash. More... | |
void | setThreadName (std::string name) |
Set the name of the thread. More... | |
std::string | getThreadName () const |
Returns the current thread name. More... | |
Public Member Functions inherited from WPrototyped | |
WPrototyped () | |
Default constructor. More... | |
virtual | ~WPrototyped () |
Destructor. More... | |
template<typename T > | |
bool | isA () |
Checks whether the actual prototype has the specified runtime type. More... | |
Protected Member Functions | |
virtual void | moduleMain () |
Entry point after loading the module. More... | |
virtual void | connectors () |
Initialize the connectors this module is using. More... | |
virtual void | properties () |
Initialize the properties for this module. More... | |
virtual void | requirements () |
Initialize requirements for this module. More... | |
Protected Member Functions inherited from WModule | |
void | threadMain () |
Thread entry point. More... | |
virtual void | onThreadException (const WException &e) |
This method is called if an exception was caught, which came from the custom thread code. More... | |
void | setAssociatedContainer (std::shared_ptr< WModuleContainer > container) |
Sets the container this module is associated with. More... | |
virtual std::string | deprecated () const |
This function allows module programmers to mark their modules deprecated in a user-friendly way. More... | |
void | initialize () |
Manages initialization. More... | |
virtual void | cleanup () |
Called whenever the module should shutdown. More... | |
void | addConnector (std::shared_ptr< WModuleInputConnector > con) |
Adds the specified connector to the list of inputs. More... | |
void | addConnector (std::shared_ptr< WModuleOutputConnector > con) |
Adds the specified connector to the list of outputs. More... | |
void | removeConnectors () |
Removes all connectors properly. More... | |
virtual void | activate () |
Callback for m_active. More... | |
virtual const t_GenericSignalHandlerType | getSignalHandler (MODULE_CONNECTOR_SIGNAL signal) |
Gives the signal handler function responsible for a given signal. More... | |
virtual void | notifyConnectionEstablished (std::shared_ptr< WModuleConnector > here, std::shared_ptr< WModuleConnector > there) |
Gets called whenever a connector gets connected to the specified input. More... | |
virtual void | notifyConnectionClosed (std::shared_ptr< WModuleConnector > here, std::shared_ptr< WModuleConnector > there) |
Gets called whenever a connection between a remote and local connector gets closed. More... | |
virtual void | notifyDataChange (std::shared_ptr< WModuleConnector > input, std::shared_ptr< WModuleConnector > output) |
Gets called when the data on one input connector changed. More... | |
void | ready () |
Call this whenever your module is ready and can react on property changes. More... | |
wlog::WStreamedLogger | infoLog () const |
Logger instance for comfortable info logging. More... | |
wlog::WStreamedLogger | debugLog () const |
Logger instance for comfortable debug logging. More... | |
wlog::WStreamedLogger | warnLog () const |
Logger instance for comfortable warning- logs. More... | |
wlog::WStreamedLogger | errorLog () const |
Logger instance for comfortable error logging. More... | |
void | setLocalPath (boost::filesystem::path path) |
Sets the local module path. More... | |
void | setLibPath (boost::filesystem::path path) |
Set the path to the library which contains this module. More... | |
void | setPackageName (std::string name) |
Set the package name. More... | |
Protected Member Functions inherited from WThreadedRunner | |
virtual void | notifyStop () |
Gets called when the thread should be stopped. More... | |
void | yield () const |
Give remaining execution timeslice to another thread. More... | |
void | sleep (const int32_t t) const |
Sets thread asleep. More... | |
void | msleep (const int32_t t) const |
Sets thread asleep. More... | |
void | waitForStop () |
Let the thread sleep until a stop request was given. More... | |
void | handleDeadlyException (const WException &e, std::string sender="WThreadedRunner") |
Handle the specified exception which was not caught in the thread, which basically means the thread has crashed. More... | |
Private Attributes | |
std::shared_ptr< WModuleInputData< WDataSetScalar > > | m_input |
An input connector used to get datasets from other modules. More... | |
std::shared_ptr< WModuleInputData< WDataSetVector > > | m_gradients |
The gradient field input. More... | |
WPropDouble | m_isoValue |
The Isovalue used in the case m_isoSurface is true. More... | |
WPropColor | m_isoColor |
The color used when in isosurface mode for blending. More... | |
WPropInt | m_stepCount |
The number of steps to walk along the ray. More... | |
WPropDouble | m_epsilon |
The numeric precision used for iso-checking. More... | |
WPropDouble | m_alpha |
The alpha transparency used for the rendering. More... | |
WPropDouble | m_colormapRatio |
The ratio between colormap and normal surface color. More... | |
WPropBool | m_phongNoSpec |
Some special coloring mode for disabling specular hightlights. More... | |
WPropBool | m_phongShading |
If true, per-pixel-phong shading is applied to the surface. More... | |
WPropBool | m_stochasticJitter |
If true, the ray-tracer uses stochastic jitter to improve image quality. More... | |
WPropBool | m_borderClip |
If true, a certain border area can be clipped. More... | |
WPropDouble | m_borderClipDistance |
The distance used for clipping. More... | |
std::shared_ptr< WCondition > | m_propCondition |
A condition used to notify about changes in several properties. More... | |
osg::ref_ptr< WGEShader > | m_shader |
the DVR shader. More... | |
Additional Inherited Members | |
Public Types inherited from WModule | |
typedef std::vector< std::shared_ptr< WModuleInputConnector > > | InputConnectorList |
The type for the list of input connectors. More... | |
typedef std::vector< std::shared_ptr< WModuleOutputConnector > > | OutputConnectorList |
The type for the list of output connectors. More... | |
typedef std::shared_ptr< WModule > | SPtr |
Shared pointer to a WModule. More... | |
typedef std::shared_ptr< const WModule > | ConstSPtr |
Shared pointer to a const WModule. More... | |
Public Types inherited from WThreadedRunner | |
typedef std::shared_ptr< WThreadedRunner > | SPtr |
Abbreviation to a shared_ptr to this type. More... | |
typedef std::shared_ptr< const WThreadedRunner > | ConstSPtr |
Abbreviation to a const shared_ptr to this type. More... | |
typedef boost::function< void(void) > | THREADFUNCTION |
Type used for simple thread functions. More... | |
Static Public Member Functions inherited from WModule | |
static SPtr | findByUUID (std::string uuid) |
Find a module instance by UUID. More... | |
Static Public Member Functions inherited from WThreadedRunner | |
static void | setThisThreadName (std::string name) |
Static function to set the name of the calling thread. More... | |
Protected Types inherited from WModule | |
typedef std::vector< WRequirement * > | Requirements |
The type of the requirement list. More... | |
Protected Attributes inherited from WModule | |
std::shared_ptr< WProperties > | m_properties |
The property object for the module. More... | |
std::shared_ptr< WProperties > | m_infoProperties |
The property object for the module containing only module whose purpose is "PV_PURPOSE_INFORMNATION". More... | |
std::shared_ptr< WProgressCombiner > | m_progress |
Progress indicator used as parent for all progress' of this module. More... | |
WBoolFlag | m_initialized |
True if everything is initialized and ready to be used. More... | |
WBoolFlag | m_isAssociated |
True if container got associated with this flag. More... | |
WBoolFlag | m_isUsable |
True if associated && initialized. More... | |
WBoolFlag | m_isReady |
True if ready() was called. More... | |
WBoolFlag | m_isReadyOrCrashed |
It is true whenever m_isReady or WThreadedRunner::m_isCrashed is true. More... | |
WBoolFlag | m_isRunning |
True if the module currently is running. More... | |
WBoolFlag | m_isLoadFinished |
Flag to denote whether the module container and the project loader have finished their work. More... | |
bool | m_restoreMode |
Flag denoting the current restore mode. More... | |
std::shared_ptr< WProgress > | m_readyProgress |
Progress indicator for the "ready" state. More... | |
WConditionSet | m_moduleState |
The internal state of the module. More... | |
std::shared_ptr< WModuleContainer > | m_container |
The container this module belongs to. More... | |
InputConnectorList | m_inputConnectors |
Set of input connectors associated with this module. More... | |
OutputConnectorList | m_outputConnectors |
Set of output connectors associated with this module. More... | |
WPropBool | m_active |
True whenever the module should be active. More... | |
WPropString | m_runtimeName |
This property holds a user specified name for the current module instance. More... | |
boost::filesystem::path | m_localPath |
The path where the module binary resides in. More... | |
boost::filesystem::path | m_libPath |
The absolute path to the library containing this module. More... | |
std::string | m_packageName |
The name of the lib/the package containing this module. More... | |
Requirements | m_requirements |
The list of requirements. More... | |
Protected Attributes inherited from WThreadedRunner | |
boost::thread | m_thread |
Thread instance. More... | |
WBoolFlag | m_shutdownFlag |
Condition getting fired whenever the thread should quit. More... | |
WBoolFlag | m_isCrashed |
True whenever an exception is thrown during threadMain. More... | |
std::string | m_crashMessage |
The crash message. More... | |
This module builds the base for fast raytracing of isosurfacesin OpenWalnut.
It uses shader based raytracing.
Definition at line 47 of file WMIsosurfaceRaytracer.h.
WMIsosurfaceRaytracer::WMIsosurfaceRaytracer | ( | ) |
Default constructor.
Definition at line 60 of file WMIsosurfaceRaytracer.cpp.
Referenced by factory().
|
virtual |
Destructor.
Definition at line 66 of file WMIsosurfaceRaytracer.cpp.
|
protectedvirtual |
Initialize the connectors this module is using.
Reimplemented from WModule.
Definition at line 93 of file WMIsosurfaceRaytracer.cpp.
References WModule::addConnector(), WModule::connectors(), WModuleInputData< T >::createAndAdd(), m_gradients, and m_input.
|
virtual |
Due to the prototype design pattern used to build modules, this method returns a new instance of this method.
NOTE: it should never be initialized or modified in some other way. A simple new instance is required.
Implements WModule.
Definition at line 71 of file WMIsosurfaceRaytracer.cpp.
References WMIsosurfaceRaytracer().
|
virtual |
Gives back a description of this module.
Implements WPrototyped.
Definition at line 87 of file WMIsosurfaceRaytracer.cpp.
|
virtual |
Gives back the name of this module.
Implements WPrototyped.
Definition at line 81 of file WMIsosurfaceRaytracer.cpp.
|
virtual |
Get the icon for this module in XPM format.
Reimplemented from WModule.
Definition at line 76 of file WMIsosurfaceRaytracer.cpp.
|
protectedvirtual |
Entry point after loading the module.
Runs in separate thread.
Implements WModule.
Definition at line 162 of file WMIsosurfaceRaytracer.cpp.
References WConditionSet::add(), WGEColormapping::apply(), wge::bindTexture(), WModule::debugLog(), wge::enableTransparency(), WModule::errorLog(), wge::generateSolidBoundingBoxNode(), wge::genWhiteNoiseTexture(), WKernel::getGraphicsEngine(), WKernel::getRunningKernel(), WModule::m_active, m_alpha, m_borderClip, m_borderClipDistance, m_colormapRatio, m_epsilon, m_gradients, m_input, m_isoColor, m_isoValue, WModule::m_localPath, WModule::m_moduleState, m_phongNoSpec, m_phongShading, m_propCondition, WModule::m_properties, m_shader, WThreadedRunner::m_shutdownFlag, m_stepCount, m_stochasticJitter, WModule::ready(), WConditionSet::setResetable(), and WConditionSet::wait().
|
protectedvirtual |
Initialize the properties for this module.
Reimplemented from WModule.
Definition at line 110 of file WMIsosurfaceRaytracer.cpp.
References m_alpha, m_borderClip, m_borderClipDistance, m_colormapRatio, m_epsilon, m_isoColor, m_isoValue, m_phongNoSpec, m_phongShading, m_propCondition, WModule::m_properties, m_stepCount, m_stochasticJitter, and WModule::properties().
|
protectedvirtual |
Initialize requirements for this module.
Reimplemented from WModule.
Definition at line 157 of file WMIsosurfaceRaytracer.cpp.
References WModule::m_requirements.
|
private |
The alpha transparency used for the rendering.
Definition at line 141 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
If true, a certain border area can be clipped.
Very useful for non-peeled noisy data.
Definition at line 166 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
The distance used for clipping.
Definition at line 171 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
The ratio between colormap and normal surface color.
Definition at line 146 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
The numeric precision used for iso-checking.
Definition at line 136 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
The gradient field input.
Definition at line 116 of file WMIsosurfaceRaytracer.h.
Referenced by connectors(), and moduleMain().
|
private |
An input connector used to get datasets from other modules.
The connection management between connectors must not be handled by the module.
Definition at line 111 of file WMIsosurfaceRaytracer.h.
Referenced by connectors(), and moduleMain().
|
private |
The color used when in isosurface mode for blending.
Definition at line 126 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
The Isovalue used in the case m_isoSurface is true.
Definition at line 121 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
Some special coloring mode for disabling specular hightlights.
Definition at line 151 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
If true, per-pixel-phong shading is applied to the surface.
Definition at line 156 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
A condition used to notify about changes in several properties.
Definition at line 176 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
|
private |
The number of steps to walk along the ray.
Definition at line 131 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().
|
private |
If true, the ray-tracer uses stochastic jitter to improve image quality.
Definition at line 161 of file WMIsosurfaceRaytracer.h.
Referenced by moduleMain(), and properties().