HeightMapPlugin Class Reference

#include <HeightMapPlugin.hpp>

Inherits QObject, PluginInterface, and ModifierInterface.

Public Slots
void	slotPlugin ()

Public Member Functions
	HeightMapPlugin ()
virtual void	initialize (MainWindow *mainWindow)
virtual bool	isModifierEnabled ()
virtual void	applyModifier (Page *page)
Public Member Functions inherited from PluginInterface
virtual	~PluginInterface ()=default
virtual void	initialize (MainWindow *mainWindow)=0
Public Member Functions inherited from ModifierInterface
virtual	~ModifierInterface ()=default
virtual bool	isModifierEnabled ()=0
virtual void	applyModifier (Page *page)=0

Protected Attributes
MainWindow *	mainWindow_
HeightMapWindow *	pluginWindow_
HeightMapModifier	modifier_

Detailed Description

This class represents Height Map plugin. This interface is visible to the application.

This plugin provides on-the-fly interactive preview functionality. Plugins with interactive preview inherit ModifierInterface. Plugins with interactive preview feature have more complex design compared to solutions which use simple modal progress bar. The reason is that interactive preview creates concurrent access to memory from multiple threads.

Height Map plugin uses delayed lazy initialization of GUI widgets to save plugin loading time and memory.

Constructor & Destructor Documentation

HeightMapPlugin()

HeightMapPlugin::HeightMapPlugin

(

)

Member Function Documentation

applyModifier()

void HeightMapPlugin::applyModifier ( Page *  page )

virtual

Implements ModifierInterface.

initialize()

void HeightMapPlugin::initialize ( MainWindow *  mainWindow )

virtual

Implements PluginInterface.

isModifierEnabled()

bool HeightMapPlugin::isModifierEnabled ( )

virtual

Implements ModifierInterface.

slotPlugin

void HeightMapPlugin::slotPlugin ( )

slot

Referenced by initialize().

Member Data Documentation

mainWindow_

MainWindow* HeightMapPlugin::mainWindow_

protected

Referenced by initialize(), and slotPlugin().

modifier_

HeightMapModifier HeightMapPlugin::modifier_

protected

Must be created from the constructor.

Referenced by applyModifier(), initialize(), isModifierEnabled(), and slotPlugin().

pluginWindow_

HeightMapWindow* HeightMapPlugin::pluginWindow_

protected

First time use creates GUI.

Referenced by slotPlugin().

---

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

• HeightMapPlugin.hpp
• HeightMapPlugin.cpp