1. Epic GamesDeveloper
  3. UAvaPlayableGroup

UAvaPlayableGroup

This class defines the interface and base of a playable group.

API > API/Plugins > API/Plugins/AvalancheMedia > API/Plugins/AvalancheMedia/Playable

Inheritance Hierarchy

References

   
Module AvalancheMedia
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheMedia/Public/Playable/AvaPlayableGroup.h
Include #include "Playable/AvaPlayableGroup.h"

Syntax

UCLASS ()  
class UAvaPlayableGroup : public UObject

Remarks

This class defines the interface and base of a playable group.

A playable group is intended to group playables according to the underlying rendering implementation. In most cases, it corresponds to a game instance, either owned or not, local to the process or remote.

It tracks and manage the playables state, transitions and visibility constraints.

The design goal of this class is to allow hooking the playable framework to any game instance, including PIE so it can work with any work flow (editor, PIE, game, nDisplay, etc).

Ideally, the playable class itself should be "game instance" agnostic and do all it's bidding on it's container through this class.

Variables

  Type Name Description
Protected variable bool bIsTickingTransitions If transitions are added or removed while ticking, we need to protect transition iterator.
Protected variable FName ChannelName Broadcast channel name this playable group is part of.
Protected variable TArray< int32 > DisplayDelegateIndices UViewportStatsSubsystem display delegate indices.
Protected variable UProperty Transient TObjectPtr< UGameInstance > GameInstance  
Protected variable TWeakObjectPtr< UAvaPlayable > LastAppliedCameraPlayableWeak Last playable that applied a camera.
Protected variable TWeakObjectPtr< UWorld > LastWorldBoundToDisplayDelegates Since the UViewportStatsSubsystem delegation mechanism does not allow us to verify if it is bound to this world or another one.
Protected variable UProperty Transient TObjectPtr< UTextureRenderTarget2D > ManagedRenderTarget Managed Render Target for this playable group.
Protected variable TWeakObjectPtr< UAvaPlayableGroupManager > ParentPlayableGroupManagerWeak PlayableGroup Manager handling this playable group.
Protected variable TSet< TObjectKey< UAvaPlayable > > Playables List of playables for this group.
Protected variable TSet< TObjectKey< UAvaPlayableTransition > > PlayableTransitions Set of registered playable transitions for this group. Remark: used for ticking.
Protected variable TSet< TObjectKey< UAvaPlayableTransition > > PlayableTransitionsToAdd Set of transitions to add accumulated during transition ticking.
Protected variable TSet< TObjectKey< UAvaPlayableTransition > > PlayableTransitionsToRemove Set of transitions to remove accumulated during transition ticking.
Protected variable TArray< TWeakInterfacePtr< IAvaPlayableVisibilityConstraint > > VisibilityConstraints  
Protected variable TArray< FVisibilityRequest > VisibilityRequests  

Functions

  Type Name Description
Public function Virtual bool

ConditionalBeginPlay ( const FAvaInstancePlaySettings& InWorldPlaySettings
)

 Begin playing the game instance's world if it wasn't already.
Public function Virtual bool Creates the game instance's world if it wasn't already.
Protected function void  
Public function Virtual bool

ConditionalRequestUnloadWorld ( bool bForceImmediate
)

 Unloads the game instance's world if no more playables are loaded.
Protected function bool

DisplayLoadedAssets ( FText& OutText,
FLinearColor& OutColor
)

  
Protected function bool

DisplayPlayingAssets ( FText& OutText,
FLinearColor& OutColor
)

  
Protected function bool

DisplayTransitions ( FText& OutText,
FLinearColor& OutColor
)

  
Public function Static UAvaPlayableGroup *

FindPlayableGroupForWorld ( const UWorld* InWorld,
bool bInFallbackToGlobalSearch
)

 Search for the first playable group associated to the given world.
Public function Const void

FindPlayablesBySourceAssetPath ( const FSoftObjectPath& InSourceAssetPath,
TArray< UAvaPlayable* >& OutFoundPlayables
)

 Finds all the playables that are instances of the given source asset.
Public function void

ForEachPlayable ( TFunctionRef< bool(UAvaPlayable*)> InFunction
)

  
Public function void  
Public function Const FName Returns the broadcast channel name this playable group is part of.
Public function Const UGameInstance * Returns this group's game instance, if it has one.
Public function Virtual Const UTextureRenderTarget2D * Returns the currently managed render target.
Public function Const UAvaPlayableGroupManager *  
Public function Virtual Const UWorld * Returns this group's play world, if it has one.
Public function Virtual Const UTextureRenderTarget2D * Current logic for the render target: use the game instance's if present, fallback to internal one if not.
Public function Const bool Returns true if there are any valid registered playables.
Public function Const bool Returns true if there are any valid registered playables that are currently playing.
Public function Const bool  
Protected function Const void

HidePawnsForView ( const UWorld* InPlayWorld,
FSceneView& InView
)

  
Public function Virtual Const bool  
Public function Const bool

IsSynchronizedEventPushed ( const FString& InEventSignature
)

  
Protected function Const bool

IsVisibilityConstrained ( const UAvaPlayable* InPlayable
)

  
Public function Virtual Const bool  
Public function Static UAvaPlayableGroup *

MakePlayableGroup ( UObject* InOuter,
const FPlayableGroupCreationInfo& InPlayableGroupInfo
)

  
Public function void

NotifyLevelStreaming ( UAvaPlayable* InPlayable
)

 Notify the playable group that a playable is loading an asset.
Protected function void

OnPlayableStatusChanged ( UAvaPlayable* InPlayable
)

  
Public function void

PushSynchronizedEvent ( FString&& InEventSignature,
TUniqueFunction< void()> InFunction
)

  
Public function void

RegisterPlayable ( UAvaPlayable* InPlayable
)

 Register a playable to this group when it is created.
Public function void  
Public function void  
Public function Virtual void

RequestEndPlayWorld ( bool bInForceImmediate
)

  
Public function void

RequestSetVisibility ( UAvaPlayable* InPlayable,
bool bInShouldBeVisible
)

  
Public function void

SetLastAppliedCameraPlayable ( UAvaPlayable* InPlayable
)

 Keep track of the last playable that applied it's camera in the viewport/controller.
Public function Virtual void The playback graph determines if this playable group will render in a broadcast channel's render target or an offscreen one.
Public function Virtual void

SetupView ( FSceneViewFamily& InViewFamily,
FSceneView& InView
)

  
Public function void

TickTransitions ( double InDeltaSeconds
)

 Tick transitions that have been registered. Returns the number of transitions that where ticked.
Public function void

UnregisterPlayable ( UAvaPlayable* InPlayable
)

 Unregister a playable when it is about to be deleted.
Public function void  
Public function void  
Protected function void  

Classes

  Type Name Description
Public struct FPlayableGroupCreationInfo PlayableGroup creation information contains the necessary information to create an instance of a playable group.  
Protected struct FVisibilityRequest    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page