Core::Screen

#include "Core/Nodes/Screen.h"

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

Public Functions

	Name
	Screen()
const glm::mat4 &	getProjection() const
const glm::mat4 &	getView() const
const glm::mat4 &	getViewport() const
bool	isViewportExplicit() const<br>When true, the passed viewport transformation is used, instead of an auto-generated one.
virtual void	updateValues(int inputIndex) override<br>Computes new values of outputs based on inputs.

Public Attributes

	Name
ScreenData	m_screenData <br>Storage for the data received as input.

Friends

	Name
class	GraphManager

Additional inherited members

Public Functions inherited from Core::Node

	Name
virtual void	addDeleteCallback(std::function< void(Node *)> callback)<br> The callback parameters:
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()
template <typename T > <br>T *	asRaw()
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)
TrackedNodeData *	getTrackingData()
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	onPlug(Node * fromNode, Node * toNode, size_t fromIndex, size_t toIndex)
virtual void	onUnplug(Node * fromNode, Node * toNode, size_t fromIndex, size_t toIndex)
virtual void	onUpdate()
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
bool	finalized
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.
TrackedNodeData *	m_trackingData <br>Reference to additional tracking data if applicable, nullptr indicates no active tracking operation.

Friends inherited from Core::Node

	Name
class	MatrixTracker
class	Pin

Public Functions Documentation

function Screen

cpp

Screen()

Screen()

function getProjection

cpp

const glm::mat4 & getProjection() const

const glm::mat4 & getProjection() const

function getView

cpp

const glm::mat4 & getView() const

const glm::mat4 & getView() const

function getViewport

cpp

const glm::mat4 & getViewport() const

const glm::mat4 & getViewport() const

function isViewportExplicit

cpp

bool isViewportExplicit() const

bool isViewportExplicit() const

When true, the passed viewport transformation is used, instead of an auto-generated one.

function updateValues

cpp

virtual void updateValues(
    int inputIndex
) override

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.

Public Attributes Documentation

variable m_screenData

cpp

ScreenData m_screenData;

ScreenData m_screenData;

Storage for the data received as input.

Friends

friend GraphManager

cpp

friend class GraphManager(
    GraphManager 
);

friend class GraphManager(
    GraphManager 
);

Updated on 2025-05-31 at 12:55:31 +0000

Classes

Namespaces

Core::Screen

Public Functions

Public Attributes

Friends

Additional inherited members

Public Functions Documentation

function Screen

function getProjection

function getView

function getViewport

function isViewportExplicit

function updateValues

Public Attributes Documentation

variable m_screenData

Friends

friend GraphManager

Core::Screen ​

Public Functions ​

Public Attributes ​

Friends ​

Additional inherited members ​

Public Functions Documentation ​

function Screen ​

function getProjection ​

function getView ​

function getViewport ​

function isViewportExplicit ​

function updateValues ​

Public Attributes Documentation ​

variable m_screenData ​

Friends ​

friend GraphManager ​

Core::Screen

Public Functions

Public Attributes

Friends

Additional inherited members

Public Functions Documentation

function Screen

function getProjection

function getView

function getViewport

function isViewportExplicit

function updateValues

Public Attributes Documentation

variable m_screenData

Friends

friend GraphManager