IMovieSceneKeyProxy Class Reference

#include <MovieSceneKeyProxy.h>

Public Member Functions
virtual void	UpdateValuesFromRawData ()=0

Protected Member Functions
template<typename ChannelType , typename ValueType >
void	OnProxyValueChanged (TMovieSceneChannelHandle< ChannelType > InChannelHandle, UMovieSceneSignedObject *InSignedObject, FKeyHandle InKeyHandle, ValueType &InOutValue, FFrameNumber &InOutTime)
template<typename ChannelType , typename ValueType >
void	RefreshCurrentValue (TMovieSceneChannelHandle< ChannelType > InChannelHandle, FKeyHandle InKeyHandle, ValueType &OutValue, FFrameNumber &OutTime)

Detailed Description

Interface that can be implemented by any object that is used as a key editing proxy for a moviescene channel. When used, UpdateValuesFromRawData should be called every frame to optionally retrieve the current values of the key for this proxy.

Member Function Documentation

OnProxyValueChanged()

template<typename ChannelType , typename ValueType >

void IMovieSceneKeyProxy::OnProxyValueChanged ( TMovieSceneChannelHandle< ChannelType >  InChannelHandle, UMovieSceneSignedObject *  InSignedObject, FKeyHandle  InKeyHandle, ValueType &  InOutValue, FFrameNumber &  InOutTime  )

protected

Implementation function that sets the underlying key time/value to the specified values if possible. If the section is locked, InOutValue and InOutTime will be reset back to the current key's value

Parameters

InChannelHandle	The channel on which the underlying key value resides
InSection	The section that owns the channel
InKeyHandle	A handle to the key that we are reflecting
InOutValue	Value to assign to the underlying key. If the section is locked, this will receive the existing key's value without changing the underlying key value.
InOutTime	Time to move the underlying key to. If the section is locked, this will receive the existing key's time without changing the underlying time.

RefreshCurrentValue()

template<typename ChannelType , typename ValueType >

void IMovieSceneKeyProxy::RefreshCurrentValue ( TMovieSceneChannelHandle< ChannelType >  InChannelHandle, FKeyHandle  InKeyHandle, ValueType &  OutValue, FFrameNumber &  OutTime  )

protected

Implementation function that retrieves the underlying key time/value and applies then to the specified value and time parameters. Normally called once per tick.

Parameters

InChannelHandle	The channel on which the underlying key value resides
InKeyHandle	A handle to the key that we are reflecting
OutValue	(Out) Value to receive the underlying key's value
OutTime	(Out) Time to receive the underlying key time

UpdateValuesFromRawData()

virtual void IMovieSceneKeyProxy::UpdateValuesFromRawData ( )

pure virtual

To be called by the edit interface to update this instance's properties with the underlying raw data

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/MovieScene/Public/MovieSceneKeyProxy.h