PeriDyno 1.2.1
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
Qt::QtNodeWidget Class Reference

The model dictates the number of inputs and outputs for the Node. More...

#include <QtNodeWidget.h>

Inheritance diagram for Qt::QtNodeWidget:
Inheritance graph
[legend]
Collaboration diagram for Qt::QtNodeWidget:
Collaboration graph
[legend]

Public Member Functions

 QtNodeWidget (std::shared_ptr< Node > base=nullptr)
 
virtual ~QtNodeWidget ()
 
QString caption () const override
 
QString name () const override
 
QString nodeTips () const override
 
QString portCaption (PortType portType, PortIndex portIndex) const override
 
QString portTips (PortType portType, PortIndex portIndex) const override
 
QString validationMessage () const override
 
unsigned int nPorts (PortType portType) const override
 
bool portCaptionVisible (PortType portType, PortIndex portIndex) const override
 
bool allowImported () const override
 
bool allowExported () const override
 
bool hotKeyRenderChecked () const override
 
bool hotKeySimChecked () const override
 
bool hotKeyAutoSyncChecked () const override
 
bool tryInData (PortIndex portIndex, std::shared_ptr< QtNodeData > nodeData) override
 To test whether nodaData can be set as the input data for portIndex.
 
void setInData (std::shared_ptr< QtNodeData > data, PortIndex portIndex) 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< Node > getNode ()
 
std::shared_ptr< QtNodeData > outData (PortIndex port) override
 
std::vector< FBase * > & getOutputFields () const
 
std::vector< FBase * > & getInputFields () const
 
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 ExportNodePtr = std::shared_ptr<QtExportNode>
 
using ImportNodePtr = std::vector<std::shared_ptr<QtImportNode>>
 
using OutFieldPtr = std::vector<std::shared_ptr<QtFieldData>>
 
using InFieldPtr = std::vector<std::shared_ptr<QtFieldData>>
 

Protected Member Functions

virtual void updateModule ()
 

Protected Attributes

ImportNodePtr mNodeInport
 
ExportNodePtr mNodeExport
 
InFieldPtr mFieldInport
 
OutFieldPtr mFieldExport
 
std::shared_ptr< Node > mNode = nullptr
 
NodeValidationState modelValidationState = NodeValidationState::Valid
 
QString modelValidationError = QString("Missing or incorrect inputs")
 

Private Attributes

bool mEditingEnabled = true
 

Detailed Description

The model dictates the number of inputs and outputs for the Node.

Definition at line 21 of file QtNodeWidget.h.

Member Typedef Documentation

◆ ExportNodePtr

using Qt::QtNodeWidget::ExportNodePtr = std::shared_ptr<QtExportNode>
protected

Definition at line 99 of file QtNodeWidget.h.

◆ ImportNodePtr

using Qt::QtNodeWidget::ImportNodePtr = std::vector<std::shared_ptr<QtImportNode>>
protected

Definition at line 100 of file QtNodeWidget.h.

◆ InFieldPtr

using Qt::QtNodeWidget::InFieldPtr = std::vector<std::shared_ptr<QtFieldData>>
protected

Definition at line 106 of file QtNodeWidget.h.

◆ OutFieldPtr

using Qt::QtNodeWidget::OutFieldPtr = std::vector<std::shared_ptr<QtFieldData>>
protected

Definition at line 105 of file QtNodeWidget.h.

Constructor & Destructor Documentation

◆ QtNodeWidget()

Qt::QtNodeWidget::QtNodeWidget ( std::shared_ptr< Node > base = nullptr)

Definition at line 16 of file QtNodeWidget.cpp.

Here is the call graph for this function:

◆ ~QtNodeWidget()

Qt::QtNodeWidget::~QtNodeWidget ( )
virtual

Definition at line 55 of file QtNodeWidget.cpp.

Member Function Documentation

◆ allowExported()

bool Qt::QtNodeWidget::allowExported ( ) const
inlineoverride

Definition at line 49 of file QtNodeWidget.h.

◆ allowImported()

bool Qt::QtNodeWidget::allowImported ( ) const
inlineoverride

Definition at line 48 of file QtNodeWidget.h.

◆ caption()

QString Qt::QtNodeWidget::caption ( ) const
override

Definition at line 138 of file QtNodeWidget.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dataType()

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

Definition at line 76 of file QtNodeWidget.cpp.

Here is the call graph for this function:

◆ disableEditing()

void Qt::QtNodeWidget::disableEditing ( )

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

Definition at line 396 of file QtNodeWidget.cpp.

◆ embeddedWidget()

QWidget * Qt::QtNodeWidget::embeddedWidget ( )
inlineoverride

Definition at line 72 of file QtNodeWidget.h.

◆ enableEditing()

void Qt::QtNodeWidget::enableEditing ( )

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

Definition at line 391 of file QtNodeWidget.cpp.

◆ getInputFields()

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

Definition at line 386 of file QtNodeWidget.cpp.

Here is the caller graph for this function:

◆ getNode()

std::shared_ptr< Node > Qt::QtNodeWidget::getNode ( )

Definition at line 366 of file QtNodeWidget.cpp.

Here is the caller graph for this function:

◆ getOutputFields()

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

Definition at line 381 of file QtNodeWidget.cpp.

Here is the caller graph for this function:

◆ hotKeyAutoSyncChecked()

bool Qt::QtNodeWidget::hotKeyAutoSyncChecked ( ) const
inlineoverride

Definition at line 55 of file QtNodeWidget.h.

◆ hotKeyRenderChecked()

bool Qt::QtNodeWidget::hotKeyRenderChecked ( ) const
inlineoverride

Definition at line 51 of file QtNodeWidget.h.

◆ hotKeySimChecked()

bool Qt::QtNodeWidget::hotKeySimChecked ( ) const
inlineoverride

Definition at line 53 of file QtNodeWidget.h.

◆ name()

QString Qt::QtNodeWidget::name ( ) const
override

Definition at line 143 of file QtNodeWidget.cpp.

Here is the call graph for this function:

◆ nodeTips()

QString Qt::QtNodeWidget::nodeTips ( ) const
override

Definition at line 149 of file QtNodeWidget.cpp.

Here is the call graph for this function:

◆ nPorts()

unsigned int Qt::QtNodeWidget::nPorts ( PortType portType) const
override

Definition at line 60 of file QtNodeWidget.cpp.

◆ outData()

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

Definition at line 128 of file QtNodeWidget.cpp.

◆ portCaption()

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

Definition at line 160 of file QtNodeWidget.cpp.

Here is the call graph for this function:

◆ portCaptionVisible()

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

Definition at line 154 of file QtNodeWidget.cpp.

◆ portInConnectionPolicy()

QtNodeDataModel::ConnectionPolicy Qt::QtNodeWidget::portInConnectionPolicy ( PortIndex portIndex) const
override

Definition at line 350 of file QtNodeWidget.cpp.

◆ portTips()

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

Definition at line 194 of file QtNodeWidget.cpp.

Here is the call graph for this function:

◆ setInData()

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

Definition at line 237 of file QtNodeWidget.cpp.

Here is the call graph for this function:

◆ tryInData()

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

To test whether nodaData can be set as the input data for portIndex.

Parameters
portIndexInput index
nodeDataInput data
Returns
true
false

Definition at line 289 of file QtNodeWidget.cpp.

Here is the call graph for this function:

◆ updateModule()

void Qt::QtNodeWidget::updateModule ( )
protectedvirtual

Definition at line 376 of file QtNodeWidget.cpp.

Here is the caller graph for this function:

◆ validationMessage()

QString Qt::QtNodeWidget::validationMessage ( ) const
override

Definition at line 371 of file QtNodeWidget.cpp.

◆ validationState()

NodeValidationState Qt::QtNodeWidget::validationState ( ) const
override

Definition at line 345 of file QtNodeWidget.cpp.

Member Data Documentation

◆ mEditingEnabled

bool Qt::QtNodeWidget::mEditingEnabled = true
private

Definition at line 117 of file QtNodeWidget.h.

◆ mFieldExport

OutFieldPtr Qt::QtNodeWidget::mFieldExport
protected

Definition at line 109 of file QtNodeWidget.h.

◆ mFieldInport

InFieldPtr Qt::QtNodeWidget::mFieldInport
protected

Definition at line 108 of file QtNodeWidget.h.

◆ mNode

std::shared_ptr<Node> Qt::QtNodeWidget::mNode = nullptr
protected

Definition at line 111 of file QtNodeWidget.h.

◆ mNodeExport

ExportNodePtr Qt::QtNodeWidget::mNodeExport
protected

Definition at line 103 of file QtNodeWidget.h.

◆ mNodeInport

ImportNodePtr Qt::QtNodeWidget::mNodeInport
protected

Definition at line 102 of file QtNodeWidget.h.

◆ modelValidationError

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

Definition at line 114 of file QtNodeWidget.h.

◆ modelValidationState

NodeValidationState Qt::QtNodeWidget::modelValidationState = NodeValidationState::Valid
protected

Definition at line 113 of file QtNodeWidget.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.13.2