ImFusion::OctreeDataComponent Class Reference

#include <ImFusion/Base/Octree.h>

DataComponent to store Octrees directly with their SharedImageSet. More...

Inheritance diagram for ImFusion::OctreeDataComponent:

Detailed Description

DataComponent to store Octrees directly with their SharedImageSet.

Hooks to the SharedImageSet's images and will take care of invalidating instantiated Octrees when the corresponding images change.

Public Member Functions
	OctreeDataComponent (const SharedImageSet *sis)
	Instantiates a new OctreeDataComponent for the given SharedImageSet.
Octree *	octree (int which)
	Returns the Octree for the given image of the parent SharedImageSet.
std::string	id () const override
	Returns a unique string identifier for this type of data component.
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.
Public Member Functions inherited from ImFusion::TemporaryDataComponent
std::string	id () const override
	Returns a unique string identifier for this type of data component.
std::unique_ptr< DataComponentBase >	clone () const override
	Creates a clone of this data component.
bool	assign (const DataComponentBase &) override
	Assigns the content of other to this data component.
bool	equals (const DataComponentBase &) const override
	Compares this data component to other for equality.
void	configure (const Properties *) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *) const override
	Serialize the current object configuration into the given Properties object.
Public Member Functions inherited from ImFusion::Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept
Public Member Functions inherited from ImFusion::SignalReceiver
	SignalReceiver ()=default
	Default constructor.
	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.
SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.

Additional Inherited Members
Static Public Member Functions inherited from ImFusion::LazyInstantiatedDataComponent< OctreeDataComponent, SharedImageSet >
static OctreeDataComponent &	get (const SharedImageSet &data)
	Returns the specific options of type T that are associated with the given data.
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Member Functions inherited from ImFusion::DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
Protected Member Functions inherited from ImFusion::SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Constructor & Destructor Documentation

OctreeDataComponent()

ImFusion::OctreeDataComponent::OctreeDataComponent ( const SharedImageSet * sis )

explicit

Instantiates a new OctreeDataComponent for the given SharedImageSet.

Parameters

data	Must not be null, otherwise the OctreeDataComponent will not work.

Member Function Documentation

octree()

Octree * ImFusion::OctreeDataComponent::octree

(

int

which

)

Returns the Octree for the given image of the parent SharedImageSet.

Returns nullptr if no such image exists or the Octree can not be instantiated for any reason.

id()

std::string ImFusion::OctreeDataComponent::id ( ) const

overridevirtual

Returns a unique string identifier for this type of data component.

Note

To avoid conflicts make sure to include potential plugin names into this ID. Due to the modular architecture of the ImFusion library, uniqueness of IDs cannot be checked at compile time. However, DataComponentFactory will check the uniqueness of the ID during registration.

Implements ImFusion::DataComponentBase.

configure()

void ImFusion::OctreeDataComponent::configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from ImFusion::Configurable.

configuration()

void ImFusion::OctreeDataComponent::configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from ImFusion::Configurable.

---

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

• ImFusion/Base/Octree.h