Base class to derive from all modules which wrap automatically generated VTK classes. More...
#include <mlVTKModule.h>
Public Member Functions | |
| VTKModule (int inputNum=0, int outputNum=0) | |
| Normally used constructor. | |
| virtual | ~VTKModule () |
| Destructor. | |
| void | suppressHandleVTKObjectCalls (bool suppress) |
| Set a flag which suppresses handleObject calls if true. | |
| bool | areHandleVTKObjectCallsSuppressed () |
| Returns whether handleObject calls are suppressed. | |
Protected Member Functions | |
| void | setManagedObject (vtkObject *vObj) |
| The object managed by the wrapper. Use NULL as parameter to unregister former objects. | |
| vtkObject * | getManagedObject () |
| Return currently managed object. | |
| void | setObservedObject (vtkObject *vObj, vtkCommand::EventIds eventId=vtkCommand::AnyEvent, float priority=0.0f) |
| The object to be observed. Use NULL as parameter to unregister former objects. | |
| vtkObject * | getObservedObject () |
| Return currently observed object. | |
| virtual void | handleVTKObject (vtkObject *, unsigned long, void *) |
| Method called if observing of vtkObject is active and if the vtkObjects posts any event. | |
| std::string | getInputCheckString () const |
| Check input connections whether they are allowed to be open. | |
| vtkPolyDataAlgorithm * | getDummyPolyDataAlgorithm (int polyType=0) |
| Returns an empty vtkPolyDataAlgorithm; to be used when a placeholder is needed. | |
Detailed Description
Base class to derive from all modules which wrap automatically generated VTK classes.
See mlModule.h for details.
Definition at line 41 of file mlVTKModule.h.
Constructor & Destructor Documentation
| ml::VTKModule::VTKModule | ( | int | inputNum = 0, |
| int | outputNum = 0 |
||
| ) |
Normally used constructor.
| virtual ml::VTKModule::~VTKModule | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| bool ml::VTKModule::areHandleVTKObjectCallsSuppressed | ( | ) |
Returns whether handleObject calls are suppressed.
| vtkPolyDataAlgorithm* ml::VTKModule::getDummyPolyDataAlgorithm | ( | int | polyType = 0 | ) | [protected] |
Returns an empty vtkPolyDataAlgorithm; to be used when a placeholder is needed.
polyType describes the type of required polygon data; currenty only 0 is supported.
| std::string ml::VTKModule::getInputCheckString | ( | ) | const [protected] |
Check input connections whether they are allowed to be open.
If yes then return an empty string; if not the return an error string describing the problem.
| vtkObject* ml::VTKModule::getManagedObject | ( | ) | [protected] |
Return currently managed object.
| vtkObject* ml::VTKModule::getObservedObject | ( | ) | [protected] |
Return currently observed object.
| virtual void ml::VTKModule::handleVTKObject | ( | vtkObject * | , |
| unsigned | long, | ||
| void * | |||
| ) | [inline, protected, virtual] |
Method called if observing of vtkObject is active and if the vtkObjects posts any event.
It can can be overloaded by derived classes to implement functionality in the wrapping Module to handle for example vtkObject changes.
Definition at line 78 of file mlVTKModule.h.
| void ml::VTKModule::setManagedObject | ( | vtkObject * | vObj | ) | [protected] |
The object managed by the wrapper. Use NULL as parameter to unregister former objects.
| void ml::VTKModule::setObservedObject | ( | vtkObject * | vObj, |
| vtkCommand::EventIds | eventId = vtkCommand::AnyEvent, |
||
| float | priority = 0.0f |
||
| ) | [protected] |
The object to be observed. Use NULL as parameter to unregister former objects.
| void ml::VTKModule::suppressHandleVTKObjectCalls | ( | bool | suppress | ) |
Set a flag which suppresses handleObject calls if true.
The documentation for this class was generated from the following file:
- FMEwork/VTK/Sources/VTK/MLVTK/VTKSupport/mlVTKModule.h
