OmegaEngine API  1.0.3
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
OmegaEngine.EngineElementCollection< T > Class Template Reference

A collection of EngineElements. Applies the composite pattern: automatically handles EngineElement.Engine setting and EngineElement.Dispose calling. More...

Inheritance diagram for OmegaEngine.EngineElementCollection< T >:
OmegaEngine.EngineElement

Public Member Functions

IEnumerator< T > GetEnumerator ()
 
void Add (T item)
 
void Clear ()
 
bool Contains (T item)
 
void CopyTo (T[] array, int arrayIndex)
 
bool Remove (T item)
 
- Public Member Functions inherited from OmegaEngine.EngineElement
void Dispose ()
 

Public Attributes

int Count => _innerList.Count
 
bool IsReadOnly => false
 
- Public Attributes inherited from OmegaEngine.EngineElement
bool IsEngineSet => _engine != null
 true if the Engine has been set. More...
 

Protected Member Functions

override void OnEngineSet ()
 Hook that is calld when Engine is set for the first time. More...
 
override void OnDispose ()
 Hook that is called when the object needs to dispose its internal resources. More...
 
- Protected Member Functions inherited from OmegaEngine.EngineElement
void RegisterChild (EngineElement element, bool autoDispose=true)
 Registers a child EngineElement for automatic Engine setting and Dispose calling. More...
 
void UnregisterChild (EngineElement element)
 Unregisters a child EngineElement (opposite of RegisterChild). More...
 

Additional Inherited Members

- Properties inherited from OmegaEngine.EngineElement
Engine Engine [get, set]
 The Engine instance used by this object. Must be set before using the object. May not be changed once it has been set! More...
 
bool IsDisposed [get]
 Indicates whether this object has been disposed and can therefore no longer be used. More...
 

Detailed Description

A collection of EngineElements. Applies the composite pattern: automatically handles EngineElement.Engine setting and EngineElement.Dispose calling.

Template Parameters
TThe specific type of EngineElement contained in the collection.
Type Constraints
T :EngineElement 

Member Function Documentation

◆ OnDispose()

override void OmegaEngine.EngineElementCollection< T >.OnDispose ( )
inlineprotectedvirtual

Hook that is called when the object needs to dispose its internal resources.

Reimplemented from OmegaEngine.EngineElement.

◆ OnEngineSet()

override void OmegaEngine.EngineElementCollection< T >.OnEngineSet ( )
inlineprotectedvirtual

Hook that is calld when Engine is set for the first time.

Reimplemented from OmegaEngine.EngineElement.


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