Core::MatrixTracker

The main tracking object, responsible for tracking a single chain of sequences. More...

#include "Core/Nodes/Tracking.h"

Public Classes

	Name
struct	TrackedMatrix <br>Internal helper object representing a single matrix.
struct	TrackedNode <br>Internal wrapper of core nodes for managing tracking data for each node involved in the tracking operation.
struct	TrackedTransform <br>Internal tracked node wrapper representing a "transform", a node containing matrix data.

Public Functions

	Name
	MatrixTracker() =default<br>Constructs an empty / inactive tracker.
	MatrixTracker(Ptr< Sequence > beginSequence, Ptr< Camera > beginCamera, TrackingDirection direction)
	MatrixTracker(Ptr< Sequence > beginSequence, TrackingDirection direction)
	~MatrixTracker()
Ptr< Camera >	getCamera() const<br>Returns the begin camera (if provided)
ID	getCameraID() const<br>Returns the begin camera ID (if provided)
std::string	getDebugString()
TrackingDirection	getDirection() const
unsigned	getFullMatricesCount() const
const glm::mat4 &	getInterpolatedMatrix() const<br>Result of the tracking operation, returns the complete accumulated and interpolated matrix.
const TrackedMatrix *	getInterpolatedMatrixObject() const<br>Reference to the internal interpolated matrix object.
const TrackedTransform *	getInterpolatedTransform() const<br>Reference to the internal interpolated transform object.
ID	getInterpolatedTransformID() const<br>Core ID of the currently interpolated transform.
const std::vector< UPtr< TrackedMatrix > > &	getMatrices() const<br>Returns an internal list of matrix objects. Use with care and DO NOT MODIFY.
int	getMatrixCount() const<br>Returns the number of tracked matrices / transformations. Greater or equal to transform count.
float	getProgress() const<br>Returns the current processed time parameter of the tracker. The value might change after a call to update().
Ptr< Sequence >	getSequence() const<br>Returns the begin sequence.
ID	getSequenceID() const<br>Returns the begin sequence ID.
const UPtr< TrackedNode > &	getTrackedCamera() const
const std::vector< UPtr< TrackedNode > > &	getTrackedModels() const<br>Returns an internal list of tracked model objects. Use with care and DO NOT MODIFY.
const std::vector< Ptr< TrackedTransform > > &	getTrackedSequences() const<br>Returns an internal list of tracked sequence objects. Use with care and DO NOT MODIFY.
const std::vector< Ptr< TrackedTransform > > &	getTrackedTransforms() const<br>Returns an internal list of tracked transform objects. Use with care and DO NOT MODIFY.
int	getTransformCount() const<br>Returns the number of tracked transform nodes.
bool	isTracking() const
bool	isTrackingFromLeft() const
void	requestChainUpdate()
void	requestProgressUpdate()
void	reverseDirection()
void	setProgress(float param)<br>Set the tracker's progress parameter, a value from 0 to 1.
void	update()<br>Updates the state of the tracker, reacts to any changes induced by other method calls.
void	onNodeDestroy(Node * node)<br>Alerts the tracker that a node has been destroyed.
void	onNodeGraphChange(Node * node)<br>Alerts the tracker of a structure change in the tracked nodes.
void	onNodeUpdate(Node * node)<br>Alerts the tracker that a tracked node has been updated.

Protected Functions

	Name
void	clearModels()
void	clearTrackingData()
void	reset()<br>Reset the matrix tracker to empty / inactive state.
void	reverseChain()<br>Reverses the order of tracked transforms and sequences.
void	updateChain()<br>Traverses the graph from the begin sequence, updating the sequence/matrix chain.
void	updateModels()<br>Updates the tracked model list by traversing the subtree rooted in the begin sequence to find connected models.
void	updateModelTransforms()<br>Updates tracked model transforms based on the current tracking state.
void	updateProgress()<br>Updates the interpolated matrix and progress values.

Public Attributes

	Name
float	g_trackingViewportScalingFactorXY
float	g_trackingViewportScalingFactorZ
bool	m_decomposePerspectiveBrown
bool	m_decomposePerspectiveShirley
bool	m_decomposeProjection
glm::mat4	m_iProjMatrix <br>Interpolated projection matrix, relevant during camera tracking when m_trackInWorldSpace is false.
glm::mat4	m_iViewMatrix <br>Interpolated view matrix, relevant during camera tracking when m_trackInWorldSpace is false.
glm::mat4	m_iViewportMatrix <br>Interpolated viewport matrix, relevant during camera tracking when m_trackInWorldSpace is false.
bool	m_trackInWorldSpace

Friends

	Name
struct	TrackedNodeData

Detailed Description

cpp

class Core::MatrixTracker;

The main tracking object, responsible for tracking a single chain of sequences.

This object assignes and manages TrackedNodeData objects accessible via Core::Node::getTrackingData(). Tracking data is assigned to all transformations, sequences, models and possibly cameras involved in the tracking operation. Tracking data of models contains an additional TrackedModelData object containg the interpolated matrix data. A null pointer indicates that no tracking operation is active.

The MatrixTracker does not rebuild the sequence chain every frame, but reacts to value updates in any nodes that have tracking data assigned (so transformations, sequences and possibly their external operators). This behavior is implemented directly in Core::Node.

Tracking operation consists of the "chain" and "model subtree". The chain is a set of sequences as well as their transforms (transformations or operators) from the root of the scene graph to the begin sequence. The begin sequence marks the end of this chain. The subtree rooted in the begin sequence, referred to as "model subtree", is NOT tracked, as that would require the tracking "cursor" to split into multiple cursors. Instead this subtree is traversed to find all models, which are then tracked as if they were connected directly to the begin sequence.

The nodes in the model subtree are considered part of the tracking operation and do carry tracking data with a flag marking them as model subtree nodes.

All involved nodes notify the tracker of any value or structure changes, which causes the entire chain and/or subtree to be rebuilt.

Public Functions Documentation

function MatrixTracker

cpp

MatrixTracker() =default

Constructs an empty / inactive tracker.

function MatrixTracker

cpp

MatrixTracker(
    Ptr< Sequence > beginSequence,
    Ptr< Camera > beginCamera,
    TrackingDirection direction
)

function MatrixTracker

cpp

MatrixTracker(
    Ptr< Sequence > beginSequence,
    TrackingDirection direction
)

function ~MatrixTracker

cpp

~MatrixTracker()

function getCamera

cpp

Ptr< Camera > getCamera() const

Returns the begin camera (if provided)

function getCameraID

cpp

ID getCameraID() const

Returns the begin camera ID (if provided)

function getDebugString

cpp

std::string getDebugString()

function getDirection

cpp

TrackingDirection getDirection() const

function getFullMatricesCount

cpp

inline unsigned getFullMatricesCount() const

function getInterpolatedMatrix

cpp

inline const glm::mat4 & getInterpolatedMatrix() const

Result of the tracking operation, returns the complete accumulated and interpolated matrix.

function getInterpolatedMatrixObject

cpp

inline const TrackedMatrix * getInterpolatedMatrixObject() const

Reference to the internal interpolated matrix object.

function getInterpolatedTransform

cpp

inline const TrackedTransform * getInterpolatedTransform() const

Reference to the internal interpolated transform object.

function getInterpolatedTransformID

cpp

inline ID getInterpolatedTransformID() const

Core ID of the currently interpolated transform.

function getMatrices

cpp

const std::vector< UPtr< TrackedMatrix > > & getMatrices() const

Returns an internal list of matrix objects. Use with care and DO NOT MODIFY.

function getMatrixCount

cpp

int getMatrixCount() const

Returns the number of tracked matrices / transformations. Greater or equal to transform count.

function getProgress

cpp

inline float getProgress() const

Returns the current processed time parameter of the tracker. The value might change after a call to update().

function getSequence

cpp

Ptr< Sequence > getSequence() const

Returns the begin sequence.

function getSequenceID

cpp

ID getSequenceID() const

Returns the begin sequence ID.

function getTrackedCamera

cpp

const UPtr< TrackedNode > & getTrackedCamera() const

function getTrackedModels

cpp

const std::vector< UPtr< TrackedNode > > & getTrackedModels() const

Returns an internal list of tracked model objects. Use with care and DO NOT MODIFY.

function getTrackedSequences

cpp

const std::vector< Ptr< TrackedTransform > > & getTrackedSequences() const

Returns an internal list of tracked sequence objects. Use with care and DO NOT MODIFY.

function getTrackedTransforms

cpp

const std::vector< Ptr< TrackedTransform > > & getTrackedTransforms() const

Returns an internal list of tracked transform objects. Use with care and DO NOT MODIFY.

function getTransformCount

cpp

int getTransformCount() const

Returns the number of tracked transform nodes.

function isTracking

cpp

bool isTracking() const

function isTrackingFromLeft

cpp

bool isTrackingFromLeft() const

function requestChainUpdate

cpp

void requestChainUpdate()

function requestProgressUpdate

cpp

void requestProgressUpdate()

function reverseDirection

cpp

void reverseDirection()

function setProgress

cpp

void setProgress(
    float param
)

Set the tracker's progress parameter, a value from 0 to 1.

The change will only take effect after the next MatrixTracker::update() call. Meaning subsequent getProgress() calls will return the old value until update.

function update

cpp

void update()

Updates the state of the tracker, reacts to any changes induced by other method calls.

This method is meant to be run frequently and does lazy evaluation based on internal flags.

function onNodeDestroy

cpp

static void onNodeDestroy(
    Node * node
)

Alerts the tracker that a node has been destroyed.

Note: MatrixTracker::update() must be called for changes to take effect.

Called in Core::Node::finalize().

function onNodeGraphChange

cpp

static void onNodeGraphChange(
    Node * node
)

Alerts the tracker of a structure change in the tracked nodes.

Note: MatrixTracker::update() must be called for changes to take effect.

Called in Core::Node::onPlug().

function onNodeUpdate

cpp

static void onNodeUpdate(
    Node * node
)

Alerts the tracker that a tracked node has been updated.

Note: MatrixTracker::update() must be called for changes to take effect.

Called in Core::Node::onUpdate().

Protected Functions Documentation

function clearModels

cpp

void clearModels()

function clearTrackingData

cpp

void clearTrackingData()

function reset

cpp

void reset()

Reset the matrix tracker to empty / inactive state.

function reverseChain

cpp

void reverseChain()

Reverses the order of tracked transforms and sequences.

function updateChain

cpp

void updateChain()

Traverses the graph from the begin sequence, updating the sequence/matrix chain.

Note: Should be called when the matrices along the chain change, be it due to change of structure or any value.

Regenerates tracking data for all nodes.

Transform, sequence and relevant child indicies are set. Matrix indices are set later in updateProgress(). The chain and isInCamera flags are set too, as well as the node space type.

function updateModels

cpp

void updateModels()

Updates the tracked model list by traversing the subtree rooted in the begin sequence to find connected models.

Note: Should be called if the structure of the begin sequence (model) subtree changes.

function updateModelTransforms

cpp

void updateModelTransforms()

Updates tracked model transforms based on the current tracking state.

Note: Should be called if any matrix along the chain and model subtree change.

Reference space of models is derived from model and begin sequence data (no traversal is needed)

function updateProgress

cpp

void updateProgress()

Updates the interpolated matrix and progress values.

Note: Should be called on chain update and when the tracking time parameter changes.

Traverses the current chain, accumulating matrices and updating tracking data.

Public Attributes Documentation

variable g_trackingViewportScalingFactorXY

cpp

static float g_trackingViewportScalingFactorXY = 50.f;

variable g_trackingViewportScalingFactorZ

cpp

static float g_trackingViewportScalingFactorZ = 50.f;

variable m_decomposePerspectiveBrown

cpp

bool m_decomposePerspectiveBrown {false};

variable m_decomposePerspectiveShirley

cpp

bool m_decomposePerspectiveShirley {true};

variable m_decomposeProjection

cpp

bool m_decomposeProjection {true};

variable m_iProjMatrix

cpp

glm::mat4 m_iProjMatrix {1.0f};

Interpolated projection matrix, relevant during camera tracking when m_trackInWorldSpace is false.

variable m_iViewMatrix

cpp

glm::mat4 m_iViewMatrix {1.0f};

Interpolated view matrix, relevant during camera tracking when m_trackInWorldSpace is false.

variable m_iViewportMatrix

cpp

glm::mat4 m_iViewportMatrix {1.0f};

Interpolated viewport matrix, relevant during camera tracking when m_trackInWorldSpace is false.

variable m_trackInWorldSpace

cpp

bool m_trackInWorldSpace {false};

Friends

friend TrackedNodeData

cpp

friend struct TrackedNodeData(
    TrackedNodeData 
);

Updated on 2026-09-11 at 21:24:26 +0000

Core::MatrixTracker ​

Public Classes ​

Public Functions ​

Protected Functions ​

Public Attributes ​

Friends ​

Detailed Description ​

Public Functions Documentation ​

function MatrixTracker ​

function MatrixTracker ​

function MatrixTracker ​

function ~MatrixTracker ​

function getCamera ​

function getCameraID ​

function getDebugString ​

function getDirection ​

function getFullMatricesCount ​

function getInterpolatedMatrix ​

function getInterpolatedMatrixObject ​

function getInterpolatedTransform ​

function getInterpolatedTransformID ​

function getMatrices ​

function getMatrixCount ​

function getProgress ​

function getSequence ​

function getSequenceID ​

function getTrackedCamera ​

function getTrackedModels ​

function getTrackedSequences ​

function getTrackedTransforms ​

function getTransformCount ​

function isTracking ​

function isTrackingFromLeft ​

function requestChainUpdate ​

function requestProgressUpdate ​

function reverseDirection ​

function setProgress ​

function update ​

function onNodeDestroy ​

function onNodeGraphChange ​

function onNodeUpdate ​

Protected Functions Documentation ​

function clearModels ​

function clearTrackingData ​

function reset ​

function reverseChain ​

function updateChain ​

function updateModels ​

function updateModelTransforms ​

function updateProgress ​

Public Attributes Documentation ​

variable g_trackingViewportScalingFactorXY ​

variable g_trackingViewportScalingFactorZ ​

variable m_decomposePerspectiveBrown ​

variable m_decomposePerspectiveShirley ​

variable m_decomposeProjection ​

variable m_iProjMatrix ​

variable m_iViewMatrix ​

variable m_iViewportMatrix ​

variable m_trackInWorldSpace ​

Friends ​

friend TrackedNodeData ​

Core::MatrixTracker

Public Classes

Public Functions

Protected Functions

Public Attributes

Friends

Detailed Description

Public Functions Documentation

function MatrixTracker

function MatrixTracker

function MatrixTracker

function ~MatrixTracker

function getCamera

function getCameraID

function getDebugString

function getDirection

function getFullMatricesCount

function getInterpolatedMatrix

function getInterpolatedMatrixObject

function getInterpolatedTransform

function getInterpolatedTransformID

function getMatrices

function getMatrixCount

function getProgress

function getSequence

function getSequenceID

function getTrackedCamera

function getTrackedModels

function getTrackedSequences

function getTrackedTransforms

function getTransformCount

function isTracking

function isTrackingFromLeft

function requestChainUpdate

function requestProgressUpdate

function reverseDirection

function setProgress

function update

function onNodeDestroy

function onNodeGraphChange

function onNodeUpdate

Protected Functions Documentation

function clearModels

function clearTrackingData

function reset

function reverseChain

function updateChain

function updateModels

function updateModelTransforms

function updateProgress

Public Attributes Documentation

variable g_trackingViewportScalingFactorXY

variable g_trackingViewportScalingFactorZ

variable m_decomposePerspectiveBrown

variable m_decomposePerspectiveShirley

variable m_decomposeProjection

variable m_iProjMatrix

variable m_iViewMatrix

variable m_iViewportMatrix

variable m_trackInWorldSpace

Friends

friend TrackedNodeData