Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactoring the MovieSystem so that it may be moved into a gem #18541

Merged
merged 8 commits into from
Dec 10, 2024
Merged

Refactoring the MovieSystem so that it may be moved into a gem #18541

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3582e90
Removed unnecessary include of IMovieSystem in LyShine
l-sempe Dec 8, 2024
b5b66c7
First pass at removing the MovieSystem global
l-sempe Dec 8, 2024
6b0ca30
Removed GetMovieSystem from IEditor
lsemp3d Dec 8, 2024
097adfb
Removed commented out code
lsemp3d Dec 8, 2024
b141d3c
Applied feedback from PR
lsemp3d Dec 8, 2024
4ce596e
Changed EBus into AZ::Interface
l-sempe Dec 10, 2024
85995fc
Updated assert
l-sempe Dec 10, 2024
6a2bad4
Updated style
l-sempe Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Removed GetMovieSystem from IEditor 
Signed-off-by: Luis Sempé <[email protected]>
  • Loading branch information
@lsemp3d
lsemp3d committed Dec 8, 2024
commit 6b0ca302ae8c24c35cd6ff210f29a18ba23d1e62
9 changes: 8 additions & 1 deletion Code/Editor/CryEditDoc.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
#include "MainWindow.h"
#include "LevelFileDialog.h"
#include "Undo/Undo.h"
#include "Maestro/Bus/MovieSystemBus.h"

#include <Atom/RPI.Public/ViewportContext.h>
#include <Atom/RPI.Public/ViewportContextBus.h>
Expand Down Expand Up @@ -278,7 +279,13 @@ void CCryEditDoc::Load(TDocMultiArchive& /* arrXmlAr */, const QString& szFilena
}

GetIEditor()->Notify(eNotify_OnBeginSceneOpen);
GetIEditor()->GetMovieSystem()->RemoveAllSequences();

IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);
if (movieSystem)
{
movieSystem->RemoveAllSequences();
}

{
// Start recording errors
Expand Down
1 change: 0 additions & 1 deletion Code/Editor/IEditor.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,6 @@ struct IEditor
virtual Editor::EditorQtApplication* GetEditorQtApplication() = 0;
virtual const QColor& GetColorByName(const QString& name) = 0;

virtual struct IMovieSystem* GetMovieSystem() = 0;
virtual class CPluginManager* GetPluginManager() = 0;
virtual class CViewManager* GetViewManager() = 0;
virtual class CViewport* GetActiveView() = 0;
Expand Down
9 changes: 0 additions & 9 deletions Code/Editor/IEditorImpl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,15 +142,6 @@ class CEditorImpl
const QColor& GetColorByName(const QString& name) override;

//////////////////////////////////////////////////////////////////////////
/*IMovieSystem* GetMovieSystem() override
{
if (m_pSystem)
{
return m_pSystem->GetIMovieSystem();
}
return nullptr;
};*/

CPluginManager* GetPluginManager() override { return m_pPluginManager; }
CViewManager* GetViewManager() override;
CViewport* GetActiveView() override;
Expand Down
11 changes: 7 additions & 4 deletions Code/Editor/SelectLightAnimationDialog.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

// CryCommon
#include <CryCommon/Maestro/Types/AnimNodeType.h> // for AnimNodeType
#include <CryCommon/Maestro/Bus/MovieSystemBus.h>

//////////////////////////////////////////////////////////////////////////
CSelectLightAnimationDialog::CSelectLightAnimationDialog(QWidget* pParent)
Expand All @@ -34,12 +35,14 @@ void CSelectLightAnimationDialog::OnInitDialog()
//////////////////////////////////////////////////////////////////////////
void CSelectLightAnimationDialog::GetItems(std::vector<SItem>& outItems)
{
IMovieSystem* pMovieSystem = GetIEditor()->GetMovieSystem();
if (pMovieSystem)
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

if (movieSystem)
{
for (int i = 0; i < pMovieSystem->GetNumSequences(); ++i)
for (int i = 0; i < movieSystem->GetNumSequences(); ++i)
{
IAnimSequence* pSequence = pMovieSystem->GetSequence(i);
IAnimSequence* pSequence = movieSystem->GetSequence(i);
if ((pSequence->GetFlags() & IAnimSequence::eSeqFlags_LightAnimationSet) == 0)
{
continue;
Expand Down
11 changes: 7 additions & 4 deletions Code/Editor/SelectSequenceDialog.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
#include "EditorDefs.h"

#include "SelectSequenceDialog.h"
#include <Maestro/Bus/MovieSystemBus.h>

// CSelectSequence dialog

Expand All @@ -32,12 +33,14 @@ CSelectSequenceDialog::OnInitDialog()
/* virtual */ void
CSelectSequenceDialog::GetItems(std::vector<SItem>& outItems)
{
IMovieSystem* pMovieSys = GetIEditor()->GetMovieSystem();
if (pMovieSys)
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

if (movieSystem)
{
for (int i = 0; i < pMovieSys->GetNumSequences(); ++i)
for (int i = 0; i < movieSystem->GetNumSequences(); ++i)
{
IAnimSequence* pSeq = pMovieSys->GetSequence(i);
IAnimSequence* pSeq = movieSystem->GetSequence(i);
SItem item;
AZStd::string fullname = pSeq->GetName();
item.name = fullname.c_str();
Expand Down
123 changes: 93 additions & 30 deletions Code/Editor/TrackView/SequenceBatchRenderDialog.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@

// CryCommon
#include <CryCommon/Maestro/Types/AnimNodeType.h>
#include <CryCommon/Maestro/Bus/MovieSystemBus.h>

// Editor
#include "MainWindow.h"
Expand Down Expand Up @@ -189,11 +190,14 @@ void CSequenceBatchRenderDialog::OnInitDialog()

// Fill the sequence combo box.
bool activeSequenceWasSet = false;
if (GetIEditor()->GetMovieSystem())
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

if (movieSystem)
{
for (int k = 0; k < GetIEditor()->GetMovieSystem()->GetNumSequences(); ++k)
for (int k = 0; k < movieSystem->GetNumSequences(); ++k)
{
IAnimSequence* pSequence = GetIEditor()->GetMovieSystem()->GetSequence(k);
IAnimSequence* pSequence = movieSystem->GetSequence(k);
m_ui->m_sequenceCombo->addItem(pSequence->GetName());
if (pSequence->IsActivated())
{
Expand Down Expand Up @@ -537,9 +541,13 @@ void CSequenceBatchRenderDialog::OnGo()
m_ui->m_pGoBtn->setText("Cancel");
m_ui->m_pGoBtn->setIcon(QPixmap(":/Trackview/clapperboard_cancel.png"));
// Inform the movie system that it soon will be in a batch-rendering mode.
if (GetIEditor()->GetMovieSystem())

IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

if (movieSystem)
{
GetIEditor()->GetMovieSystem()->EnableBatchRenderMode(true);
movieSystem->EnableBatchRenderMode(true);
}

// Initialize the context.
Expand Down Expand Up @@ -598,7 +606,10 @@ void CSequenceBatchRenderDialog::OnSequenceSelected()
{
// Get the selected sequence.
const QString seqName = m_ui->m_sequenceCombo->currentText();
IAnimSequence* pSequence = GetIEditor()->GetMovieSystem() ? GetIEditor()->GetMovieSystem()->FindLegacySequenceByName(seqName.toUtf8().data()) : nullptr;
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

IAnimSequence* pSequence = movieSystem ? movieSystem->FindLegacySequenceByName(seqName.toUtf8().data()) : nullptr;
if (pSequence)
{
// Adjust the frame range.
Expand Down Expand Up @@ -1003,7 +1014,12 @@ void CSequenceBatchRenderDialog::CaptureItemStart()
*TrackView::SceneFromGameEntityContext(), "TrackViewSequencePipeline", renderItem.resW, renderItem.resH);
UpdateAtomOutputFrameCaptureView(m_atomOutputFrameCapture, renderItem.resW, renderItem.resH);

GetIEditor()->GetMovieSystem()->EnableFixedStepForCapture(m_renderContext.captureOptions.timeStep);
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);
if (movieSystem)
{
movieSystem->EnableFixedStepForCapture(m_renderContext.captureOptions.timeStep);
}

// The capturing doesn't actually start here. It just flags the warming-up and
// once it's done, then the capturing really begins.
Expand Down Expand Up @@ -1038,7 +1054,12 @@ void CSequenceBatchRenderDialog::OnUpdateEnteringGameMode()
// Pause the movie player on the first frame
if (m_renderContext.framesSpentInCurrentPhase++ == 0)
{
GetIEditor()->GetMovieSystem()->Pause();
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);
if (movieSystem)
{
movieSystem->Pause();
}
}
// Spend 30 frames warming up after changing to game mode.
else if (m_renderContext.framesSpentInCurrentPhase++ > 30)
Expand All @@ -1053,9 +1074,14 @@ void CSequenceBatchRenderDialog::OnUpdateBeginPlayingSequence()

SRenderItem renderItem = m_renderItems[m_renderContext.currentItemIndex];

GetIEditor()->GetMovieSystem()->AddMovieListener(renderItem.pSequence, this);
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);
if (movieSystem)
{
movieSystem->AddMovieListener(renderItem.pSequence, this);
movieSystem->Resume();
}

GetIEditor()->GetMovieSystem()->Resume();

// Set the time range for this render, back it up 1 frame so the capture will start
// exactly on the first frame.
Expand All @@ -1064,7 +1090,10 @@ void CSequenceBatchRenderDialog::OnUpdateBeginPlayingSequence()
renderItem.pSequence->SetTimeRange(newRange);

// Start the sequence playing
GetIEditor()->GetMovieSystem()->SetPlayingTime(renderItem.pSequence, newRange.start);
if (movieSystem)
{
movieSystem->SetPlayingTime(renderItem.pSequence, newRange.start);
}

EnterCaptureState(CaptureState::Capturing);
}
Expand All @@ -1084,9 +1113,12 @@ void CSequenceBatchRenderDialog::OnUpdateCapturing()
// Progress bar
IAnimSequence* pCurSeq = m_renderItems[m_renderContext.currentItemIndex].pSequence;
Range rng = pCurSeq->GetTimeRange();
float elapsedTime = GetIEditor()->GetMovieSystem()->GetPlayingTime(pCurSeq) - rng.start;
int percentage
= int(100.0f * (m_renderContext.spentTime + elapsedTime) / m_renderContext.expectedTotalTime);

IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

float elapsedTime = movieSystem ? movieSystem->GetPlayingTime(pCurSeq) - rng.start : 0.f;
int percentage = int(100.0f * (m_renderContext.spentTime + elapsedTime) / m_renderContext.expectedTotalTime);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we protect against a divide by zero here?

m_ui->m_progressBar->setValue(percentage);

// Progress message
Expand All @@ -1099,13 +1131,20 @@ void CSequenceBatchRenderDialog::OnUpdateCapturing()

void CSequenceBatchRenderDialog::OnUpdateEnd(IAnimSequence* sequence)
{
GetIEditor()->GetMovieSystem()->DisableFixedStepForCapture();
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

if (movieSystem)
{
movieSystem->DisableFixedStepForCapture();

// Important: End batch render mode BEFORE leaving Game Mode.
// Otherwise track view will set the active camera based on the directors in the current sequence while leaving game mode
movieSystem->EnableBatchRenderMode(false);

// Important: End batch render mode BEFORE leaving Game Mode.
// Otherwise track view will set the active camera based on the directors in the current sequence while leaving game mode
GetIEditor()->GetMovieSystem()->EnableBatchRenderMode(false);
movieSystem->RemoveMovieListener(sequence, this);

GetIEditor()->GetMovieSystem()->RemoveMovieListener(sequence, this);
}
GetIEditor()->SetInGameMode(false);
GetIEditor()->GetGameEngine()->Update(); // Update is needed because SetInGameMode() queues game mode, Update() executes it.

Expand Down Expand Up @@ -1328,12 +1367,18 @@ void CSequenceBatchRenderDialog::OnKickIdle()

if (canBeginFrameCapture())
{
// update the time so the frame number can be calculated in StartCapture()
IAnimSequence* sequence = m_renderItems[m_renderContext.currentItemIndex].pSequence;
m_renderContext.captureOptions.time = GetIEditor()->GetMovieSystem()->GetPlayingTime(sequence);
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

GetIEditor()->GetMovieSystem()->StartCapture(m_renderContext.captureOptions, ++m_renderContext.frameNumber);
GetIEditor()->GetMovieSystem()->ControlCapture();
if (movieSystem)
{
// update the time so the frame number can be calculated in StartCapture()
IAnimSequence* sequence = m_renderItems[m_renderContext.currentItemIndex].pSequence;
m_renderContext.captureOptions.time = movieSystem->GetPlayingTime(sequence);

movieSystem->StartCapture(m_renderContext.captureOptions, ++m_renderContext.frameNumber);
movieSystem->ControlCapture();
}
}

// if we're not capturing or we're not currently waiting for the current frame to finish
Expand All @@ -1355,11 +1400,18 @@ void CSequenceBatchRenderDialog::OnKickIdle()
m_renderContext.captureOptions.folder.c_str(), fileName.c_str(), filePath, /*caseInsensitive=*/true,
/*normalize=*/false);

IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

// track view callback after each frame is captured
const auto captureFinishedCallback = [this]() {
const auto captureFinishedCallback = [this, movieSystem]()
{
m_renderContext.capturingFrame = false;
GetIEditor()->GetMovieSystem()->EndCapture();
GetIEditor()->GetMovieSystem()->ControlCapture();
if (movieSystem)
{
movieSystem->EndCapture();
movieSystem->ControlCapture();
}
};

const auto imageFormatExtension = m_ui->m_imageFormatCombo->currentText();
Expand Down Expand Up @@ -1409,7 +1461,12 @@ void CSequenceBatchRenderDialog::OnCancelRender()
{
// In the capturing state, abort the sequence, OnMovieEvent with an abort will fire and cause
// the transition to CaptureState::End.
GetIEditor()->GetMovieSystem()->AbortSequence(m_renderItems[m_renderContext.currentItemIndex].pSequence);
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);
if (movieSystem)
{
movieSystem->AbortSequence(m_renderItems[m_renderContext.currentItemIndex].pSequence);
}
}
else if (m_renderContext.captureState == CaptureState::EnteringGameMode)
{
Expand Down Expand Up @@ -1462,6 +1519,9 @@ void CSequenceBatchRenderDialog::OnLoadBatch()

OnClearRenderItems();

IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

for (int i = 0; i < batchRenderListNode->getChildCount(); ++i)
{
// Get an item.
Expand All @@ -1470,7 +1530,7 @@ void CSequenceBatchRenderDialog::OnLoadBatch()

// sequence
const QString seqName = itemNode->getAttr("sequence");
item.pSequence = GetIEditor()->GetMovieSystem()->FindLegacySequenceByName(seqName.toUtf8().data());
item.pSequence = movieSystem ? movieSystem->FindLegacySequenceByName(seqName.toUtf8().data()) : nullptr;
if (item.pSequence == nullptr)
{
QMessageBox::warning(this, tr("Sequence not found"), tr("A sequence of '%1' not found! This'll be skipped.").arg(seqName));
Expand Down Expand Up @@ -1597,7 +1657,10 @@ bool CSequenceBatchRenderDialog::SetUpNewRenderItem(SRenderItem& item)
return false;
}
// sequence
item.pSequence = GetIEditor()->GetMovieSystem()->FindLegacySequenceByName(seqName.toUtf8().data());
IMovieSystem* movieSystem = nullptr;
Maestro::MovieSystemRequestBus::BroadcastResult(movieSystem, &Maestro::MovieSystemRequestBus::Events::GetMovieSystem);

item.pSequence = movieSystem ? movieSystem->FindLegacySequenceByName(seqName.toUtf8().data()) : nullptr;
assert(item.pSequence);
// director
for (int i = 0; i < item.pSequence->GetNodeCount(); ++i)
Expand Down
Loading