birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Removes IObservable/Observable from Code/Editor

Browse Source 
Signed-off-by: Esteban Papp <81431996+amznestebanpapp@users.noreply.github.com>
This commit is contained in:
Esteban Papp
2021-11-16 11:59:10 -08:00
parent 328a5ddbd3
commit 9107af5af7
4 changed files with 0 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Code/Editor/IObservable.h
-20
View File
@@ -1,20 +0,0 @@
/*
* Copyright (c) Contributors to the Open 3D Engine Project.
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
#ifndef CRYINCLUDE_EDITOR_IOBSERVABLE_H
#define CRYINCLUDE_EDITOR_IOBSERVABLE_H
#pragma once
//! Observable macro to be used in pure interfaces
#define DEFINE_OBSERVABLE_PURE_METHODS(observerClassName) \
virtual bool RegisterObserver(observerClassName * pObserver) = 0; \
virtual bool UnregisterObserver(observerClassName * pObserver) = 0; \
virtual void UnregisterAllObservers() = 0;
#endif // CRYINCLUDE_EDITOR_IOBSERVABLE_H
Code/Editor/Util/IObservable.h
-20
View File
@@ -1,20 +0,0 @@
/*
* Copyright (c) Contributors to the Open 3D Engine Project.
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
// Description : Handy macro when working with observers in interfaces
#ifndef CRYINCLUDE_EDITOR_UTIL_IOBSERVABLE_H
#define CRYINCLUDE_EDITOR_UTIL_IOBSERVABLE_H
#pragma once
#define DEFINE_OBSERVABLE_PURE_METHODS(observerClassName) \
virtual bool RegisterObserver(observerClassName * pObserver) = 0; \
virtual bool UnregisterObserver(observerClassName * pObserver) = 0; \
virtual void UnregisterAllObservers() = 0;
#endif // CRYINCLUDE_EDITOR_UTIL_IOBSERVABLE_H
Code/Editor/Util/Observable.h
-103
View File
@@ -1,103 +0,0 @@
/*
* Copyright (c) Contributors to the Open 3D Engine Project.
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
// Description : This file declares templates to be used when a class can
// have a list of observers to feed
#ifndef CRYINCLUDE_EDITOR_UTIL_OBSERVABLE_H
#define CRYINCLUDE_EDITOR_UTIL_OBSERVABLE_H
#pragma once
#include <vector>
//! Observable template class, holds a list of observers which can be called at once using the helper defines
template<class T>
class CObservable
{
public:
// Description:
// Register a new observer for the class, will check if not already added
// Return:
// true - if the observer was successfully added to the list
// false - if the observer is already in the list
bool RegisterObserver(T* pObserver)
{
if (m_observers.end() != std::find(m_observers.begin(), m_observers.end(), pObserver))
{
return false;
}
m_observers.push_back(pObserver);
return true;
}
// Description:
// Unregister an observer from the list
// Return:
// true - if the observer was successfuly removed
// false - if the observer is not in the list
bool UnregisterObserver(T* pObserver)
{
typename std::vector<T*>::iterator iter;
if (m_observers.end() == (iter = std::find(m_observers.begin(), m_observers.end(), pObserver)))
{
return false;
}
m_observers.erase(iter);
return true;
}
// Description:
// Uregister all the observers
void UnregisterAllObservers()
{
m_observers.clear();
}
protected:
std::vector<T*> m_observers;
};
//
// Helper defines to ease the process of calling the methods of all observers in the list
//
// Description:
// Call the method of the observers, this must be used inside the subject class
// Example: CALL_OBSERVERS_METHOD(OnStuffHappened(120, "NO!"))
#define CALL_OBSERVERS_METHOD(methodCall) \
{ for (size_t iObs = 0, iObsCount = m_observers.size(); iObs < iObsCount; ++iObs) { m_observers[iObs]->methodCall; } \
}
// Description:
// Call the method of the observers, this can be used outside the subject class
// Example: CALL_OBSERVERS_METHOD_OF(pSomeObservableSubject, OnStuffHappened(120, "NO!"))
#define CALL_OBSERVERS_METHOD_OF(pObservable, methodCall) \
{ for (size_t iObs = 0, iObsCount = pObservable->m_observers.size(); iObs < iObsCount; ++iObs) { pObservable->m_observers[iObs]->methodCall; } \
}
// Description:
// Call the method of the observers, this can be called using a custom vector of observers
// Example: CALL_SPECIFIED_OBSERVERS_LIST_METHOD(vMyPreciousSpecialObservers, OnStuffHappened(120, "NO!"))
#define CALL_SPECIFIED_OBSERVERS_LIST_METHOD(vObservers, methodCall) \
{ for (size_t iObs = 0, iObsCount = vObservers.size(); iObs < iObsCount; ++iObs) { vObservers[iObs]->methodCall; } \
}
// Description:
// Implement the observable methods when the user class is inheriting from a virtual interface using the observable methods
#define IMPLEMENT_OBSERVABLE_METHODS(observerClassName) \
virtual bool RegisterObserver(observerClassName * pObserver) { return CObservable<observerClassName>::RegisterObserver(pObserver); }; \
virtual bool UnregisterObserver(observerClassName * pObserver) { return CObservable<observerClassName>::UnregisterObserver(pObserver); }; \
virtual void UnregisterAllObservers() { CObservable<observerClassName>::UnregisterAllObservers(); };
#endif // CRYINCLUDE_EDITOR_UTIL_OBSERVABLE_H
Code/Editor/editor_lib_files.cmake
-3
View File
@@ -438,7 +438,6 @@ set(FILES
FBXExporterDialog.h
FileTypeUtils.h
GridUtils.h
IObservable.h
IPostRenderer.h
ToolBox.h
TrackViewNewSequenceDialog.h
@@ -647,11 +646,9 @@ set(FILES
Util/GeometryUtil.cpp
Util/GuidUtil.cpp
Util/GuidUtil.h
Util/IObservable.h
Util/Mailer.h
Util/NamedData.cpp
Util/NamedData.h
Util/Observable.h
Util/PakFile.cpp
Util/PakFile.h
Util/PredefinedAspectRatios.cpp