Classes
class	ReferencesList

Public Types
enum	DataType { Unknown , Json , TexturePngJpg , TextureWebP , ElevationTerrainRGBPngRaw , ElevationTerrainRGBWebP , ElevationEsriLimitedErrorRasterCompression }
	Different types of data. Unknown: The Data type is Unknown. Json: JSON format. TexturePngJpg: A .png or .jpg texture. TextureWebP: A .webp texture. ElevationTerrainRGBPngRaw: A .pngraw texture containing elevation in TerrainRGB format. ElevationTerrainRGBWebP: A .webp texture containing elevation in TerrainRGB format. ElevationEsriLimitedErrorRasterCompression: Elevation data in Esri LimitedErrorRasterCompression (LERC) format.

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.

List< LoadScope >	LoadAll ()
	Create missing DepictionEngine.LoadScope(s) and dispose those that are no longer required.

List< LoadScope >	ReloadAll ()
	Internal method, to reload data use the DepictionEngine.DatasourceBase.ReloadAll instead.

virtual bool	GetLoadScope (out LoadScope loadScope, IPersistent persistent)
	Returns true if a loadScope is found for the specified DepictionEngine.IPersistent.

virtual bool	GetLoadScope (out LoadScope loadScope, object loadScopeKey, bool reload=false, bool createIfMissing=false, float loadInterval=0.0f)
	Returns true if a loadScope exists or a new one was created.

virtual bool	IterateOverLoadScopes (Func< object, LoadScope, bool > callback)

virtual bool	AddReference (object loadScopeKey, ReferenceBase reference)

virtual bool	RemoveReference (object loadScopeKey, ReferenceBase reference, DisposeContext disposeContext=DisposeContext.Programmatically_Pool)

override bool	PreHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called before the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.

override bool	PostHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called after the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.

void	Load (LoadScope loadScope, float loadInterval=0.0f)

void	IterateOverPersistents (Func< SerializableGuid, IPersistent, bool > callback)

bool	IsPersistentInScope (IPersistent persistent)

bool	ContainsPersistent (IPersistent persistent)

int	GetPersistentCount ()

bool	AddPersistent (IPersistent persistent)

bool	RemovePersistent (IPersistent persistent, DisposeContext disposeContext=DisposeContext.Programmatically_Pool)

bool	RemovePersistent (SerializableGuid persistentId, DisposeContext disposeContext=DisposeContext.Programmatically_Pool)

virtual bool	IsInList (LoadScope loadScope)

void	DisposeAllLoadScopes (DisposeContext disposeContext=DisposeContext.Programmatically_Pool)
	Dispose all the DepictionEngine.LoadScope(s).

override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.

Public Member Functions inherited from DepictionEngine.GeneratorBase
void	IterateOverFallbackValues< T > (Func< FallbackValues, bool > callback)

void	IterateOverFallbackValues< T, T1 > (Func< FallbackValues, bool > callback)

void	IterateOverFallbackValues (Func< FallbackValues, bool > callback, Type type, Type type1=null)

bool	GeneratePersistent (out IPersistent persistent, Type type, JSONObject json, List< PropertyModifier > propertyModifiers=null)

Public Member Functions inherited from DepictionEngine.Script
float	GetSphericalRatio ()

Public Member Functions inherited from DepictionEngine.JsonMonoBehaviour
override void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.

virtual bool	DetectUserGameObjectChanges ()
	Detect changes that happen as a result of an external influence.

Public Member Functions inherited from DepictionEngine.PropertyMonoBehaviour
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.

override void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.

virtual void	UpdateDependencies ()

virtual bool	UpdateRelations (Action beforeSiblingsInitializeCallback=null)

virtual void	UpdateParent (PropertyMonoBehaviour originator=null)
	Finds and sets the parent.

bool	PropertyDirty (string name)

void	ResetId ()
	Resets the Id to DepictionEngine.SerializableGuid.Empty.

void	UpdateActiveAndEnabled ()

virtual void	HierarchicalApplyOriginShifting (Vector3Double origin, bool originShiftSelected)

virtual bool	HierarchicalBeginCameraRendering (Camera camera)
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the RenderPipelineManager.beginCameraRendering.

virtual bool	HierarchicalEndCameraRendering (Camera camera)
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the RenderPipelineManager.endCameraRendering.

virtual bool	PreHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called before the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.

virtual void	PreHierarchicalUpdateBeforeChildrenAndSiblings ()

virtual bool	HierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called after the DepictionEngine.PropertyMonoBehaviour.PreHierarchicalUpdate and before the DepictionEngine.PropertyMonoBehaviour.PostHierarchicalUpdate.

virtual bool	PostHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called after the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.

virtual void	IterateOverChildrenAndSiblings (Action< PropertyMonoBehaviour > callback=null)

override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.

Public Member Functions inherited from DepictionEngine.MonoBehaviourDisposable
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.

T	AddComponent< T > (InitializationContext initializingContext=InitializationContext.Programmatically, JSONObject json=null, List< PropertyModifier > propertyModifiers=null, bool isFallbackValues=false)

T	AddComponent< T > (bool initialize, InitializationContext initializingContext=InitializationContext.Programmatically, JSONObject json=null, List< PropertyModifier > propertyModifiers=null, bool isFallbackValues=false)

Component	AddComponent (Type componentType, InitializationContext initializingContext=InitializationContext.Programmatically, JSONObject json=null, List< PropertyModifier > propertyModifiers=null, bool isFallbackValues=false)

Component	AddComponent (Type componentType, bool initialize, InitializationContext initializingContext=InitializationContext.Programmatically, JSONObject json=null, List< PropertyModifier > propertyModifiers=null, bool isFallbackValues=false)

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	ResetId ()
	Resets the Id to DepictionEngine.SerializableGuid.Empty.

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)

Static Public Member Functions
static List<(bool, SerializableGuid, IPersistent)>	PerformAddRemovePersistentsChange (IPersistentList persistentList, PersistentsDictionary persistentsDictionary, PersistentsDictionary lastPersistentsDictionary)

Static Public Member Functions inherited from DepictionEngine.GeneratorBase
static int	GetTotalLoadingCount ()
	Returns The total number of loadScopes currently loading in the scene.

static int	GetTotalLoadedCount ()
	Returns The total number of loadScopes currently loaded in the scene.

Static Public Member Functions inherited from DepictionEngine.PropertyMonoBehaviour
static int	GetPropertyKey (string name)
	Returns a key for the property name.

Static Public Member Functions inherited from DepictionEngine.MonoBehaviourDisposable
static bool	InitValueInternal< T > (Action< T > callback, T defaultValue, Func< T > duplicateValue, InitializationContext initializingContext)

static bool	InitValueInternal< T > (Action< T > callback, T defaultValue, InitializationContext initializingContext)

static bool	operator!= (MonoBehaviourDisposable lhs, Disposable.Null rhs)

static bool	operator== (MonoBehaviourDisposable lhs, Disposable.Null _)

Public Attributes
Action< LoadScope, DisposeContext >	LoadScopeDisposedEvent
	Dispatched after a DepictionEngine.LoadScope is Disposed.

Action< LoadScope >	LoadScopeLoadingStateChangedEvent
	Dispatched when a DepictionEngine.LoadScope LoadingState changes.

Protected Member Functions
override void	IterateOverComponentReference (Action< SerializableGuid, Action > callback)

override void	InitializeFields (InitializationContext initializingContext)

override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.

List<(bool, object, LoadScope)>	PerformAddRemoveLoadScopesChange< T, T1 > (IDictionary< T, T1 > loadScopesDictionary, IDictionary< T, T1 > lastLoadScopesDictionary, bool performingUndoRedo=false)

List<(bool, object, ReferenceBase)>	PerformAddRemoveReferencesChange< T > (IDictionary< T, ReferencesList > referencesDictionary, IDictionary< T, ReferencesList > lastReferencesDictionary)

override bool	InitializeLastFields ()

virtual void	ClearLoadScopes ()

override bool	LateInitialize (InitializationContext initializingContext)
	Every other objects are initialized at this point.

override bool	UpdateAllDelegates ()
	Function to initialize event handlers.

override bool	AddInstanceToManager ()
	Should this object be added to the DepictionEngine.InstanceManager.

virtual bool	GetDefaultAutoLoadWhenDisabled ()

virtual float	GetDefaultWaitBetweenLoad ()

virtual float	GetDefaultLoadDelay ()

virtual bool	GetDefaultAutoDisposeUnused ()

virtual int	GetLoadScopeCount ()

virtual void	IterateOverLoadScopeKeys (Action< int, object, ReferencesList > callback)

override void	ObjectPropertyAssignedHandler (IProperty property, string name, object newValue, object oldValue)

override void	EnabledChanged (bool newValue, bool oldValue)

void	QueueAutoUpdate ()
	Queue a call to DepictionEngine.LoaderBase.UpdateLoadScopes if and when possible.

bool	CanAutoLoad ()

virtual void	UpdateLoadTriggers ()

virtual List< LoadScope >	UpdateLoadScopes (bool forceUpdate, bool reload=false)

virtual void	UpdateLoaderFields (bool forceUpdate)

virtual List< LoadScope >	GetListedLoadScopes (bool reload)

virtual void	UpdateLoadScopeFields ()

void	RemoveAllPersistents (DisposeContext disposeContext=DisposeContext.Programmatically_Pool)

LoadScope	CreateLoadScope (Type type, string name)

bool	AddLoadScope (LoadScope loadScope)

virtual bool	AddLoadScopeInternal (LoadScope loadScope)

bool	RemoveLoadScope (object loadScopeKey, DisposeContext disposeContext=DisposeContext.Programmatically_Pool)

virtual bool	RemoveLoadScopeInternal (object loadScopeKey, out LoadScope loadScope)

void	DisposeLoadScope (LoadScope loadScope, DisposeContext disposeContext=DisposeContext.Programmatically_Pool)
	Dispose the DepictionEngine.LoadScope.

Protected Member Functions inherited from DepictionEngine.GeneratorBase
override void	IterateOverComponentReference (Action< SerializableGuid, Action > callback)

override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.

virtual List< SerializableGuid >	GetDefaultFallbackValuesId ()

bool	GeneratePersistent (Type type, JSONObject json, List< PropertyModifier > propertyModifiers=null)

Protected Member Functions inherited from DepictionEngine.Script
override bool	UpdateAllDelegates ()
	Function to initialize event handlers.

void	UpdateParentGeoAstroObjectDelegates ()

virtual bool	RemoveObjectBaseDelegate (Object objectBase)

virtual bool	AddObjectBaseDelegate (Object objectBase)

virtual void	ObjectPropertyAssignedHandler (IProperty property, string name, object newValue, object oldValue)

virtual bool	RemoveParentGeoAstroObjectDelegates (GeoAstroObject parentGeoAstroObject)

virtual bool	AddParentGeoAstroObjectDelegates (GeoAstroObject parentGeoAstroObject)

virtual void	ParentGeoAstroObjectPropertyAssignedHandler (IProperty property, string name, object newValue, object oldValue)

virtual bool	TransformPropertyAssigned (IProperty property, string name, object newValue, object oldValue)

virtual void	TransformParentChanged ()

void	TransformChangedHandler (TransformBase.Component changedComponent, TransformBase.Component capturedComponent)

virtual bool	TransformChanged (TransformBase.Component changedComponent, TransformBase.Component capturedComponent)

override bool	IsFullyInitialized ()

bool	IsSpherical ()

bool	IsFlat ()

override Type	GetParentType ()

override bool	SetParent (PropertyMonoBehaviour value)

virtual bool	SetObjectBase (Object value)

virtual bool	SetParentGeoAstroObject (GeoAstroObject newValue, GeoAstroObject oldValue)

Protected Member Functions inherited from DepictionEngine.JsonMonoBehaviour
override void	Initializing ()
	The first step of the initialization process.

virtual JSONObject	GetInitializationJson (JSONObject initializeJSON)

override bool	InitializeLastFields ()

override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.

override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.

override SerializableGuid	GetId (SerializableGuid id, InitializationContext initializingContext)

virtual void	EnabledChanged (bool newValue, bool oldValue)

Protected Member Functions inherited from DepictionEngine.PropertyMonoBehaviour
virtual void	IterateOverComponentReference (Action< SerializableGuid, Action > callback)

override void	Initializing ()
	The first step of the initialization process.

override void	InitializeUID (InitializationContext initializingContext)
	Initializes the object's unique identifiers.

virtual SerializableGuid	GetId (SerializableGuid id, InitializationContext initializingContext)

override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.

virtual void	InitializeFieldsBeforeChildren (InitializationContext initializingContext)

virtual void	InitializeSerializedFieldsBeforeChildren (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.

virtual void	CreateAndInitializeDependencies (InitializationContext initializingContext)

virtual void	InitializeFields (InitializationContext initializingContext)

virtual void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.

virtual bool	InitializeLastFields ()

virtual bool	AddInstanceToManager ()
	Should this object be added to the DepictionEngine.InstanceManager.

override bool	AddToInstanceManager ()
	Add the object to the DepictionEngine.InstanceManager if possible.

override bool	UpdateAllDelegates ()
	Function to initialize event handlers.

virtual void	InstanceAddedHandler (IProperty property)

virtual void	InstanceRemovedHandler (IProperty property)

virtual bool	RemoveParentDelegates (PropertyMonoBehaviour parent)

virtual bool	AddParentDelegates (PropertyMonoBehaviour parent)

virtual bool	RemoveChildDelegates (PropertyMonoBehaviour child)

virtual bool	AddChildDelegates (PropertyMonoBehaviour child)

virtual PropertyMonoBehaviour	GetParent ()

void	UpdateSiblings ()

virtual void	UpdateChildren ()

T	InitializeComponent< T > (T component, JSONObject json=null, bool isFallbackValues=false)

virtual bool	ParentHasChanged ()

virtual bool	SiblingsHasChanged ()

virtual bool	ChildrenHasChanged ()

List< T >	GetComponentFromId< T > (List< SerializableGuid > ids)

T	GetComponentFromId< T > (SerializableGuid id)

List< SerializableGuid >	GetDuplicateComponentReferenceId< T > (List< SerializableGuid > ids, List< T > componentReferences, InitializationContext initializingContext)

SerializableGuid	GetDuplicateComponentReferenceId< T > (SerializableGuid id, T componentReference, InitializationContext initializingContext)

virtual bool	SetValue< T > (string name, T value, ref T valueField, Action< T, T > assignedCallback=null, bool allowAutoDisposeOnOutOfSynchProperty=false)

bool	HasChanged< T > (T newValue, T oldValue, bool forceChangeDuringInitializing=true)
	Are the two objects equals?

void	PropertyAssigned< T > (IProperty property, string name, T newValue, T oldValue)

virtual Type	GetParentType ()

virtual Type	GetSiblingType ()

virtual Type	GetChildType ()

virtual bool	CanBeDisabled ()

override void	OnDisable ()

override void	OnEnable ()

virtual void	ActiveAndEnabledChanged (bool newValue, bool oldValue)

virtual PropertyMonoBehaviour	GetRootParent ()

virtual PropertyMonoBehaviour	ValidatedParent (PropertyMonoBehaviour value)

virtual bool	SetParent (PropertyMonoBehaviour value)

virtual void	ParentChanged (PropertyMonoBehaviour newValue, PropertyMonoBehaviour oldValue)

virtual bool	AddChild (PropertyMonoBehaviour child)

virtual bool	RemoveChild (PropertyMonoBehaviour child)

virtual bool	ApplyBeforeChildren (Action< PropertyMonoBehaviour > callback)

virtual void	IterateOverChildren (Action< PropertyMonoBehaviour > callback=null)

bool	RemoveListItem< T > (List< T > list, T property)

void	IterateThroughList< T > (IList< T > list, Action< T > callback)

virtual bool	ApplyAfterChildren (Action< PropertyMonoBehaviour > callback)

bool	TriggerCallback< T > (T child, Action< T > callback)

virtual void	ClearDirtyFlags ()

Protected Member Functions inherited from DepictionEngine.MonoBehaviourDisposable
virtual void	Awake ()

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, Func< T > duplicateValue, InitializationContext initializingContext)

virtual bool	IsFullyInitialized ()

virtual bool	UpdateAllDelegates ()
	Function to initialize event handlers.

virtual void	Saving (UnityEngine.SceneManagement.Scene scene, string path)

virtual void	Saved (UnityEngine.SceneManagement.Scene scene)

virtual bool	LateInitialize (InitializationContext initializingContext)
	Every other objects are initialized at this point.

virtual bool	PostLateInitialize (InitializationContext initializingContext)
	Every other objects are initialized at this point.

bool	IsFallbackValues ()

bool	IsNotFallbackValues ()

bool	IsDestroying ()
	Is the object destroying?

virtual bool	UpdateHideFlags ()

virtual DisposeContext	GetDisposingContext ()

virtual void	OnEnable ()

virtual void	OnDisable ()

Properties
PersistentsDictionary	persistentsDictionary `[get]`

int	loadingCount `[get]`
	Returns the number of DepictionEngine.LoadScope(s) currently loading.

int	loadedCount `[get]`
	Returns the number of DepictionEngine.LoadScope(s) currently loaded.

PropertyMonoBehaviour	datasource `[get, set]`

SerializableGuid	datasourceId `[get, set]`
	The id of the datasource from which we will be loading data.

string	loadEndpoint `[get, set]`
	The endpoint that will be used by the DepictionEngine.RestDatasource when loading.

DataType	dataType `[get, set]`
	The type of data we expect the loading operation to return.

int	depth `[get, set]`

int	timeout `[get, set]`
	The amount of time (in seconds) to wait for a 'DepictionEngine.RestDatasource loading operation' before canceling, if it applies.

List< string >	headers `[get, set]`
	Values to send as web request headers during a 'DepictionEngine.RestDatasource loading operation', if it applies.

bool	autoUpdateWhenDisabled `[get, set]`
	When enabled the loader will automatically update loadScopes even if the Script or GameObject is not activated.

float	autoUpdateInterval `[get, set]`
	The interval (in seconds) at which we evaluate whether an auto update request should be made.

float	autoUpdateDelay `[get, set]`
	The amount of time (in seconds) to wait before we update following an auto update request.

bool	autoDisposeUnused `[get, set]`
	When enabled the DepictionEngine.LoadScope's will be automatically disposed when their last reference is removed.

Properties inherited from DepictionEngine.GeneratorBase
List< SerializableGuid >	fallbackValuesId `[get, set]`
	An ids list of the fallbackValues scripts containing default values to use on newly created objects.

int	seed `[get, set]`
	Use a random number other then -1 to create objects procedurally. Only works when no datasource is specified.

Properties inherited from DepictionEngine.Script
Object	objectBase `[get, protected set]`

GeoAstroObject	parentGeoAstroObject `[get, protected set]`

new TransformDouble	transform `[get]`

Properties inherited from DepictionEngine.JsonMonoBehaviour
JSONNode	initializationJson `[get]`

new bool	enabled `[get, set]`
	Enabled Behaviours are Updated, disable Behaviours are not.

Properties inherited from DepictionEngine.PropertyMonoBehaviour
Type	type `[get]`
	The Cass type.

List< PropertyMonoBehaviour >	children `[get]`

Action< IProperty, string, object, object >	PropertyAssignedEvent `[get, set]`
	Dispatched when a new value as been assigned to a field using the DepictionEngine.PropertyMonoBehaviour.SetValue method.

SerializableGuid	id `[get]`
	Global unique identifier.

bool	activeAndEnabled `[get]`
	Returns true if gameObject.activeInHierarchy == true and enabled == true.

PropertyMonoBehaviour	parent `[get, set]`
	The object above in the hierarchy.

virtual JSONNode	parentJson `[get, set]`

Properties inherited from DepictionEngine.MonoBehaviourDisposable
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.

Properties inherited from DepictionEngine.IProperty
SerializableGuid	id `[get]`
	The DepictionEngine.SerializableGuid of the object.

Action< IProperty, string, object, object >	PropertyAssignedEvent `[get, set]`
	Dispatched when a new value as been assigned to a field using the DepictionEngine.PropertyMonoBehaviour.SetValue method.

Additional Inherited Members
Protected Attributes inherited from DepictionEngine.PropertyMonoBehaviour
bool	ignoreGameObjectActiveChange

Member Function Documentation

◆ AddInstanceToManager()

override bool DepictionEngine.LoaderBase.AddInstanceToManager ( )

protectedvirtual

Should this object be added to the DepictionEngine.InstanceManager.

Returns: True of the object should be added.

Reimplemented from DepictionEngine.PropertyMonoBehaviour.

◆ AddPersistent()

bool DepictionEngine.LoaderBase.AddPersistent ( IPersistent persistent )

Implements DepictionEngine.IPersistentList.

◆ EnabledChanged()

override void DepictionEngine.LoaderBase.EnabledChanged	(	bool	newValue,
		bool	oldValue
	)

protectedvirtual

Reimplemented from DepictionEngine.JsonMonoBehaviour.

◆ GetLoadScope() [1/2]

virtual bool DepictionEngine.LoaderBase.GetLoadScope	(	out LoadScope	loadScope,
		IPersistent	persistent
	)

virtual

Returns true if a loadScope is found for the specified DepictionEngine.IPersistent.

Parameters

loadScope
persistent

Returns

Reimplemented in DepictionEngine.IdLoader, and DepictionEngine.Index2DLoaderBase.

◆ GetLoadScope() [2/2]

virtual bool DepictionEngine.LoaderBase.GetLoadScope	(	out LoadScope	loadScope,
		object	loadScopeKey,
		bool	reload = `false`,
		bool	createIfMissing = `false`,
		float	loadInterval = `0::0f`
	)

virtual

Returns true if a loadScope exists or a new one was created.

Parameters

loadScope	Will be set to an existing or new loadScope.
loadScopeKey	The key used to find the loadScope in the dictionary.
loadInterval
reload	If true any pre-existing loadScope will be reloaded before being returned.
createIfMissing	Create a new load scope if none exists.

Returns

Reimplemented in DepictionEngine.IdLoader, and DepictionEngine.Index2DLoaderBase.

◆ InitializeFields()

override void DepictionEngine.LoaderBase.InitializeFields ( InitializationContext initializingContext )

protectedvirtual

Reimplemented from DepictionEngine.PropertyMonoBehaviour.

◆ InitializeLastFields()

override bool DepictionEngine.LoaderBase.InitializeLastFields ( )

protectedvirtual

Reimplemented from DepictionEngine.JsonMonoBehaviour.

◆ InitializeSerializedFields()

override void DepictionEngine.LoaderBase.InitializeSerializedFields ( InitializationContext initializingContext )

protectedvirtual

Initialize SerializedField's to their default values.

Parameters

initializingContext

Reimplemented from DepictionEngine.GeneratorBase.

◆ IterateOverComponentReference()

override void DepictionEngine.LoaderBase.IterateOverComponentReference ( Action< SerializableGuid, Action > callback )

protectedvirtual

Reimplemented from DepictionEngine.GeneratorBase.

◆ IterateOverPersistents()

void DepictionEngine.LoaderBase.IterateOverPersistents ( Func< SerializableGuid, IPersistent, bool > callback )

Implements DepictionEngine.IPersistentList.

◆ LateInitialize()

override bool DepictionEngine.LoaderBase.LateInitialize ( InitializationContext initializingContext )

protectedvirtual

Every other objects are initialized at this point.

Returns

Reimplemented from DepictionEngine.MonoBehaviourDisposable.

◆ LoadAll()

List< LoadScope > DepictionEngine.LoaderBase.LoadAll ( )

Create missing DepictionEngine.LoadScope(s) and dispose those that are no longer required.

Returns

◆ ObjectPropertyAssignedHandler()

override void DepictionEngine.LoaderBase.ObjectPropertyAssignedHandler	(	IProperty	property,
		string	name,
		object	newValue,
		object	oldValue
	)

protectedvirtual

Reimplemented from DepictionEngine.Script.

◆ OnDispose()

override bool DepictionEngine.LoaderBase.OnDispose ( DisposeContext disposeContext )

virtual

This is where you dispose any remaining dependencies.

Parameters

disposeContext The context under which the object is being destroyed.

Returns: False if the object was already disposed otherwise True.

Reimplemented from DepictionEngine.PropertyMonoBehaviour.

◆ PerformAddRemoveLoadScopesChange< T, T1 >()

List<(bool, object, LoadScope)> DepictionEngine.LoaderBase.PerformAddRemoveLoadScopesChange< T, T1 >	(	IDictionary< T, T1 >	loadScopesDictionary,
		IDictionary< T, T1 >	lastLoadScopesDictionary,
		bool	performingUndoRedo = `false`
	)

protected

Type Constraints

T1

:

LoadScope

◆ PostHierarchicalUpdate()

override bool DepictionEngine.LoaderBase.PostHierarchicalUpdate ( )

virtual

Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called after the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.

Reimplemented from DepictionEngine.PropertyMonoBehaviour.

◆ PreHierarchicalUpdate()

override bool DepictionEngine.LoaderBase.PreHierarchicalUpdate ( )

virtual

Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called before the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.

Reimplemented from DepictionEngine.PropertyMonoBehaviour.

◆ Recycle()

override void DepictionEngine.LoaderBase.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.PropertyMonoBehaviour.

◆ ReloadAll()

List< LoadScope > DepictionEngine.LoaderBase.ReloadAll ( )

Internal method, to reload data use the DepictionEngine.DatasourceBase.ReloadAll instead.

Returns

◆ RemovePersistent() [1/2]

bool DepictionEngine.LoaderBase.RemovePersistent	(	IPersistent	persistent,
		DisposeContext	disposeContext = `DisposeContext::Programmatically_Pool`
	)

Implements DepictionEngine.IPersistentList.

◆ RemovePersistent() [2/2]

bool DepictionEngine.LoaderBase.RemovePersistent	(	SerializableGuid	persistentId,
		DisposeContext	disposeContext = `DisposeContext::Programmatically_Pool`
	)

Implements DepictionEngine.IPersistentList.

◆ UpdateAllDelegates()

override bool DepictionEngine.LoaderBase.UpdateAllDelegates ( )

protectedvirtual

Function to initialize event handlers.

Returns

Reimplemented from DepictionEngine.PropertyMonoBehaviour.

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

LoaderBase.cs

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Member Function Documentation

◆ AddInstanceToManager()

◆ AddPersistent()

◆ EnabledChanged()

◆ GetLoadScope() [1/2]

◆ GetLoadScope() [2/2]

◆ InitializeFields()

◆ InitializeLastFields()

◆ InitializeSerializedFields()

◆ IterateOverComponentReference()

◆ IterateOverPersistents()

◆ LateInitialize()

◆ LoadAll()

◆ ObjectPropertyAssignedHandler()

◆ OnDispose()

◆ PerformAddRemoveLoadScopesChange< T, T1 >()

◆ PostHierarchicalUpdate()

◆ PreHierarchicalUpdate()

◆ Recycle()

◆ ReloadAll()

◆ RemovePersistent() [1/2]

◆ RemovePersistent() [2/2]

◆ UpdateAllDelegates()