Qt::QtModuleWidget Class Reference

#include <QtModuleWidget.h>

Inheritance diagram for Qt::QtModuleWidget:

Collaboration diagram for Qt::QtModuleWidget:

Public Member Functions
	QtModuleWidget (std::shared_ptr< Module > base=nullptr)
virtual	~QtModuleWidget ()
QString	caption () const override
bool	captionVisible () const override
	whether to hide caption in GUI
QString	name () const override
void	setName (QString name)
QString	portCaption (PortType portType, PortIndex portIndex) const override
QString	nodeTips () const override
QString	portTips (PortType portType, PortIndex portIndex) const override
QString	validationMessage () const override
unsigned int	nPorts (PortType portType) const override
bool	hotkeyEnabled () const override
bool	allowImported () const override
bool	allowExported () const override
bool	portCaptionVisible (PortType portType, PortIndex portIndex) const override
std::shared_ptr< QtNodeData >	outData (PortIndex port) override
void	setInData (std::shared_ptr< QtNodeData > data, PortIndex portIndex) override
bool	tryInData (PortIndex portIndex, std::shared_ptr< QtNodeData > nodeData) override
NodeDataType	dataType (PortType portType, PortIndex portIndex) const override
QWidget *	embeddedWidget () override
NodeValidationState	validationState () const override
QtNodeDataModel::ConnectionPolicy	portInConnectionPolicy (PortIndex portIndex) const override
std::shared_ptr< Module >	getModule ()
void	enableEditing ()
	When enabled, the scenegraph can be updated as long as the corresponding GUI is updated.
void	disableEditing ()
	When disabled, the scenegraph can not be affected by the corresponding GUI.

Protected Types
using	ImportModulePtr = std::vector<std::shared_ptr<QtImportModule>>
using	ExportModulePtr = std::shared_ptr<QtExportModule>
using	OutFieldPtr = std::vector<std::shared_ptr<QtFieldData>>
using	InFieldPtr = std::vector<std::shared_ptr<QtFieldData>>

Protected Member Functions
virtual void	updateModule ()

Protected Attributes
ImportModulePtr	mModuleImports
ExportModulePtr	mModuleExport
InFieldPtr	input_fields
OutFieldPtr	output_fields
QString	m_name
std::shared_ptr< Module >	mModule = nullptr
NodeValidationState	modelValidationState = NodeValidationState::Warning
QString	modelValidationError = QString("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

Detailed Description

The model dictates the number of inputs and outputs for the Node. In this example it has no logic.

Definition at line 24 of file QtModuleWidget.h.

Member Typedef Documentation

ExportModulePtr

using Qt::QtModuleWidget::ExportModulePtr = std::shared_ptr<QtExportModule>

protected

Definition at line 95 of file QtModuleWidget.h.

ImportModulePtr

using Qt::QtModuleWidget::ImportModulePtr = std::vector<std::shared_ptr<QtImportModule>>

protected

Definition at line 94 of file QtModuleWidget.h.

InFieldPtr

using Qt::QtModuleWidget::InFieldPtr = std::vector<std::shared_ptr<QtFieldData>>

protected

Definition at line 104 of file QtModuleWidget.h.

OutFieldPtr

using Qt::QtModuleWidget::OutFieldPtr = std::vector<std::shared_ptr<QtFieldData>>

protected

Definition at line 100 of file QtModuleWidget.h.

Constructor & Destructor Documentation

QtModuleWidget()

Qt::QtModuleWidget::QtModuleWidget

(

std::shared_ptr< Module >

base = nullptr

)

Definition at line 10 of file QtModuleWidget.cpp.

Here is the call graph for this function:

~QtModuleWidget()

virtual Qt::QtModuleWidget::~QtModuleWidget ( )

inlinevirtual

Definition at line 31 of file QtModuleWidget.h.

Member Function Documentation

allowExported()

bool Qt::QtModuleWidget::allowExported ( ) const

inlineoverride

Definition at line 57 of file QtModuleWidget.h.

allowImported()

bool Qt::QtModuleWidget::allowImported ( ) const

inlineoverride

Definition at line 56 of file QtModuleWidget.h.

Here is the caller graph for this function:

caption()

QString Qt::QtModuleWidget::caption ( ) const

override

Definition at line 131 of file QtModuleWidget.cpp.

Here is the call graph for this function:

captionVisible()

bool Qt::QtModuleWidget::captionVisible ( ) const

override

whether to hide caption in GUI

Definition at line 137 of file QtModuleWidget.cpp.

dataType()

NodeDataType Qt::QtModuleWidget::dataType ( PortType portType, PortIndex portIndex ) const

override

Definition at line 68 of file QtModuleWidget.cpp.

Here is the call graph for this function:

disableEditing()

void Qt::QtModuleWidget::disableEditing

(

)

When disabled, the scenegraph can not be affected by the corresponding GUI.

Definition at line 390 of file QtModuleWidget.cpp.

embeddedWidget()

QWidget * Qt::QtModuleWidget::embeddedWidget ( )

inlineoverride

Definition at line 71 of file QtModuleWidget.h.

enableEditing()

void Qt::QtModuleWidget::enableEditing

(

)

When enabled, the scenegraph can be updated as long as the corresponding GUI is updated.

Definition at line 385 of file QtModuleWidget.cpp.

getField()

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

private

Definition at line 421 of file QtModuleWidget.cpp.

Here is the caller graph for this function:

getInputFields()

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

private

Definition at line 431 of file QtModuleWidget.cpp.

Here is the caller graph for this function:

getModule()

std::shared_ptr< Module > Qt::QtModuleWidget::getModule

(

)

Definition at line 380 of file QtModuleWidget.cpp.

Here is the caller graph for this function:

getOutputFields()

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

private

Definition at line 426 of file QtModuleWidget.cpp.

Here is the caller graph for this function:

hotkeyEnabled()

bool Qt::QtModuleWidget::hotkeyEnabled ( ) const

inlineoverride

Definition at line 54 of file QtModuleWidget.h.

name()

QString Qt::QtModuleWidget::name ( ) const

override

Definition at line 142 of file QtModuleWidget.cpp.

Here is the caller graph for this function:

nodeTips()

QString Qt::QtModuleWidget::nodeTips ( ) const

override

Definition at line 192 of file QtModuleWidget.cpp.

Here is the call graph for this function:

nPorts()

unsigned int Qt::QtModuleWidget::nPorts ( PortType portType ) const

override

Definition at line 51 of file QtModuleWidget.cpp.

outData()

std::shared_ptr< QtNodeData > Qt::QtModuleWidget::outData ( PortIndex port )

override

Definition at line 112 of file QtModuleWidget.cpp.

portCaption()

QString Qt::QtModuleWidget::portCaption ( PortType portType, PortIndex portIndex ) const

override

Definition at line 153 of file QtModuleWidget.cpp.

Here is the call graph for this function:

portCaptionVisible()

bool Qt::QtModuleWidget::portCaptionVisible ( PortType portType, PortIndex portIndex ) const

override

Definition at line 147 of file QtModuleWidget.cpp.

portInConnectionPolicy()

QtNodeDataModel::ConnectionPolicy Qt::QtModuleWidget::portInConnectionPolicy ( PortIndex portIndex ) const

override

Definition at line 364 of file QtModuleWidget.cpp.

portTips()

QString Qt::QtModuleWidget::portTips ( PortType portType, PortIndex portIndex ) const

override

Definition at line 197 of file QtModuleWidget.cpp.

Here is the call graph for this function:

setInData()

void Qt::QtModuleWidget::setInData ( std::shared_ptr< QtNodeData > data, PortIndex portIndex )

override

Definition at line 243 of file QtModuleWidget.cpp.

Here is the call graph for this function:

setName()

void Qt::QtModuleWidget::setName ( QString name )

inline

Definition at line 41 of file QtModuleWidget.h.

Here is the call graph for this function:

tryInData()

bool Qt::QtModuleWidget::tryInData ( PortIndex portIndex, std::shared_ptr< QtNodeData > nodeData )

override

Definition at line 294 of file QtModuleWidget.cpp.

Here is the call graph for this function:

updateModule()

void Qt::QtModuleWidget::updateModule ( )

protectedvirtual

Definition at line 400 of file QtModuleWidget.cpp.

Here is the caller graph for this function:

validationMessage()

QString Qt::QtModuleWidget::validationMessage ( ) const

override

Definition at line 395 of file QtModuleWidget.cpp.

validationState()

NodeValidationState Qt::QtModuleWidget::validationState ( ) const

override

Definition at line 359 of file QtModuleWidget.cpp.

Member Data Documentation

input_fields

InFieldPtr Qt::QtModuleWidget::input_fields

protected

Definition at line 105 of file QtModuleWidget.h.

m_name

QString Qt::QtModuleWidget::m_name

protected

Definition at line 108 of file QtModuleWidget.h.

mEditingEnabled

bool Qt::QtModuleWidget::mEditingEnabled = true

private

Definition at line 123 of file QtModuleWidget.h.

mModule

std::shared_ptr<Module> Qt::QtModuleWidget::mModule = nullptr

protected

Definition at line 110 of file QtModuleWidget.h.

mModuleExport

ExportModulePtr Qt::QtModuleWidget::mModuleExport

protected

Definition at line 98 of file QtModuleWidget.h.

mModuleImports

ImportModulePtr Qt::QtModuleWidget::mModuleImports

protected

Definition at line 97 of file QtModuleWidget.h.

modelValidationError

QString Qt::QtModuleWidget::modelValidationError = QString("Missing or incorrect inputs")

protected

Definition at line 113 of file QtModuleWidget.h.

modelValidationState

NodeValidationState Qt::QtModuleWidget::modelValidationState = NodeValidationState::Warning

protected

Definition at line 112 of file QtModuleWidget.h.

output_fields

OutFieldPtr Qt::QtModuleWidget::output_fields

protected

Definition at line 106 of file QtModuleWidget.h.

---

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

• D:/Peridyno/peridyno/src/Rendering/GUI/QtGUI/NodeEditor/QtModuleWidget.h
• D:/Peridyno/peridyno/src/Rendering/GUI/QtGUI/NodeEditor/QtModuleWidget.cpp