You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
43fa62fcd8
This represents UE4/Main @ 16445039 and Dev-PerfTest @ 16444526 [CL 16488106 by aurel cordonnier in ue5-main branch]
92 lines
3.2 KiB
C++
92 lines
3.2 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "EntitySystem/MovieSceneEntitySystem.h"
|
|
#include "EntitySystem/MovieSceneBlenderSystemTypes.h"
|
|
#include "Math/NumericLimits.h"
|
|
#include "Templates/SubclassOf.h"
|
|
|
|
#include "MovieSceneBlenderSystem.generated.h"
|
|
|
|
/**
|
|
* Base class for all systems that blend data from multiple entities/components into a single entity
|
|
*
|
|
* This system has direct coupling to TCompositePropertySystemManager and forms the basis for built-in
|
|
* blend modes in Sequencer (Absolute, Relative and Additive). Blend 'channels' are allocated in this
|
|
* system which define a many to one relationship by corresponding blend input(many)/output(one) components
|
|
* added to the relevant entities. Blend input and output channel components are uint16.
|
|
*
|
|
* The class supports a maximum of 65535 blend channels.
|
|
*
|
|
* Additionally, blender systems tag their inputs using the built in Absolute, Relative and Additive tags
|
|
* for efficient computation of each type of blending (this allows each blend type to be computed without branching).
|
|
*
|
|
* A simple example of 3 blended floats is as follows:
|
|
* Entity Data:
|
|
* Inputs:
|
|
* float [float component], uint16 [blend channel input], [Absolute Tag] => [ { 100.f, 0 }, { 200.f, 1 } ]
|
|
* float [float component], uint16 [blend channel input], [Additive Tag] => [ { 50.f, 1} ]
|
|
* Outputs:
|
|
* float [float component], uint16 [blend channel output] => [ { 0.f, 0}, { 0.f, 1} ]
|
|
* To perform blending for this data, accumulation buffers are allocated per-blend-type, and each blend accumulates
|
|
* into the index of its blend channel input component. A final combination pass walks over blend channel outputs
|
|
* a writes the results into the result component from the accumulation buffer.
|
|
*/
|
|
UCLASS(Abstract)
|
|
class MOVIESCENE_API UMovieSceneBlenderSystem : public UMovieSceneEntitySystem
|
|
{
|
|
public:
|
|
|
|
GENERATED_BODY()
|
|
|
|
/**
|
|
* Get a blender system class, given a blender system ID.
|
|
*/
|
|
static TSubclassOf<UMovieSceneBlenderSystem> GetBlenderSystemClass(FMovieSceneBlenderSystemID InSystemID);
|
|
|
|
/**
|
|
* Get the unique ID for a given blender system type.
|
|
*/
|
|
template<typename BlenderSystemClass>
|
|
static FMovieSceneBlenderSystemID GetBlenderSystemID()
|
|
{
|
|
UMovieSceneBlenderSystem* DefaultObject = BlenderSystemClass::StaticClass()->template GetDefaultObject<UMovieSceneBlenderSystem>();
|
|
check(DefaultObject);
|
|
return DefaultObject->SystemID;
|
|
}
|
|
|
|
/**
|
|
* Get the unique ID for this blender system's underlying type.
|
|
*/
|
|
FMovieSceneBlenderSystemID GetBlenderSystemID() const;
|
|
|
|
/**
|
|
* Allocate a new blend channel.
|
|
* @note Must be released when it is no longer needed in order to prevent leaking channels.
|
|
*/
|
|
FMovieSceneBlendChannelID AllocateBlendChannel();
|
|
|
|
/**
|
|
* Release a previously allocated blend channel.
|
|
*/
|
|
void ReleaseBlendChannel(FMovieSceneBlendChannelID BlendChannelID);
|
|
|
|
|
|
protected:
|
|
|
|
UMovieSceneBlenderSystem(const FObjectInitializer& ObjInit);
|
|
|
|
virtual bool IsRelevantImpl(UMovieSceneEntitySystemLinker* InLinker) const override;
|
|
|
|
void CompactBlendChannels();
|
|
|
|
/** Bit array specifying currently allocated blend channels */
|
|
TBitArray<> AllocatedBlendChannels;
|
|
|
|
private:
|
|
|
|
/** Cached blender system ID */
|
|
FMovieSceneBlenderSystemID SystemID;
|
|
};
|