1. Epic GamesDeveloper
  3. FInterrogationChannels

FInterrogationChannels

A class specialized for interrogating Sequencer entity data without applying any state to objects.

API > API/Runtime > API/Runtime/MovieSceneTracks

A class specialized for interrogating Sequencer entity data without applying any state to objects. Currently only tracks within the same time-base are supported. Will not link systems that are in the custom "ExcludedFromInterrogation" category. Multiple different outputs can be interrogated simultaneously by Importing tracks onto separate channels allocated through AllocateChannel.

Systems may implement their own interrogation logic that can be run after updates to allow third-party interrogation behavior for specific channels or time.

Example usage: Interrogator.ImportTrack(MyTrack, FInterrogationChannel::Default());

for (int32 FrameNumber = 0; FrameNumber < 100; ++FrameNumber) Interrogator.InterrogateTime(FrameNumber);

Interrogator.Update();

UMyTrackSystem* MySystem = Interrogator.GetLinker()->FindSystem(); if (MySystem) { TArray OutData; MySystem->Interrogate(FInterogationKey::Default(), OutData); }

   
Name FInterrogationChannels
Type class
Header File /Engine/Source/Runtime/MovieSceneTracks/Public/EntitySystem/Interrogation/MovieSceneInterrogationLinker.h
Include Path #include "EntitySystem/Interrogation/MovieSceneInterrogationLinker.h"

Syntax

class FInterrogationChannels

Constructors

Name Remarks Include Path Unreal Specifiers

FInterrogationChannels()

   EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FInterrogationChannels()

   EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Called to activate the specified channel. EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

int32 AddInterrogation ( const FInterrogationParams& Params
)

 Add a new time to interrogate this linker at, in the time-base of the imported tracks. EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  
Allocate a new interrogation channel that relates to a specific object EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  
Allocate a new interrogation channel that relates to a specific object EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  
Allocate a new interrogation channel that can be used to uniquely identify groups of tracks that animate the same property or output. EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

FInterrogationChannel AllocateUnboundChannel ( FInterrogationChannel ParentChannel,
const FTransform& CurrentValueLocalSpace
)

 Allocate a new channel for a set of transform tracks that isn't bound to any particular object (but can still exist within a hierarchy) EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  
Called to deactivate the specified channel. EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

FInterrogationChannel FindChannel ( UObject* Object
)

 Find the existing interrogation channel for the specified object EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

TArrayView< const FInterrogationParams > GetInterrogations()

 Retrieve the current interrogations EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

int32 GetNumChannels()

 Retrieve the number of channels allocated EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

const FSparseInterrogationChannelInfo & GetSparseChannelInfo()

   EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

FInterrogationChannel ImportTransformHierarchy ( USceneComponent* SceneComponent
)

 Import the entire transform hierarchy for the specified component, including all attached parents and tracks relating to them. EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  
Query all local space transforms, even including channels that do not have any variable track data EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  
Query local space transforms EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  
Query local space transforms EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

void QueryLocalSpaceTransforms ( UMovieSceneEntitySystemLinker* Linker,
const TBitArray<>& ChannelsToQuery,
TSparseArray< TArray< FIntermediate3DTransform > >& OutTransformsByChannel
) const

 Query a specific set of channels for their local space transforms as defined by set bits within ChannelsToQuery EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

void QueryTransformOrigins ( UMovieSceneEntitySystemLinker* Linker,
const FMovieSceneSequenceHierarchy* Hierarchy,
TArray< FTransform >& OutTransformOrigins,
TArray< FMovieSceneSequenceID >& SubsequenceHierarchy,
const UObject* InstanceData
) const

   EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

void QueryWorldSpaceTransforms ( UMovieSceneEntitySystemLinker* Linker,
FInterrogationChannel InChannel,
TArray< FTransform >& OutTransforms
) const

 Query world space transforms for a channel EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

void QueryWorldSpaceTransforms ( UMovieSceneEntitySystemLinker* Linker,
USceneComponent* SceneComponent,
TArray< FTransform >& OutTransforms
) const

 Query world space transforms for a component EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

void QueryWorldSpaceTransforms ( UMovieSceneEntitySystemLinker* Linker,
const TBitArray<>& ChannelsToQuery,
TSparseArray< TArray< FTransform > >& OutTransformsByChannel
) const

 Query a specific set of channels for their world space transforms as defined by set bits within ChannelsToQuery EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

void QueryWorldSpaceTransforms ( UMovieSceneEntitySystemLinker* Linker,
TSparseArray< TArray< FTransform > >& OutTransformsByChannel
) const

 Query all world space transforms, even including channels that do not have any variable track data EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

void Reset()

   EntitySystem/Interrogation/MovieSceneInterrogationLinker.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page