MeVisLab Toolbox Reference
ml::VTKObjectWrapper Class Reference

#include <mlVTKMLBaseWrapper.h>

Inheritance diagram for ml::VTKObjectWrapper:
ml::RefCountedBase ml::EventSource ml::Base

Public Member Functions

 VTKObjectWrapper ()
 VTKObjectWrapper (vtkObject *obj)
vtkObject * wrappedObject ()
template<class T>
Tobject ()
std::string detailString () const override
Public Member Functions inherited from ml::RefCountedBase
 RefCountedBase ()
 Constructor.
 RefCountedBase (const RefCountedBase &)
 Explicit copy constructor.
virtual void incRefCount () const
 Increases the reference count.
virtual void decRefCount () const
 Decreases the reference count (object will be deleted if the reference count is decremented to 0).
bool isRefCountedBase () const override
 Returns whether the instance is derived from RefCountedBase.
Public Member Functions inherited from ml::EventSource
 EventSource ()
 EventSource (const EventSource &evSource)
 ~EventSource () override
void addEventListener (BaseEventCallback *cb, void *userData)
void removeEventListener (BaseEventCallback *cb, void *userData)
bool hasEventListeners () const
Public Member Functions inherited from ml::Base
 Base ()
 Constructor.
virtual ~Base ()
 Destructor.
virtual BasedeepCopy () const
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
virtual bool implementsPersistence (PersistenceInterface) const
virtual std::string persistentState () const
 Returns a string describing the object's internal state.
virtual void setPersistentState (const std::string &state)
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node.
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node.
virtual void writeTo (AbstractPersistenceOutputStream *) const
virtual void readFrom (AbstractPersistenceInputStream *, int)

Protected Member Functions

 ML_ABSTRACT_CLASS_HEADER (VTKObjectWrapper)
 Register this class abstractly.
Protected Member Functions inherited from ml::RefCountedBase
 ~RefCountedBase () override
 Destructor.
Protected Member Functions inherited from ml::EventSource
void sendEvent (BaseEvent *event, void *skipListener=nullptr)

Protected Attributes

vtkSmartPointer< vtkObject > _vtkObject {}
Protected Attributes inherited from ml::RefCountedBase
std::atomic_int_least32_t _refCount
 Reference count.

Additional Inherited Members

Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
Static Public Member Functions inherited from ml::RefCountedBase
static void updateReferenceCountingIfSupported (Base *oldValue, Base *newValue, bool &isRefCountedBase)

Detailed Description

Helper class to have a common base class for all derived wrapper. It is use to distinguish wrappers from other non wrapper base objects.

Definition at line 31 of file mlVTKMLBaseWrapper.h.

Constructor & Destructor Documentation

◆ VTKObjectWrapper() [1/2]

ml::VTKObjectWrapper::VTKObjectWrapper ( )

◆ VTKObjectWrapper() [2/2]

ml::VTKObjectWrapper::VTKObjectWrapper ( vtkObject * obj)

Member Function Documentation

◆ detailString()

std::string ml::VTKObjectWrapper::detailString ( ) const
overridevirtual

Returns a string describing this object. This is mainly meant to return the subtype of wrapped objects, which are not reflected in the Base type system.

Reimplemented from ml::Base.

◆ ML_ABSTRACT_CLASS_HEADER()

ml::VTKObjectWrapper::ML_ABSTRACT_CLASS_HEADER ( VTKObjectWrapper )
protected

Register this class abstractly.

References VTKObjectWrapper().

◆ object()

template<class T>
T * ml::VTKObjectWrapper::object ( )
inline

Definition at line 40 of file mlVTKMLBaseWrapper.h.

References T, and wrappedObject().

◆ wrappedObject()

vtkObject * ml::VTKObjectWrapper::wrappedObject ( )

Referenced by object().

Member Data Documentation

◆ _vtkObject

vtkSmartPointer<vtkObject> ml::VTKObjectWrapper::_vtkObject {}
protected

Definition at line 48 of file mlVTKMLBaseWrapper.h.


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