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 > API/Runtime/MovieSceneTracks/EntitySystem > API/Runtime/MovieSceneTracks/EntitySystem/Interrogation

References

   
Module MovieSceneTracks
Header /Engine/Source/Runtime/MovieSceneTracks/Public/EntitySystem/Interrogation/MovieSceneInterrogationLinker.h
Include #include "EntitySystem/Interrogation/MovieSceneInterrogationLinker.h"

Syntax

class FInterrogationChannels

Remarks

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); }

Variables

  Type Name Description
Protected variable TBitArray ActiveChannelBits BitArray containing set bits for any channel that has data associated with it.
Protected variable TArray< FInterrogationParams > Interrogations An array of interrogation times
Protected variable TMap< FObjectKey, FInterrogationChannel > ObjectToChannel Map from an object to its interrogation channel
Protected variable FSparseInterrogationChannelInfo SparseChannelInfo Array of information pertaining to a given channel

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Called to activate the specified channel.
Public function int32 Add a new time to interrogate this linker at, in the time-base of the imported tracks.
Public function FInterrogationChannel

AllocateChannel ( UObject* Object,
FInterrogationChannel ParentChannel,
const FMovieScenePropertyBinding& PropertyBinding
)

 Allocate a new interrogation channel that relates to a specific object
Public function FInterrogationChannel

AllocateChannel ( UObject* Object,
const FMovieScenePropertyBinding& PropertyBinding
)

 Allocate a new interrogation channel that relates to a specific object
Public function FInterrogationChannel

AllocateChannel ( FInterrogationChannel ParentChannel,
const FMovieScenePropertyBinding& PropertyBinding
)

 Allocate a new interrogation channel that can be used to uniquely identify groups of tracks that animate the same property or output.
Public function 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)
Public function void Called to deactivate the specified channel.
Public function FInterrogationChannel

FindChannel ( UObject* Object
)

 Find the existing interrogation channel for the specified object
Public function Const TArrayView< const FInterrogationParams > Retrieve the current interrogations
Public function Const int32 Retrieve the number of channels allocated
Public function Const const FSparseInterrogationChannelInfo &  
Public function FInterrogationChannel Import the entire transform hierarchy for the specified component, including all attached parents and tracks relating to them.
Public function Const void Query local space transforms
Public function Const void Query all local space transforms, even including channels that do not have any variable track data
Public function Const void Query local space transforms
Public function Const void

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

 Query a specific set of channels for their local space transforms as defined by set bits within ChannelsToQuery
Public function Const void

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

 Query world space transforms for a component
Public function Const void

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

 Query a specific set of channels for their world space transforms as defined by set bits within ChannelsToQuery
Public function Const void

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

 Query world space transforms for a channel
Public function Const void

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

 Query all world space transforms, even including channels that do not have any variable track data
Public function void

Reset ()

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page