ScriptingNode

Inherits from Core::Node, std::enable_shared_from_this< Node >

Public Functions

	Name
	ScriptingNode()
	ScriptingNode(std::unique_ptr< Workspace::ScriptInterface > interface, Workspace::ScriptingNode * workspaceNode)
	~ScriptingNode() override
Workspace::ScriptInterface *	getInterface() const
void	performInit()<br>Cannot be used Node::onInit function because it is called before the node is added to the workspace.
virtual void	updateValues(int inputIndex) override<br>Computes new values of outputs based on inputs.

Additional inherited members

Public Functions inherited from Core::Node

	Name
virtual void	addDeleteCallback(std::function< void(Node )> callback)<br> The callback parameters: Node = node that has been deleted
virtual void	addPlugCallback(std::function< void(Node , Node , size_t, size_t)> callback)<br>Registers a callback that gets called when the node's output pins get plugged in.
virtual void	addUnplugCallback(std::function< void(Node , Node , size_t, size_t)> callback)<br>Registers a callback that gets called when the node's input pins get unplugged.
virtual void	addUpdateCallback(std::function< void(Node *)> callback)<br>Registers a callback that gets called on any updateValues() call.
void	appendChildNode(Ptr< Node > node)
bool	areAllInputsPlugged()
bool	areAllInputsUnplugged() const
bool	areInputsPlugged(int numInputs)
template <typename T > <br>Ptr< T >	as()
const Data &	data(size_t index =0) const<br>Get Node contents, read only.
Data &	dataMut(size_t index)
void	finalize()<br>Prepares node for its destruction, after that the destructor can be called.
ID	getId() const
Pin &	getInput(size_t i)
std::vector< Pin > &	getInputPins()
Data &	getInternalData(size_t index =0)<br>Get data storage for read and write purposes.
const char *	getLabel() const
const Operation &	getOperation() const
Pin &	getOutput(size_t i)
std::vector< Pin > &	getOutputPins()
Ptr< Node >	getOwner() const<br>Get direct owner of this node.
Ptr< Node >	getPtr()<br>Get reference to this node instance.
Ptr< Node >	getRootOwner()<br>Get the topmost owner of this node.
std::string	getSignature()<br>"{node type} #{node ID}"
EValueState	getState(size_t pinIndex =0)
void	init()<br>Initialize node id, inputs, and outputs according to the preset node type.
void	notifyOwner()
virtual void	onInit()
bool	operator!=(const Node & other) const
bool	operator==(const Node & other) const
ENodePlugResult	plug(const Ptr< Node > & childNode, unsigned fromIndex, unsigned toIndex)<br>Connect this (parent) node output to the `childNode` input.
void	pulse(size_t index)
virtual void	receiveSignal(int inputIndex)<br>Implements the operator reaction to the change of its inputIndex input.
virtual SetValueResult	setValue(const glm::mat4 & mat)
virtual SetValueResult	setValue(const glm::mat4 & mat, const DataMap & map)<br>Smart set function, used with constrained transformation for value checking.
virtual SetValueResult	setValue(const glm::quat & q)
virtual SetValueResult	setValue(const glm::vec3 & vec)
virtual SetValueResult	setValue(const glm::vec4 & vec)
template <typename T > <br>SetValueResult	setValue(const T & value, unsigned index)
virtual SetValueResult	setValue(float val)<br>Set the value of the node.
virtual SetValueResult	setValue(float val, glm::ivec2 coords)
virtual SetValueResult	setValue(void * ptr)
void	spreadSignal()<br>Spread signal to all outputs.
void	spreadSignal(size_t outIndex)<br>Spread signal to the selected output outIndex only.

Protected Functions inherited from Core::Node

	Name
	Node(const Operation & operation)<br>Node is never constructed directory.
virtual	~Node()
ENodePlugResult	isPlugCorrect(const Pin & input, const Pin & output)
virtual void	onUnplugInput(size_t index)
template <typename T > <br>void	setInternalValue(const T & value, size_t index =0)<br>Sets the node value without validation.
void	setInternalValue(float value, glm::ivec2 coordinates, size_t index =0)
bool	shouldPulse(size_t inputIndex, size_t updatedInputIndex)<br>Tests if the `updatedInputIndex` should be pulsed.
void	triggerDeleteCallback(Node * node)
void	triggerPlugCallback(Node * fromNode, Node * toNode, size_t fromIndex, size_t toIndex)
void	triggerUnplugCallback(Node * fromNode, Node * toNode, size_t fromIndex, size_t toIndex)
void	triggerUpdateCallback(Node * node)

Public Attributes inherited from Core::Node

	Name
std::vector< EValueState >	m_OperatorState

Protected Attributes inherited from Core::Node

	Name
std::vector< Node * >	m_children <br>Nested nodes.
ID	m_id
std::vector< Pin >	m_inputs <br>Inputs of the box: Input tabs with glyphs.
std::vector< Data >	m_internalData <br>Results of operations.
Operation	m_operation <br>Operator node properties.
std::vector< Pin >	m_outputs <br>Outputs of the box: output tabs with glyphs.
Node *	m_owner <br>Owner of the node, used in complex type of nodes, such as sequence or camera.

Friends inherited from Core::Node

	Name
class	GraphManager
class	Pin

Public Functions Documentation

function ScriptingNode

cpp

inline ScriptingNode()

inline ScriptingNode()

function ScriptingNode

cpp

inline explicit ScriptingNode(
    std::unique_ptr< Workspace::ScriptInterface > interface,
    Workspace::ScriptingNode * workspaceNode
)

inline explicit ScriptingNode(
    std::unique_ptr< Workspace::ScriptInterface > interface,
    Workspace::ScriptingNode * workspaceNode
)

function ~ScriptingNode

cpp

inline ~ScriptingNode() override

inline ~ScriptingNode() override

function getInterface

cpp

inline Workspace::ScriptInterface * getInterface() const

inline Workspace::ScriptInterface * getInterface() const

function performInit

cpp

inline void performInit()

inline void performInit()

Cannot be used Node::onInit function because it is called before the node is added to the workspace.

function updateValues

cpp

inline virtual void updateValues(
    int inputIndex
) override

inline virtual void updateValues(
    int inputIndex
) override

Computes new values of outputs based on inputs.

Parameters:

inputIndex Index of the modified input.

Reimplements: Core::Node::updateValues

Encodes the box function by updating the output values for a given inputIndex - fired by receiveSignal().

The base class method calls update callbacks registered with addUpdateCallback(). So derived methods should also call their base method if they want to inform any outside observers.

Updated on 2025-01-07 at 13:40:43 +0000

Classes

Namespaces

ScriptingNode

Public Functions

Additional inherited members

Public Functions Documentation

function ScriptingNode

function ScriptingNode

function ~ScriptingNode

function getInterface

function performInit

function updateValues

ScriptingNode ​

Public Functions ​

Additional inherited members ​

Public Functions Documentation ​

function ScriptingNode ​

function ScriptingNode ​

function ~ScriptingNode ​

function getInterface ​

function performInit ​

function updateValues ​

ScriptingNode

Public Functions

Additional inherited members

Public Functions Documentation

function ScriptingNode

function ScriptingNode

function ~ScriptingNode

function getInterface

function performInit

function updateValues