#include <WtModuleWidget.h>

Inheritance diagram for WtModuleWidget:

Collaboration diagram for WtModuleWidget:

[legend]

Public Member Functions
	WtModuleWidget (std::shared_ptr< Module > base=nullptr)

virtual	~WtModuleWidget ()

std::string	caption () const override

bool	captionVisible () const override
	It is possible to hide caption in GUI.

std::string	name () const override
	Name makes this model unique.

void	setName (std::string name)

std::string	portCaption (PortType portType, PortIndex portIndex) const override
	Port caption is used in GUI to label individual ports.

std::string	nodeTips () const override

std::string	portTips (PortType portType, PortIndex portIndex) const override

std::string	validationMessage () const override

unsigned int	nPorts (PortType portType) const override

bool	hotkeyEnabled () const override

bool	allowExported () const override

bool	portCaptionVisible (PortType portType, PortIndex portIndex) const override
	It is possible to hide port caption in GUI.

std::shared_ptr< WtNodeData >	outData (PortIndex port) override

void	setInData (std::shared_ptr< WtNodeData > data, PortIndex portIndex) override
	Triggers the algorithm.

bool	tryInData (PortIndex portIndex, std::shared_ptr< WtNodeData > nodeData) override

NodeDataType	dataType (PortType portType, PortIndex portIndex) const override

NodeValidationState	validationState () const override

std::shared_ptr< Module >	getModule ()

void	enableEditing ()

void	disableEditing ()

Public Member Functions inherited from WtNodeDataModel
	WtNodeDataModel ()

virtual	~WtNodeDataModel ()=default

virtual ConnectionPolicy	portOutConnectionPolicy (PortIndex) const

virtual ConnectionPolicy	portInConnectionPolicy (PortIndex) const

WtNodeStyle const &	nodeStyle () const

void	setNodeStyle (WtNodeStyle const &style)

virtual bool	resizable () const

virtual WtNodePainterDelegate *	painterDelegate () const

virtual void	inputConnectionCreated (WtConnection const &)

virtual void	inputConnectionDeleted (WtConnection const &)

virtual void	outputConnectionCreated (WtConnection const &)

virtual void	outputConnectionDeleted (WtConnection const &)

Protected Types
using	OutFieldPtr = std::vector<std::shared_ptr<WtFieldData>>

using	InFieldPtr = std::vector<std::shared_ptr<WtFieldData>>

Protected Member Functions
virtual void	updateModule ()

Protected Attributes
InFieldPtr	input_fields

OutFieldPtr	output_fields

std::string	m_name

std::shared_ptr< Module >	m_Module = nullptr

NodeValidationState	modelValidationState = NodeValidationState::Warning

std::string	modelValidationError = "Missing or incorrect inputs"

Private Member Functions
FBase *	getField (PortType portType, PortIndex portIndex) const

std::vector< FBase * > &	getOutputFields ()

std::vector< FBase * > &	getInputFields ()

Private Attributes
bool	mEditingEnabled = true

Additional Inherited Members
Public Types inherited from WtNodeDataModel
enum class	ConnectionPolicy { One , Many }

Detailed Description

Definition at line 14 of file WtModuleWidget.h.

Member Typedef Documentation

◆ InFieldPtr

using WtModuleWidget::InFieldPtr = std::vector<std::shared_ptr<WtFieldData>>

protected

Definition at line 72 of file WtModuleWidget.h.

◆ OutFieldPtr

using WtModuleWidget::OutFieldPtr = std::vector<std::shared_ptr<WtFieldData>>

protected

Definition at line 70 of file WtModuleWidget.h.

Constructor & Destructor Documentation

◆ WtModuleWidget()

WtModuleWidget::WtModuleWidget ( std::shared_ptr< Module > base = nullptr )

Definition at line 3 of file WtModuleWidget.cpp.

Here is the call graph for this function:

◆ ~WtModuleWidget()

virtual WtModuleWidget::~WtModuleWidget ( )

inlinevirtual

Definition at line 19 of file WtModuleWidget.h.

Member Function Documentation

◆ allowExported()

bool WtModuleWidget::allowExported ( ) const

inlineoverridevirtual

Reimplemented from WtNodeDataModel.

Definition at line 43 of file WtModuleWidget.h.

◆ caption()

std::string WtModuleWidget::caption ( ) const

overridevirtual

Implements WtNodeDataModel.

Definition at line 37 of file WtModuleWidget.cpp.

◆ captionVisible()

bool WtModuleWidget::captionVisible ( ) const

overridevirtual

It is possible to hide caption in GUI.

Reimplemented from WtNodeDataModel.

Definition at line 42 of file WtModuleWidget.cpp.

◆ dataType()

NodeDataType WtModuleWidget::dataType	(	PortType	portType,
		PortIndex	portIndex ) const

overridevirtual

Implements WtNodeDataModel.

Definition at line 172 of file WtModuleWidget.cpp.

Here is the call graph for this function:

◆ disableEditing()

void WtModuleWidget::disableEditing ( )

Definition at line 196 of file WtModuleWidget.cpp.

◆ enableEditing()

void WtModuleWidget::enableEditing ( )

Definition at line 191 of file WtModuleWidget.cpp.

◆ getField()

FBase * WtModuleWidget::getField	(	PortType	portType,
		PortIndex	portIndex ) const

private

Definition at line 222 of file WtModuleWidget.cpp.

Here is the caller graph for this function:

◆ getInputFields()

std::vector< FBase * > & WtModuleWidget::getInputFields ( )

private

Definition at line 232 of file WtModuleWidget.cpp.

Here is the caller graph for this function:

◆ getModule()

std::shared_ptr< Module > WtModuleWidget::getModule ( )

Definition at line 186 of file WtModuleWidget.cpp.

Here is the caller graph for this function:

◆ getOutputFields()

std::vector< FBase * > & WtModuleWidget::getOutputFields ( )

private

Definition at line 227 of file WtModuleWidget.cpp.

Here is the caller graph for this function:

◆ hotkeyEnabled()

bool WtModuleWidget::hotkeyEnabled ( ) const

inlineoverridevirtual

Reimplemented from WtNodeDataModel.

Definition at line 41 of file WtModuleWidget.h.

◆ name()

std::string WtModuleWidget::name ( ) const

overridevirtual

Name makes this model unique.

Implements WtNodeDataModel.

Definition at line 47 of file WtModuleWidget.cpp.

Here is the caller graph for this function:

◆ nodeTips()

std::string WtModuleWidget::nodeTips ( ) const

overridevirtual

Reimplemented from WtNodeDataModel.

Definition at line 61 of file WtModuleWidget.cpp.

◆ nPorts()

unsigned int WtModuleWidget::nPorts ( PortType portType ) const

overridevirtual

Implements WtNodeDataModel.

Definition at line 86 of file WtModuleWidget.cpp.

◆ outData()

std::shared_ptr< WtNodeData > WtModuleWidget::outData ( PortIndex port )

overridevirtual

Implements WtNodeDataModel.

Definition at line 96 of file WtModuleWidget.cpp.

◆ portCaption()

std::string WtModuleWidget::portCaption	(	PortType	,
		PortIndex	) const

overridevirtual

Port caption is used in GUI to label individual ports.

Reimplemented from WtNodeDataModel.

Definition at line 52 of file WtModuleWidget.cpp.

Here is the call graph for this function:

◆ portCaptionVisible()

bool WtModuleWidget::portCaptionVisible	(	PortType	,
		PortIndex	) const

overridevirtual

It is possible to hide port caption in GUI.

Reimplemented from WtNodeDataModel.

Definition at line 91 of file WtModuleWidget.cpp.

◆ portTips()

std::string WtModuleWidget::portTips	(	PortType	portType,
		PortIndex	portIndex ) const

overridevirtual

Reimplemented from WtNodeDataModel.

Definition at line 66 of file WtModuleWidget.cpp.

Here is the call graph for this function:

◆ setInData()

void WtModuleWidget::setInData	(	std::shared_ptr< WtNodeData >	nodeData,
		PortIndex	port )

overridevirtual

Triggers the algorithm.

Implements WtNodeDataModel.

Definition at line 101 of file WtModuleWidget.cpp.

Here is the call graph for this function:

◆ setName()

void WtModuleWidget::setName ( std::string name )

inline

Definition at line 29 of file WtModuleWidget.h.

Here is the call graph for this function:

◆ tryInData()

bool WtModuleWidget::tryInData	(	PortIndex	portIndex,
		std::shared_ptr< WtNodeData >	nodeData )

overridevirtual

Reimplemented from WtNodeDataModel.

Definition at line 126 of file WtModuleWidget.cpp.

Here is the call graph for this function:

◆ updateModule()

void WtModuleWidget::updateModule ( )

protectedvirtual

Definition at line 201 of file WtModuleWidget.cpp.

Here is the caller graph for this function:

◆ validationMessage()

std::string WtModuleWidget::validationMessage ( ) const

overridevirtual

Reimplemented from WtNodeDataModel.

Definition at line 81 of file WtModuleWidget.cpp.

◆ validationState()

NodeValidationState WtModuleWidget::validationState ( ) const

overridevirtual

Reimplemented from WtNodeDataModel.

Definition at line 181 of file WtModuleWidget.cpp.

Member Data Documentation

◆ input_fields

InFieldPtr WtModuleWidget::input_fields

protected

Definition at line 74 of file WtModuleWidget.h.

◆ m_Module

std::shared_ptr<Module> WtModuleWidget::m_Module = nullptr

protected

Definition at line 80 of file WtModuleWidget.h.

◆ m_name

std::string WtModuleWidget::m_name

protected

Definition at line 78 of file WtModuleWidget.h.

◆ mEditingEnabled

bool WtModuleWidget::mEditingEnabled = true

private

Definition at line 96 of file WtModuleWidget.h.

◆ modelValidationError

std::string WtModuleWidget::modelValidationError = "Missing or incorrect inputs"

protected

Definition at line 84 of file WtModuleWidget.h.

◆ modelValidationState

NodeValidationState WtModuleWidget::modelValidationState = NodeValidationState::Warning

protected

Definition at line 82 of file WtModuleWidget.h.

◆ output_fields

OutFieldPtr WtModuleWidget::output_fields

protected

Definition at line 76 of file WtModuleWidget.h.

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

D:/Peridyno/peridyno/src/Rendering/GUI/WtGUI/NodeEditor/WtModuleWidget.h
D:/Peridyno/peridyno/src/Rendering/GUI/WtGUI/NodeEditor/WtModuleWidget.cpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ InFieldPtr

◆ OutFieldPtr

Constructor & Destructor Documentation

◆ WtModuleWidget()

◆ ~WtModuleWidget()

Member Function Documentation

◆ allowExported()

◆ caption()

◆ captionVisible()

◆ dataType()

◆ disableEditing()

◆ enableEditing()

◆ getField()

◆ getInputFields()

◆ getModule()

◆ getOutputFields()

◆ hotkeyEnabled()

◆ name()

◆ nodeTips()

◆ nPorts()

◆ outData()

◆ portCaption()

◆ portCaptionVisible()

◆ portTips()

◆ setInData()

◆ setName()

◆ tryInData()

◆ updateModule()

◆ validationMessage()

◆ validationState()

Member Data Documentation

◆ input_fields

◆ m_Module

◆ m_name

◆ mEditingEnabled

◆ modelValidationError

◆ modelValidationState

◆ output_fields