OpenWalnut
1.5.0dev
|
Arbitrarily orientable cutting plane through the data. More...
#include <WMArbitraryPlane.h>
Public Member Functions | |
WMArbitraryPlane () | |
standard constructor More... | |
virtual | ~WMArbitraryPlane () |
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... | |
void | initPlane () |
called once at the start of the module main loop More... | |
void | updatePlane () |
updates the plane with the current settings More... | |
void | setDirty () |
setter for dirty flag More... | |
bool | isDirty () |
getter More... | |
WPosition | getCenterPosition () |
getter for the position of the center manipulator More... | |
void | updateCallback () |
update function, called with each update pass of the osg render loop 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 void | requirements () |
Initialize requirements in this function. 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< WCondition > | m_propCondition |
A condition used to notify about changes in several properties. More... | |
WPropBool | m_showComplete |
True if the shader shouldn't discard a fragment when the value is zero. More... | |
WPropBool | m_showManipulators |
True if the manipulator spheres should be shown. More... | |
WPropBool | m_attach2Crosshair |
If true the center position will move with the nav slice selection. More... | |
WPropTrigger | m_buttonReset2Axial |
When triggered the center manipulator is set to the nav slice position and the plane is aligned along the axial slice. More... | |
WPropTrigger | m_buttonReset2Coronal |
When triggered the center manipulator is set to the nav slice position and the plane is aligned along the coronal slice. More... | |
WPropTrigger | m_buttonReset2Sagittal |
When triggered the center manipulator is set to the nav slice position and the plane is aligned along the axial slice. More... | |
osg::ref_ptr< WGEManagedGroupNode > | m_rootNode |
The root node used for this modules graphics. More... | |
osg::ref_ptr< osg::Geode > | m_geode |
The geometry rendered by this module. More... | |
WPosition | m_p0 |
stores the last position of the center manipulator More... | |
WPosition | m_p1 |
stores the last position of manipulator 1 More... | |
WPosition | m_p2 |
stores the last position of manipulator 2 More... | |
osg::ref_ptr< WROISphere > | m_s0 |
stores pointer to the center manipulator More... | |
osg::ref_ptr< WROISphere > | m_s1 |
stores pointer to manipulator 1 More... | |
osg::ref_ptr< WROISphere > | m_s2 |
stores pointer to manipulator 2 More... | |
bool | m_dirty |
dirty flag, used when manipulator positions change More... | |
osg::ref_ptr< WGEShader > | m_shader |
the shader object for this module More... | |
osg::ref_ptr< osg::Uniform > | m_showCompleteUniform |
Determines whether the slice should be drawn completely. More... | |
std::shared_ptr< boost::function< void() > > | m_changeRoiSignal |
Signal that can be used to update the plane. 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... | |
Arbitrarily orientable cutting plane through the data.
Definition at line 50 of file WMArbitraryPlane.h.
WMArbitraryPlane::WMArbitraryPlane | ( | ) |
standard constructor
Definition at line 50 of file WMArbitraryPlane.cpp.
Referenced by factory().
|
virtual |
destructor
Definition at line 57 of file WMArbitraryPlane.cpp.
|
protectedvirtual |
Initialize the connectors this module is using.
Reimplemented from WModule.
Definition at line 84 of file WMArbitraryPlane.cpp.
References WModule::connectors().
|
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 62 of file WMArbitraryPlane.cpp.
References WMArbitraryPlane().
|
protected |
getter for the position of the center manipulator
Definition at line 331 of file WMArbitraryPlane.cpp.
References m_s0.
Referenced by updateCallback().
|
virtual |
Gives back a description of this module.
Implements WPrototyped.
Definition at line 79 of file WMArbitraryPlane.cpp.
|
virtual |
Gives back the name of this module.
Implements WPrototyped.
Definition at line 73 of file WMArbitraryPlane.cpp.
|
virtual |
Get the icon for this module in XPM format.
Reimplemented from WModule.
Definition at line 68 of file WMArbitraryPlane.cpp.
|
protected |
called once at the start of the module main loop
Definition at line 213 of file WMArbitraryPlane.cpp.
References WGEColormapping::apply(), WGraphicsEngine::getGraphicsEngine(), WKernel::getGraphicsEngine(), WKernel::getRunningKernel(), WKernel::getSelectionManager(), WModule::m_active, m_changeRoiSignal, m_geode, WModule::m_localPath, m_p0, m_p1, m_p2, m_rootNode, m_s0, m_s1, m_s2, m_shader, m_showComplete, setDirty(), and updateCallback().
Referenced by moduleMain().
|
protected |
getter
Definition at line 326 of file WMArbitraryPlane.cpp.
References m_dirty.
Referenced by updateCallback().
|
protectedvirtual |
Entry point after loading the module.
Runs in separate thread.
Implements WModule.
Definition at line 110 of file WMArbitraryPlane.cpp.
References WConditionSet::add(), WGraphicsEngine::getGraphicsEngine(), WKernel::getGraphicsEngine(), WKernel::getRunningKernel(), WKernel::getSelectionManager(), initPlane(), WModule::m_active, m_buttonReset2Axial, m_buttonReset2Coronal, m_buttonReset2Sagittal, m_changeRoiSignal, m_dirty, WModule::m_moduleState, m_propCondition, m_rootNode, m_s0, m_s1, m_s2, m_showComplete, m_showManipulators, WThreadedRunner::m_shutdownFlag, WPVBaseTypes::PV_TRIGGER_READY, WPVBaseTypes::PV_TRIGGER_TRIGGERED, WModule::ready(), WConditionSet::setResetable(), updatePlane(), and WConditionSet::wait().
|
protectedvirtual |
Initialize the properties for this module.
Reimplemented from WModule.
Definition at line 92 of file WMArbitraryPlane.cpp.
References m_attach2Crosshair, m_buttonReset2Axial, m_buttonReset2Coronal, m_buttonReset2Sagittal, m_propCondition, WModule::m_properties, m_showComplete, m_showManipulators, WModule::properties(), and WPVBaseTypes::PV_TRIGGER_READY.
|
protected |
setter for dirty flag
Definition at line 321 of file WMArbitraryPlane.cpp.
References m_dirty.
Referenced by initPlane(), and updateCallback().
|
protected |
update function, called with each update pass of the osg render loop
Definition at line 306 of file WMArbitraryPlane.cpp.
References getCenterPosition(), WKernel::getRunningKernel(), WKernel::getSelectionManager(), isDirty(), setDirty(), and updatePlane().
Referenced by initPlane().
|
protected |
updates the plane with the current settings
Definition at line 259 of file WMArbitraryPlane.cpp.
References WKernel::getRunningKernel(), m_attach2Crosshair, m_dirty, m_geode, m_p0, m_s0, m_s1, and m_s2.
Referenced by moduleMain(), and updateCallback().
|
private |
If true the center position will move with the nav slice selection.
Definition at line 159 of file WMArbitraryPlane.h.
Referenced by properties(), and updatePlane().
|
private |
When triggered the center manipulator is set to the nav slice position and the plane is aligned along the axial slice.
Definition at line 166 of file WMArbitraryPlane.h.
Referenced by moduleMain(), and properties().
|
private |
When triggered the center manipulator is set to the nav slice position and the plane is aligned along the coronal slice.
Definition at line 172 of file WMArbitraryPlane.h.
Referenced by moduleMain(), and properties().
|
private |
When triggered the center manipulator is set to the nav slice position and the plane is aligned along the axial slice.
Definition at line 178 of file WMArbitraryPlane.h.
Referenced by moduleMain(), and properties().
|
private |
Signal that can be used to update the plane.
Definition at line 208 of file WMArbitraryPlane.h.
Referenced by initPlane(), and moduleMain().
|
private |
dirty flag, used when manipulator positions change
Definition at line 199 of file WMArbitraryPlane.h.
Referenced by isDirty(), moduleMain(), setDirty(), and updatePlane().
|
private |
The geometry rendered by this module.
Definition at line 189 of file WMArbitraryPlane.h.
Referenced by initPlane(), and updatePlane().
|
private |
stores the last position of the center manipulator
Definition at line 191 of file WMArbitraryPlane.h.
Referenced by initPlane(), and updatePlane().
|
private |
stores the last position of manipulator 1
Definition at line 192 of file WMArbitraryPlane.h.
Referenced by initPlane().
|
private |
stores the last position of manipulator 2
Definition at line 193 of file WMArbitraryPlane.h.
Referenced by initPlane().
|
private |
A condition used to notify about changes in several properties.
Definition at line 143 of file WMArbitraryPlane.h.
Referenced by moduleMain(), and properties().
|
private |
The root node used for this modules graphics.
Definition at line 184 of file WMArbitraryPlane.h.
Referenced by initPlane(), and moduleMain().
|
private |
stores pointer to the center manipulator
Definition at line 195 of file WMArbitraryPlane.h.
Referenced by getCenterPosition(), initPlane(), moduleMain(), and updatePlane().
|
private |
stores pointer to manipulator 1
Definition at line 196 of file WMArbitraryPlane.h.
Referenced by initPlane(), moduleMain(), and updatePlane().
|
private |
stores pointer to manipulator 2
Definition at line 197 of file WMArbitraryPlane.h.
Referenced by initPlane(), moduleMain(), and updatePlane().
|
private |
the shader object for this module
Definition at line 204 of file WMArbitraryPlane.h.
Referenced by initPlane().
|
private |
True if the shader shouldn't discard a fragment when the value is zero.
Definition at line 149 of file WMArbitraryPlane.h.
Referenced by initPlane(), moduleMain(), and properties().
|
private |
Determines whether the slice should be drawn completely.
Definition at line 206 of file WMArbitraryPlane.h.
|
private |
True if the manipulator spheres should be shown.
Definition at line 154 of file WMArbitraryPlane.h.
Referenced by moduleMain(), and properties().