Class SBGInteractionModelParticleSystemFactory#

ClassList > SBGInteractionModelParticleSystemFactory

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

#include <SBGInteractionModelParticleSystemFactory.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 SBMInteractionModelParticleSystem *	create (SBParticleSystem * particleSystem) = 0 Creates an interaction model for a particle system.
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 settings for the factory from the provided settings object.
virtual void	saveSettings (SBGSettings * setting) override Saves the current settings of the factory to the provided settings object.
virtual	~SBGInteractionModelParticleSystemFactory () Destroys the SBGInteractionModelParticleSystemFactory .

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
	SBGInteractionModelParticleSystemFactory () Constructs a new SBGInteractionModelParticleSystemFactory .

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 an interaction model for a particle system.

virtual SBMInteractionModelParticleSystem * SBGInteractionModelParticleSystemFactory::create (
    SBParticleSystem * particleSystem
) = 0

This method constructs a new instance of an interaction model for a particle system based on the provided particle system.

Parameters:

particleSystem The particle system for which the interaction model is created.

Returns:

A pointer to the newly created SBMInteractionModelParticleSystem, or nullptr if creation fails.

function getFormat#

Returns the format.

virtual int SBGInteractionModelParticleSystemFactory::getFormat () override const

Returns the format identifier for this factory.

The format may be used to categorize or filter factories.

Returns:

An integer representing the format.

Implements SBGDataGraphNodeFactory::getFormat

function getLogo#

Returns the pixmap logo.

virtual QPixmap SBGInteractionModelParticleSystemFactory::getLogo () override const

Returns the logo pixmap for this factory.

The pixmap is used as an icon representing the factory in the UI.

Returns:

A QPixmap containing the logo.

Implements SBGDataGraphNodeFactory::getLogo

function getName#

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

virtual QString SBGInteractionModelParticleSystemFactory::getName () override const

Returns the human-readable name of this factory.

This name is used as the title for the embedding window when displayed in the UI.

Returns:

The name of the factory as a QString.

Implements SBGDataGraphNodeFactory::getName

function getUUID#

Returns the widget UUID.

virtual SBUUID SBGInteractionModelParticleSystemFactory::getUUID () override const

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

The UUID uniquely identifies the type of interaction model particle system factory.

Returns:

The UUID of the factory.

Implements SBGDataGraphNodeFactory::getUUID

function loadSettings#

Loads settings for the factory from the provided settings object.

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

The factory reads configuration values to initialize its state.

Parameters:

setting The settings object from which to load configuration.

Implements SBGDataGraphNodeFactory::loadSettings

function saveSettings#

Saves the current settings of the factory to the provided settings object.

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

The factory writes its configuration values for persistence.

Parameters:

setting The settings object to which configuration will be saved.

Implements SBGDataGraphNodeFactory::saveSettings

function ~SBGInteractionModelParticleSystemFactory#

Destroys the SBGInteractionModelParticleSystemFactory .

virtual SBGInteractionModelParticleSystemFactory::~SBGInteractionModelParticleSystemFactory ()

Releases any resources held by the factory.

Protected Functions Documentation#

function SBGInteractionModelParticleSystemFactory#

Constructs a new SBGInteractionModelParticleSystemFactory .

SBGInteractionModelParticleSystemFactory::SBGInteractionModelParticleSystemFactory ()

Initializes the factory for creating particle system interaction models.