Helper class to have a common base class for all derived wrapper. More...

#include <mlVTKMLBaseWrapper.h>

Inheritance diagram for ml::VTKObjectWrapper:

Public Member Functions
	VTKObjectWrapper ()

	VTKObjectWrapper (vtkObject *obj)

vtkObject *	wrappedObject ()

template<class T >
T *	object ()

std::string	detailString () const override
	Return a string describing this object.

Public Member Functions inherited from ml::RefCountedBase
	RefCountedBase ()
	Constructor.

	RefCountedBase (const RefCountedBase &)
	Explicit copy constructor.

virtual void	incRefCount () const
	Increase reference count.

virtual void	decRefCount () const
	Decrease ref count (object will be deleted if ref count is decremented to 0)

bool	isRefCountedBase () const override
	Returns if 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)
	add event listener callback to this Base object - the userData will be the first argument when the callback is called

void	removeEventListener (BaseEventCallback cb, void userData)
	remove event listener callback from this Base object - arguments must be the same as for the addEventListener call

bool	hasEventListeners () const
	check if any event listeners have been added to this Base object; this can be used to skip the sendEvent call (and the potentially expensive building of the event object) altogether

Public Member Functions inherited from ml::Base
	Base ()
	Constructor.

virtual	~Base ()
	Destructor.

virtual Base *	deepCopy () const
	Set addStateToTree version number that can be accessed via getAddStateVersion()

bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Check if this object's type is equal to or derived from one of the types given in the argument.

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class.

virtual std::string	persistentState () const
	Returns a string describing the object's internal state.

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using `persistentState()`.

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
	Write the objects state to the data stream object.

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Read the objects state from the data stream object.

Protected Member Functions
	ML_ABSTRACT_CLASS_HEADER (VTKObjectWrapper)
	Register this class abstractly.

Protected Member Functions inherited from ml::RefCountedBase
	~RefCountedBase () override
	Macro for the declaration of the runtime type system methods, defined in mlRuntimeSubClass.h.

Protected Member Functions inherited from ml::EventSource
void	sendEvent (BaseEvent event, void skipListener=nullptr)
	Macro for the declaration of the runtime type system methods, defined in mlRuntimeSubClass.h.

Protected Attributes
vtkSmartPointer< vtkObject >	_vtkObject {}

Protected Attributes inherited from ml::RefCountedBase
MLint32	_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)
	Helper method that handles inc/dec of ref count if base instances support it.

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

Return a string describing this object.

This is mainly meant to return the sub-type 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.

◆ object()

template<class T >

T * ml::VTKObjectWrapper::object ( )

inline

Definition at line 40 of file mlVTKMLBaseWrapper.h.

◆ wrappedObject()

vtkObject * ml::VTKObjectWrapper::wrappedObject ( )

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:

MeVisLab/VTK/Sources/ML/MLVTKSupport/mlVTKMLBaseWrapper.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members