Avogadro::QtGui::ScenePlugin

class ScenePlugin : public QObject

Public Types

enum DefaultBehavior

Returns if this plugin should be considered in the default behavior, or it should reset to true or false.

Values:

enumerator Ignore

enumerator False

enumerator True

Public Functions

explicit ScenePlugin(QObject *parent = nullptr)

~ScenePlugin() override

virtual void process(const QtGui::Molecule &molecule, Rendering::GroupNode &node)

Process the supplied atom, and add the necessary primitives to the scene.

virtual void processEditable(const RWMolecule &molecule, Rendering::GroupNode &node)

virtual QString name() const = 0

The name of the scene plugin, will be displayed in the user interface.

virtual QString description() const = 0

A description of the scene plugin, may be displayed in the user interface.

virtual bool isEnabled() const

Returns true if the scene plugin has been enabled and is active.

virtual bool isActiveLayerEnabled() const

Returns true if the scene plugin has been enabled and is active in the active scene.

virtual void setEnabled(bool enable)

Set the enabled state of the plugin (default should be false).

inline virtual bool isApplicable() const

Returns:

whether this plugin works with the current molecule. This is used to determine if the plugin should be enabled in the UI. For example, a plugin that only works with unit cells would return false if the current molecule does not include a unit cell.

virtual QWidget *setupWidget()

Returns:

the widget for plugin settings (e.g., colors, widths, etc.)

inline virtual bool hasSetupWidget() const

This method exists to query without creating the widget.

Returns:

true if the plugin has a setup widget

inline virtual DefaultBehavior defaultBehavior() const

Signals

void drawablesChanged()

Protected Attributes

PluginLayerManager m_layerManager