Class SBGDynamicalModelParticleSystemFactory#

ClassList > SBGDynamicalModelParticleSystemFactory

This class describes a widget that allows users to view and potentially edit properties of data graph nodes.

#include <SBGDynamicalModelParticleSystemFactory.hpp>

Inherits the following classes: SBGDataGraphNodeFactory

Public Slots inherited from SBGWindowWidget#

Type	Name
slot void	stopHighlighting Handles the stop highlighting.

Public Signals inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
signal void	shown (bool) Emitted when the widget is shown or hidden.

Public Functions#

Type	Name
virtual SBMDynamicalModelParticleSystem *	create (const SBNodeIndexer & nodeIndexer) = 0 Creates a particle system associated with the specified node indexer.
virtual int	getFormat () override const Returns the format.
virtual QPixmap	getLogo () override const Returns the pixmap logo.
virtual QString	getName () override const Returns the widget name (used as a title for the embedding window)
virtual SBUUID	getUUID () override const Returns the widget UUID.
virtual void	loadSettings (SBGSettings * setting) override Loads configuration settings from the provided settings object.
virtual void	saveSettings (SBGSettings * setting) override Saves the current configuration settings to the provided settings object.
virtual	~SBGDynamicalModelParticleSystemFactory () Destroys the SBGDynamicalModelParticleSystemFactory instance.

Public Functions inherited from SBGDataGraphNodeFactory#

See SBGDataGraphNodeFactory

Type	Name
virtual SBNode *	create () Creates a node.
virtual int	getFormat () override const Returns the format.
virtual QPixmap	getLogo () override const Returns the pixmap logo.
virtual QString	getName () override const Returns the widget name (used as a title for the embedding window)
virtual SBUUID	getUUID () override const Returns the widget UUID.
virtual bool	hasGUI () const Returns whether the factory has a GUI.
virtual void	loadSettings (SBGSettings * setting) override Load GUI settings.
virtual void	saveSettings (SBGSettings * setting) override Save GUI settings.
virtual	~SBGDataGraphNodeFactory () Destructor.

Public Functions inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
virtual QString	getCitation () const Returns the citation information.
SBGWindowDock *	getDockWindow () const Returns the pointer to the embedding dock window, if any.
virtual int	getFormat () const Returns the format.
bool	getHighlightingFlag () const Returns the highlighting flag.
bool	getLockedFlag () const Returns whether the widget is locked (on top)
virtual QPixmap	getLogo () const Returns the pixmap logo.
virtual QString	getName () const Returns the widget name (used as a title for the embedding window)
SBUUID	getPreferencesUUID () const Returns the UUID of preferences (static attributes), if present.
virtual SBUUID	getUUID () const Returns the widget UUID.
SBGWindow *	getWindow () const Returns the pointer to the embedding window, if any.
void	highlight (const SBQuantity::second & duration=SBQuantity::second(1.0)) Highlights the widget for a moment.
void	loadDefaultSettings () Loads default settings.
virtual void	loadSettings (SBGSettings * settings) Loads `settings` .
void	saveDefaultSettings () Saves default settings.
virtual void	saveSettings (SBGSettings * settings) Saves `settings` .
void	setHighlightingFlag (bool highlightingFlag) Sets the highlighting flag.
void	setLockedFlag (bool lockedFlag) Sets whether the widget is locked (on top)
void	setPreferencesUUID (const SBUUID & preferencesUUID) Sets the UUID of preferences (static attributes), if present.
virtual	~SBGWindowWidget () Destructor.

Protected Attributes inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
SBGWindowWidgetData *	dataPointer A pointer to the private data.

Protected Functions#

Type	Name
	SBGDynamicalModelParticleSystemFactory () Constructs a new SBGDynamicalModelParticleSystemFactory instance.

Protected Functions inherited from SBGDataGraphNodeFactory#

See SBGDataGraphNodeFactory

Type	Name
	SBGDataGraphNodeFactory () Protected constructor.

Protected Functions inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
	SBGWindowWidget () Protected constructor.
	SBGWindowWidget (SBGWindowWidgetData * dataPointer) Protected constructor.
void	changeEvent (QEvent * event) Handles events.
void	hideEvent (QHideEvent * event) Handles hide event.
void	showEvent (QShowEvent * event) Handles show event.

Public Functions Documentation#

function create#

Creates a particle system associated with the specified node indexer.

virtual SBMDynamicalModelParticleSystem * SBGDynamicalModelParticleSystemFactory::create (
    const SBNodeIndexer & nodeIndexer
) = 0

Parameters:

nodeIndexer Indexer identifying the node for which the particle system is created.

Returns:

Pointer to the created particle system, or nullptr if creation fails.

function getFormat#

Returns the format.

virtual int SBGDynamicalModelParticleSystemFactory::getFormat () override const

Retrieves the format identifier for this factory.

Returns:

The format identifier as an integer.

Implements SBGDataGraphNodeFactory::getFormat

function getLogo#

Returns the pixmap logo.

virtual QPixmap SBGDynamicalModelParticleSystemFactory::getLogo () override const

Retrieves the logo pixmap of this factory.

Returns:

The logo as a QPixmap.

Implements SBGDataGraphNodeFactory::getLogo

function getName#

Returns the widget name (used as a title for the embedding window)

virtual QString SBGDynamicalModelParticleSystemFactory::getName () override const

Retrieves the display name of this factory.

Returns:

The name as a QString.

Implements SBGDataGraphNodeFactory::getName

function getUUID#

Returns the widget UUID.

virtual SBUUID SBGDynamicalModelParticleSystemFactory::getUUID () override const

Retrieves the universally unique identifier (UUID) of this factory.

Returns:

The factory's UUID.

Implements SBGDataGraphNodeFactory::getUUID

function loadSettings#

Loads configuration settings from the provided settings object.

virtual void SBGDynamicalModelParticleSystemFactory::loadSettings (
    SBGSettings * setting
) override

Parameters:

setting Pointer to the settings object from which to load.

Implements SBGDataGraphNodeFactory::loadSettings

function saveSettings#

Saves the current configuration settings to the provided settings object.

virtual void SBGDynamicalModelParticleSystemFactory::saveSettings (
    SBGSettings * setting
) override

Parameters:

setting Pointer to the settings object to which to save.

Implements SBGDataGraphNodeFactory::saveSettings

function ~SBGDynamicalModelParticleSystemFactory#

Destroys the SBGDynamicalModelParticleSystemFactory instance.

virtual SBGDynamicalModelParticleSystemFactory::~SBGDynamicalModelParticleSystemFactory ()

Protected Functions Documentation#

function SBGDynamicalModelParticleSystemFactory#

Constructs a new SBGDynamicalModelParticleSystemFactory instance.

SBGDynamicalModelParticleSystemFactory::SBGDynamicalModelParticleSystemFactory ()