DepictionEngine.Index2DLoadScope Class Reference

Public Types
enum	URLParametersType { ZoomXY , LatLon , LatLonAlt , GeoBoundaries }
	Different types of URL parameters. ZoomXY: Tile index defined by Zoom{0} and X{1}, Y{2}. LatLon: GeoCoordinate defined by Latitude{0} and Longitude{1}. LatLonAlt: GeoCoordinate defined by Latitude{0}, Longitude{1} and Altitude{2}. GeoBoundaries: Boundaries defined by Longitude Min{0}, Longitude Max{1} and Latitude Min{2}, Latitude Max{3}.

Public Member Functions
override void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.
Index2DLoadScope	Init (LoaderBase loader, Vector2Int index, Vector2Int dimensions, URLParametersType indexUrlParamType)
int	GetZoom ()
override JSONObject	GetLoadScopeFallbackValuesJson ()
override object[]	GetURLParams ()
override bool	IsInScope (IPersistent persistent)
override int	GetHashCode ()
override bool	AddPersistent (IPersistent persistent)
override bool	RemovePersistent (IPersistent persistent, DisposeContext disposeContext=DisposeContext.Programmatically_Pool)
Public Member Functions inherited from DepictionEngine.LoadScope
override void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.
bool	InitializeLastFields ()
LoadScope	Init (LoaderBase loader)
List<(bool, SerializableGuid, IPersistent)>	PerformAddRemovePersistentsChange (bool compareWithLastDictionary=false)
IPersistent	GetFirstPersistent ()
virtual bool	AddPersistent (IPersistent persistent)
virtual bool	RemovePersistent (IPersistent persistent, DisposeContext disposeContext=DisposeContext.Programmatically_Pool)
bool	RemovePersistent (SerializableGuid persistentId, DisposeContext disposeContext=DisposeContext.Programmatically_Pool)
void	IterateOverPersistents (Func< SerializableGuid, IPersistent, bool > callback)
bool	ContainsPersistent (SerializableGuid persistentId)
void	DatasourceChanged (DisposeContext disposeContext=DisposeContext.Programmatically_Pool)
bool	LoadingWasCompromised ()
void	KillLoading ()
bool	LoadInProgress ()
void	Load (float loadInterval=0.0f)
JSONArray	GetPersistentFallbackValuesJson ()
virtual JSONObject	GetLoadScopeFallbackValuesJson ()
FallbackValues	GetFirstPersistentFallbackValues ()
virtual bool	IsInScope (IPersistent persistent)
virtual object[]	GetURLParams ()
void	Merge (LoadScope loadScope)
override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
Public Member Functions inherited from DepictionEngine.ScriptableObjectDisposable
virtual void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.
bool	Initialize ()
	Needs to be called before the object can be used. Objects created through the DepictionEngine.InstanceManager should automatically Initialize the object.
virtual void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.
InitializationContext	GetInitializeContext ()
bool	IsDisposing ()
	Is the object disposing?.
bool	IsDisposed ()
	Has the object been disposed?
void	Originator (Action callback, IScriptableBehaviour originator)
	Provides the code executed in this callback information about the DepictionEngine.IScriptableBehaviour that triggered it by keeping a reference available under DepictionEngine.IScriptableBehaviour.originator.
bool	OnDisposing ()
bool	UpdateDisposingContext (bool forceUpdate=false)
	This is where you clear or dispose any remaining references. It will be called automatically by DepictionEngine.DisposeManager immediately after DepictionEngine.IDisposable.OnDisposing unless the object was Destroyed as a result of an Editor action.
void	OnDisposeInternal (DisposeContext disposeContext)
virtual bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
void	OnDestroy ()
	This is where you destroy any remaining dependencies.
virtual void	OnBeforeSerialize ()
virtual void	OnAfterDeserialize ()
virtual void	OnValidate ()
bool	Equals (Disposable.Null value)
override bool	Equals (object value)
override int	GetHashCode ()
Public Member Functions inherited from DepictionEngine.IScriptableBehaviour
InitializationContext	GetInitializeContext ()
void	Originator (Action callback, IScriptableBehaviour originator)
	Provides the code executed in this callback information about the DepictionEngine.IScriptableBehaviour that triggered it by keeping a reference available under DepictionEngine.IScriptableBehaviour.originator.
int	GetInstanceID ()
void	OnDestroy ()
	This is where you destroy any remaining dependencies.
void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.
void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.
bool	Initialize ()
	Needs to be called before the object can be used. Objects created through the DepictionEngine.InstanceManager should automatically Initialize the object.
bool	IsDisposing ()
	Is the object disposing?.
bool	IsDisposed ()
	Has the object been disposed?
bool	OnDisposing ()
bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
void	OnDisposeInternal (DisposeContext disposeContext)
bool	UpdateDisposingContext (bool forceUpdate=false)
	This is where you clear or dispose any remaining references. It will be called automatically by DepictionEngine.DisposeManager immediately after DepictionEngine.IDisposable.OnDisposing unless the object was Destroyed as a result of an Editor action.
bool	Equals (Disposable.Null value)
void	IterateOverPersistents (Func< SerializableGuid, IPersistent, bool > callback)
bool	AddPersistent (IPersistent persistent)
bool	RemovePersistent (IPersistent persistent, DisposeContext disposeContext=DisposeContext.Programmatically_Pool)
bool	RemovePersistent (SerializableGuid persistentId, DisposeContext disposeContext=DisposeContext.Programmatically_Pool)

Properties
Vector2Int	scopeIndex [get]
Vector2Int	scopeDimensions [get]
Grid2DIndex	scopeGrid2DIndex [get]
override object	scopeKey [get]
URLParametersType	indexUrlParamType [get]
VisibleCameras	visibleInCameras [get, set]
Properties inherited from DepictionEngine.LoadScope
int	persistentCount [get]
virtual object	scopeKey [get]
LoaderBase	loader [get]
DatasourceOperationBase.LoadingState	loadingState [get]
Properties inherited from DepictionEngine.ScriptableObjectDisposable
bool	wasFirstUpdated [get]
bool	initialized [get]
	Has the object been initialized.
bool	instanceAdded [get, set]
bool	isFallbackValues [get]
	Was this component created by a DepictionEngine.FallbackValues.
IScriptableBehaviour	originator [get]
	Which DepictionEngine.IScriptableBehaviour triggered the current code execution if any at all.
DisposeContext	disposingContext [get]
	The DepictionEngine.DisposeContext under which the object was destroyed.
bool	poolComplete [get, set]
	Is the object done disposing.
Action< IDisposable >	InitializedEvent [get, set]
	Dispatched after the object as been initialized.
Action< IDisposable, DisposeContext >	DisposedEvent [get, set]
	Dispatched during the DepictionEngine.MonoBehaviourDisposable.OnDispose, DepictionEngine.ScriptableObjectDisposable.OnDispose or DepictionEngine.Disposable.OnDispose.
SceneManager	sceneManager [get]
InstanceManager	instanceManager [get]
DatasourceManager	datasourceManager [get]
TweenManager	tweenManager [get]
InputManager	inputManager [get]
CameraManager	cameraManager [get]
PoolManager	poolManager [get]
RenderingManager	renderingManager [get]
Properties inherited from DepictionEngine.IScriptableBehaviour
string	name [get, set]
bool	isFallbackValues [get]
	Was this component created by a DepictionEngine.FallbackValues.
IScriptableBehaviour	originator [get]
	Which DepictionEngine.IScriptableBehaviour triggered the current code execution if any at all.
Properties inherited from DepictionEngine.IDisposable
Action< IDisposable >	InitializedEvent [get, set]
	Dispatched after the object as been initialized.
Action< IDisposable, DisposeContext >	DisposedEvent [get, set]
	Dispatched during the DepictionEngine.MonoBehaviourDisposable.OnDispose, DepictionEngine.ScriptableObjectDisposable.OnDispose or DepictionEngine.Disposable.OnDispose.
bool	initialized [get]
	Has the object been initialized.
bool	poolComplete [get, set]
	Is the object done disposing.
DisposeContext	disposingContext [get]
	The DepictionEngine.DisposeContext under which the object was destroyed.

Additional Inherited Members
Static Public Member Functions inherited from DepictionEngine.ScriptableObjectDisposable
static bool	operator!= (ScriptableObjectDisposable lhs, Disposable.Null rhs)
static bool	operator== (ScriptableObjectDisposable lhs, Disposable.Null _)
Public Attributes inherited from DepictionEngine.LoadScope
Action< LoadScope >	LoadingStateChangedEvent
	Dispatched when the loading state changed.
Action< LoadScope >	PersistentAddedEvent
	Dispatched when an DepictionEngine.IPersistent loaded from a DepictionEngine.ILoadDatasource is added to the DepictionEngine.LoadScope.
Action< LoadScope >	PersistentRemovedEvent
	Dispatched when an DepictionEngine.IPersistent loaded from a DepictionEngine.ILoadDatasource is removed from the DepictionEngine.LoadScope.
Protected Member Functions inherited from DepictionEngine.ScriptableObjectDisposable
bool	IsDuplicateInitializing ()
virtual void	DestroyAfterFailedInitialization ()
virtual void	Initializing ()
	The first step of the initialization process.
virtual void	InitializeUID (InitializationContext initializingContext)
	Initializes the object's unique identifiers.
virtual bool	AddToInstanceManager ()
	Add the object to the DepictionEngine.InstanceManager if possible.
virtual bool	Initialize (InitializationContext initializingContext)
	The main initialization function.
virtual bool	IsValidInitialization (InitializationContext initializingContext)
	Provides the ability to interrupt the initialization.
bool	InitValue< T > (Action< T > callback, T defaultValue, InitializationContext initializingContext)
bool	InitValue< T > (Action< T > callback, T defaultValue, T duplicateValue, InitializationContext initializingContext)
virtual bool	UpdateAllDelegates ()
	Function to initialize event handlers.
virtual void	Saving (UnityEngine.SceneManagement.Scene scene, string path)
bool	HasChanged (object newValue, object oldValue, bool forceChangeDuringInitializing=true)
	Are the two objects equals?
bool	IsFallbackValues ()
bool	IsNotFallbackValues ()
bool	IsDestroying ()
	Is the object destroying?
virtual bool	UpdateHideFlags ()
virtual DisposeContext	GetDisposingContext ()
virtual void	OnEnable ()
virtual void	OnDisable ()
Protected Attributes inherited from DepictionEngine.LoadScope
PersistentsDictionary	_persistentsDictionary

Member Function Documentation

AddPersistent()

override bool DepictionEngine.Index2DLoadScope.AddPersistent ( IPersistent  persistent )

virtual

Reimplemented from DepictionEngine.LoadScope.

GetLoadScopeFallbackValuesJson()

override JSONObject DepictionEngine.Index2DLoadScope.GetLoadScopeFallbackValuesJson ( )

virtual

Reimplemented from DepictionEngine.LoadScope.

GetURLParams()

override object[] DepictionEngine.Index2DLoadScope.GetURLParams ( )

virtual

Reimplemented from DepictionEngine.LoadScope.

IsInScope()

override bool DepictionEngine.Index2DLoadScope.IsInScope ( IPersistent  persistent )

virtual

Reimplemented from DepictionEngine.LoadScope.

Recycle()

override void DepictionEngine.Index2DLoadScope.Recycle ( )

virtual

Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.

Reimplemented from DepictionEngine.ScriptableObjectDisposable.

RemovePersistent()

override bool DepictionEngine.Index2DLoadScope.RemovePersistent ( IPersistent  persistent, DisposeContext  disposeContext = DisposeContext::Programmatically_Pool  )

virtual

Reimplemented from DepictionEngine.LoadScope.

---

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

• Index2DLoadScope.cs