Leviathan  0.8.0.0
Leviathan game engine
Leviathan::BaseNotifierAll Class Reference

Specialized class for accepting all parent/child objects. More...

#include <BaseNotifier.h>

+ Inheritance diagram for Leviathan::BaseNotifierAll:

Public Member Functions

 BaseNotifierAll ()
 
 ~BaseNotifierAll ()
 
- Public Member Functions inherited from Leviathan::BaseNotifier< BaseNotifierAll, BaseNotifiableAll >
 BaseNotifier (BaseNotifierAll *ourptr)
 
virtual ~BaseNotifier ()
 
void ReleaseChildHooks ()
 Release function that unhooks all child objects. More...
 
void ReleaseChildHooks (Lock &guard)
 
FORCE_INLINE bool ConnectToNotifiable (BaseNotifiable< BaseNotifierAll, BaseNotifiableAll > *child)
 Connects this to a notifiable object for holding a reference to it. More...
 
bool ConnectToNotifiable (Lock &guard, BaseNotifiable< BaseNotifierAll, BaseNotifiableAll > *child, Lock &childlock)
 The actual implementation of ConnecToNotifiable. More...
 
virtual void NotifyAll (Lock &guard)
 Notifies the children about something. More...
 
bool UnConnectFromNotifiable (Lock &guard, BaseNotifiable< BaseNotifierAll, BaseNotifiableAll > *unhookfrom)
 Disconnects from previously connected notifiable. More...
 
FORCE_INLINE bool UnConnectFromNotifiable (BaseNotifiable< BaseNotifierAll, BaseNotifiableAll > *child)
 
bool UnConnectFromNotifiable (int id)
 Searches the connected notifiable objects and calls the above function with it's pointer. More...
 
bool IsConnectedTo (BaseNotifiable< BaseNotifierAll, BaseNotifiableAll > *check, Lock &guard)
 Actual implementation of this method. More...
 
FORCE_INLINE bool IsConnectedTo (BaseNotifiable< BaseNotifierAll, BaseNotifiableAll > *check)
 Returns true when the specified object is already connected. More...
 
void _OnUnhookNotifiable (Lock &guard, BaseNotifiable< BaseNotifierAll, BaseNotifiableAll > *childtoremove, Lock &childlock)
 
void _OnHookNotifiable (Lock &guard, BaseNotifiable< BaseNotifierAll, BaseNotifiableAll > *child, Lock &childlock)
 
BaseNotifierAllGetActualPointerToNotifierObject ()
 Gets the internal pointer to the actual object. More...
 
virtual void OnNotified (Lock &ownlock, BaseNotifiableAll *child, Lock &childlock)
 Called when one of our children notifies us about something. More...
 
- Public Member Functions inherited from Leviathan::ThreadSafeGeneric< MutexType >
DLLEXPORT ThreadSafeGeneric ()
 
DLLEXPORT ~ThreadSafeGeneric ()
 
FORCE_INLINE void VerifyLock (RecursiveLock &guard) const
 
FORCE_INLINE void VerifyLock (Lock &lockit) const
 

Additional Inherited Members

- Public Types inherited from Leviathan::ThreadSafeGeneric< MutexType >
using LockT = typename LockTypeResolver< MutexType >::LType
 
- Protected Member Functions inherited from Leviathan::BaseNotifier< BaseNotifierAll, BaseNotifiableAll >
virtual void _OnNotifiableConnected (Lock &guard, BaseNotifiableAll *childadded, Lock &childlock)
 
virtual void _OnNotifiableDisconnected (Lock &guard, BaseNotifiableAll *childtoremove, Lock &childlock)
 
- Protected Attributes inherited from Leviathan::BaseNotifier< BaseNotifierAll, BaseNotifiableAll >
BaseNotifierAllPointerToOurNotifier
 Stores a pointer to the object that is inherited from this. More...
 
std::vector< BaseNotifiable< BaseNotifierAll, BaseNotifiableAll > *> ConnectedChildren
 Vector of other objects that this is connected to. More...
 
- Protected Attributes inherited from Leviathan::ThreadSafeGeneric< MutexType >
MutexType ObjectsLock
 

Detailed Description

Specialized class for accepting all parent/child objects.

Definition at line 103 of file BaseNotifier.h.

Constructor & Destructor Documentation

◆ BaseNotifierAll()

Leviathan::BaseNotifierAll::BaseNotifierAll ( )
inline

Definition at line 105 of file BaseNotifier.h.

105  : BaseNotifier(this){
106  }

◆ ~BaseNotifierAll()

Leviathan::BaseNotifierAll::~BaseNotifierAll ( )
inline

Definition at line 107 of file BaseNotifier.h.

107  {
108  }

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