Core::Transform

#include "Core/Nodes/Transform.h"

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

Public Functions

	Name
	Transform(const TransformOperation & transformType)
void	createDefaults()<br>Prepare storage for second level parameters (std::map with values)
void	disableSynergies()
void	enableSynergies()
void	free()
float	getActivePart() const
int	getCurrentIndex() const
Ptr< Node >	getCurrentSequence()
TransformOperation::ValueMap	getDefaultTypes() const
const Data &	getDefaultValue(const std::string & name) const<br>Get the value which the transform can hold (current value stored in the transformation).
DefaultValues &	getDefaultValues()
const DefaultValues &	getSavedDefaults() const
const glm::mat4 &	getSavedValue() const
EValueState	getValueState(glm::ivec2 coords) const
bool	hasMenuSynergies() const
bool	hasSavedValue() const
bool	hasSynergies() const
virtual void	initDefaults()<br>Init the (non-zero) second level parameters (from LOD::SetValues) via their initDefaults and update the internal transformation matrix).
bool	isInSequence() const
bool	isLocked() const
virtual bool	isValid() const =0<br>Checks the validity of the stored Transform matrix (used by GUI to show the corrupted flag).
void	lock()
void	notifySequence()
void	nullSequence()
TransformOperation *	properties() const
void	reloadValue()<br>Restore saved values if they exist.
virtual void	resetMatrixFromDefaults() =0<br>Reset the transform matrix visible in LOD::Full (internalValue) to match the defaultValues (from LOD::SetValues).
void	saveValue()<br>Save current values of the transformation for future reloading.
template <typename T > <br>ValueSetResult	setDefaultValue(const std::string & name, T && val)<br>Setting of one second level parameter defining the transformation (in LOD::SetValues).
template <typename T > <br>void	setDefaultValueNoUpdate(const std::string & name, T && val)
void	setDefaultValues(const DefaultValues & values)
void	setSavedValue(const glm::mat4 & values)<br>Save the value, read from YAML.
void	setSequence(Node * s, int index)
virtual ValueSetResult	setValue(const glm::mat4 & mat) override<br>Lock non-editable values.
virtual ValueSetResult	setValue(float val, glm::ivec2 coords) override
void	unlock()

Protected Functions

	Name
bool	canSetValue(const ValueMask & mask, glm::ivec2 coords, float value)
Data &	getDefaultValueMut(const std::string & name)
virtual void	setDefaultValueWithSynergies(const std::string & name, Core::Data && val)<br>Function for setting values in the Set Defaults LOD.

Protected Attributes

	Name
DefaultValues	m_defaultValues
bool	m_hasMenuSynergies <br>True for transformations, that support synergies, such as scale, eulerAngleXYZ, ortho, frustum, and quaternion ONLY.
bool	m_hasSynergies <br>applicable for: uniform scale, eulerAngleXYZ, ortho, frustum, and quat and quaternion.
bool	m_isLocked <br>Edit of the matrix is limited to editable values - defined in Operations.h g_transforms.

Friends

	Name
class	GraphManager
class	MatrixTracker
class	Sequence
void	setActivePart(Ptr< Node > node, float value)

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)
void	finalize()<br>Prepares node for its destruction, after that the destructor can be called.
const Data &	getData(size_t index =0)<br>Get Node contents, read only.
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.
void	setOwner(Node * owner)
void	spreadSignal()<br>Spread signal to all outputs.
void	spreadSignal(size_t outIndex)<br>Spread signal to the selected output outIndex only.
virtual void	updateValues(int inputIndex =0)<br>Computes new values of outputs based on inputs.
const DataMap *	getDataMap()
const DataMap &	getDataMapRef()

Protected Functions inherited from Core::Node

	Name
	Node(const Operation * operation)<br>Node is never constructed directory.
virtual	~Node()<br>Delete node.
virtual 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.
std::list< std::function< void(Node *)> >	m_deleteCallbacks
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.
ENodePlugResult(*)(const Pin &input, const Pin &output)	m_isPlugCorrectFn <br>Used by Camera.
const 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.
std::list< std::function< void(Node , Node , size_t, size_t)> >	m_plugCallbacks
std::list< std::function< void(Node , Node , size_t, size_t)> >	m_unplugCallbacks
std::list< std::function< void(Node *)> >	m_updateCallbacks

Friends inherited from Core::Node

	Name
class	Pin

Public Functions Documentation

function Transform

cpp

explicit Transform(
    const TransformOperation & transformType
)

explicit Transform(
    const TransformOperation & transformType
)

function createDefaults

cpp

void createDefaults()

void createDefaults()

Prepare storage for second level parameters (std::map with values)

function disableSynergies

cpp

inline void disableSynergies()

inline void disableSynergies()

function enableSynergies

cpp

inline void enableSynergies()

inline void enableSynergies()

function free

cpp

inline void free()

inline void free()

function getActivePart

cpp

inline float getActivePart() const

inline float getActivePart() const

function getCurrentIndex

cpp

inline int getCurrentIndex() const

inline int getCurrentIndex() const

function getCurrentSequence

cpp

Ptr< Node > getCurrentSequence()

Ptr< Node > getCurrentSequence()

function getDefaultTypes

cpp

TransformOperation::ValueMap getDefaultTypes() const

TransformOperation::ValueMap getDefaultTypes() const

Return: A map of valueName and value pairs.

function getDefaultValue

cpp

const Data & getDefaultValue(
    const std::string & name
) const

const Data & getDefaultValue(
    const std::string & name
) const

Get the value which the transform can hold (current value stored in the transformation).

Todo: rename to getCurrentValue?

Precondition: Default value with name exists.

It is not the initial value!

function getDefaultValues

cpp

DefaultValues & getDefaultValues()

DefaultValues & getDefaultValues()

function getSavedDefaults

cpp

inline const DefaultValues & getSavedDefaults() const

inline const DefaultValues & getSavedDefaults() const

function getSavedValue

cpp

const glm::mat4 & getSavedValue() const

const glm::mat4 & getSavedValue() const

function getValueState

cpp

EValueState getValueState(
    glm::ivec2 coords
) const

EValueState getValueState(
    glm::ivec2 coords
) const

function hasMenuSynergies

cpp

inline bool hasMenuSynergies() const

inline bool hasMenuSynergies() const

function hasSavedValue

cpp

inline bool hasSavedValue() const

inline bool hasSavedValue() const

function hasSynergies

cpp

inline bool hasSynergies() const

inline bool hasSynergies() const

function initDefaults

cpp

inline virtual void initDefaults()

inline virtual void initDefaults()

Init the (non-zero) second level parameters (from LOD::SetValues) via their initDefaults and update the internal transformation matrix).

It is overriden in all transforms with their default values. This version is for nodes without the default value (now only the Free node)

It resets the matrix to identity.
this is done in free->resetMatrixFromDefaults()

function isInSequence

cpp

inline bool isInSequence() const

inline bool isInSequence() const

function isLocked

cpp

bool isLocked() const

bool isLocked() const

function isValid

cpp

virtual bool isValid() const =0

virtual bool isValid() const =0

Checks the validity of the stored Transform matrix (used by GUI to show the corrupted flag).

Return: true if the stored matrix represents a correct transform

Todo: isValid checks matrix AND parameters from the SetValues LOD (Default values)

function lock

cpp

void lock()

void lock()

function notifySequence

cpp

void notifySequence()

void notifySequence()

function nullSequence

cpp

inline void nullSequence()

inline void nullSequence()

Todo: MH these should not be public.

function properties

cpp

TransformOperation * properties() const

TransformOperation * properties() const

function reloadValue

cpp

void reloadValue()

void reloadValue()

Restore saved values if they exist.

function resetMatrixFromDefaults

cpp

virtual void resetMatrixFromDefaults() =0

virtual void resetMatrixFromDefaults() =0

Reset the transform matrix visible in LOD::Full (internalValue) to match the defaultValues (from LOD::SetValues).

Todo: For synergies, it has to be resolved. Most probably, it should leave the synergies unchanged.

for Scale When setting X value in non-uniform scale -> this switch to uniform scale (due to enable synergies)

Specialized functions are created for each Transform type. For transforms with no default values (now only Free), resets the matrix directly.

The opposite setup - from matrix to Defaults - is done in the setValue() functions. It should also lock the matrix.

function saveValue

cpp

void saveValue()

void saveValue()

Save current values of the transformation for future reloading.

function setDefaultValue

cpp

template <typename T >
inline ValueSetResult setDefaultValue(
    const std::string & name,
    T && val
)

template <typename T >
inline ValueSetResult setDefaultValue(
    const std::string & name,
    T && val
)

Setting of one second level parameter defining the transformation (in LOD::SetValues).

Parameters:

name Name of the parameter (such as Center)
val New value

Template Parameters:

T Type of the stored value val

You can find transform names, types, and their default values, in the file Core/Nodes/Operation.h. The initial values are hard-wired in initDefaults() of TransformImpl<ETransformType...> in TransformImpl.h

function setDefaultValueNoUpdate

cpp

template <typename T >
inline void setDefaultValueNoUpdate(
    const std::string & name,
    T && val
)

template <typename T >
inline void setDefaultValueNoUpdate(
    const std::string & name,
    T && val
)

function setDefaultValues

cpp

inline void setDefaultValues(
    const DefaultValues & values
)

inline void setDefaultValues(
    const DefaultValues & values
)

function setSavedValue

cpp

void setSavedValue(
    const glm::mat4 & values
)

void setSavedValue(
    const glm::mat4 & values
)

Save the value, read from YAML.

Parameters:

values matrix from YAML

function setSequence

cpp

inline void setSequence(
    Node * s,
    int index
)

inline void setSequence(
    Node * s,
    int index
)

function setValue

cpp

virtual ValueSetResult setValue(
    const glm::mat4 & mat
) override

virtual ValueSetResult setValue(
    const glm::mat4 & mat
) override

Lock non-editable values.

Reimplements: Core::Node::setValue

Reimplemented by: Core::TransformImpl< ETransformType::AxisAngle >::setValue, Core::TransformImpl< ETransformType::Quat >::setValue

And enable synergies, if exist, i.e., hasSynergies() == true

function setValue

cpp

virtual ValueSetResult setValue(
    float val,
    glm::ivec2 coords
) override

virtual ValueSetResult setValue(
    float val,
    glm::ivec2 coords
) override

Parameters:

val new value
coords in the column major order: coords.x is the column index and coords.y is the row index.

Return:

Reimplements: Core::Node::setValue

function unlock

cpp

void unlock()

void unlock()

Protected Functions Documentation

function canSetValue

cpp

bool canSetValue(
    const ValueMask & mask,
    glm::ivec2 coords,
    float value
)

bool canSetValue(
    const ValueMask & mask,
    glm::ivec2 coords,
    float value
)

function getDefaultValueMut

cpp

Data & getDefaultValueMut(
    const std::string & name
)

Data & getDefaultValueMut(
    const std::string & name
)

Precondition: Default value with name exists.

function setDefaultValueWithSynergies

cpp

inline virtual void setDefaultValueWithSynergies(
    const std::string & name,
    Core::Data && val
)

inline virtual void setDefaultValueWithSynergies(
    const std::string & name,
    Core::Data && val
)

Function for setting values in the Set Defaults LOD.

Parameters:

name changed data field
val newValue as Core::Data(newValue)!!! (as we cannot have virtual template functions)

Reimplemented by: Core::TransformImpl< ETransformType::Quat >::setDefaultValueWithSynergies, Core::TransformImpl< ETransformType::Ortho >::setDefaultValueWithSynergies, Core::TransformImpl< ETransformType::Frustum >::setDefaultValueWithSynergies

Performs default data correction based on synergies Do not use - use setDefaultValue() instead!!!

Protected Attributes Documentation

variable m_defaultValues

cpp

DefaultValues m_defaultValues;

DefaultValues m_defaultValues;

variable m_hasMenuSynergies

cpp

bool m_hasMenuSynergies = false;

bool m_hasMenuSynergies = false;

True for transformations, that support synergies, such as scale, eulerAngleXYZ, ortho, frustum, and quaternion ONLY.

Synergies variants | Transformation | hasMenuSynergies | show in Full LOD | show in SetValues | synergies force | | ------------—|---------------—|---------------—|----------------—|--------------—| | Free | no | no | no | | | Translate | no | no | no | | | AxisAngle rot | no | no | no | | | LookAt | no | no | no | | | Perspective | no | no | no | | | Ortho | yes | no | yes | | | Frustum | yes | no | yes | | | Quat | yes | no | yes | unitQuaternion | | Scale | yes | yes | yes | uniform scale | | EulerX,Y,Z | yes | yes | no | cos and sins |

variable m_hasSynergies

cpp

bool m_hasSynergies = false;

bool m_hasSynergies = false;

applicable for: uniform scale, eulerAngleXYZ, ortho, frustum, and quat and quaternion.

All other undefined (false)

variable m_isLocked

cpp

bool m_isLocked = true;

bool m_isLocked = true;

Edit of the matrix is limited to editable values - defined in Operations.h g_transforms.

Friends

friend GraphManager

cpp

friend class GraphManager(
    GraphManager 
);

friend class GraphManager(
    GraphManager 
);

friend MatrixTracker

cpp

friend class MatrixTracker(
    MatrixTracker 
);

friend class MatrixTracker(
    MatrixTracker 
);

friend Sequence

cpp

friend class Sequence(
    Sequence 
);

friend class Sequence(
    Sequence 
);

friend setActivePart

cpp

friend void setActivePart(
    Ptr< Node > node,

    float value
);

friend void setActivePart(
    Ptr< Node > node,

    float value
);

Updated on 2024-03-16 at 19:15:01 +0000

Core::Transform ​

Public Functions ​

Protected Functions ​

Protected Attributes ​

Friends ​

Additional inherited members ​

Public Functions Documentation ​

function Transform ​

function createDefaults ​

function disableSynergies ​

function enableSynergies ​

function free ​

function getActivePart ​

function getCurrentIndex ​

function getCurrentSequence ​

function getDefaultTypes ​

function getDefaultValue ​

function getDefaultValues ​

function getSavedDefaults ​

function getSavedValue ​

function getValueState ​

function hasMenuSynergies ​

function hasSavedValue ​

function hasSynergies ​

function initDefaults ​

function isInSequence ​

function isLocked ​

function isValid ​

function lock ​

function notifySequence ​

function nullSequence ​

function properties ​

function reloadValue ​

function resetMatrixFromDefaults ​

function saveValue ​

function setDefaultValue ​

function setDefaultValueNoUpdate ​

function setDefaultValues ​

function setSavedValue ​

function setSequence ​

function setValue ​

function setValue ​

function unlock ​

Protected Functions Documentation ​

function canSetValue ​

function getDefaultValueMut ​

function setDefaultValueWithSynergies ​

Protected Attributes Documentation ​

variable m_defaultValues ​

variable m_hasMenuSynergies ​

variable m_hasSynergies ​

variable m_isLocked ​

Friends ​

friend GraphManager ​

friend MatrixTracker ​

friend Sequence ​

friend setActivePart ​

Core::Transform

Public Functions

Protected Functions

Protected Attributes

Friends

Additional inherited members

Public Functions Documentation

function Transform

function createDefaults

function disableSynergies

function enableSynergies

function free

function getActivePart

function getCurrentIndex

function getCurrentSequence

function getDefaultTypes

function getDefaultValue

function getDefaultValues

function getSavedDefaults

function getSavedValue

function getValueState

function hasMenuSynergies

function hasSavedValue

function hasSynergies

function initDefaults

function isInSequence

function isLocked

function isValid

function lock

function notifySequence

function nullSequence

function properties

function reloadValue

function resetMatrixFromDefaults

function saveValue

function setDefaultValue

function setDefaultValueNoUpdate

function setDefaultValues

function setSavedValue

function setSequence

function setValue

function setValue

function unlock

Protected Functions Documentation

function canSetValue

function getDefaultValueMut

function setDefaultValueWithSynergies

Protected Attributes Documentation

variable m_defaultValues

variable m_hasMenuSynergies

variable m_hasSynergies

variable m_isLocked

Friends

friend GraphManager

friend MatrixTracker

friend Sequence

friend setActivePart