DepictionEngine.AssetBase Class Reference

Public Types
enum	GridIndexType { None , Index2D , Index3D }
	Different types of indexes. None: No index. Index2D: An index composed of 2 components (x,y). Index3D: An index composed of 3 components (x,y,z).

Public Member Functions
bool	IsGridIndexValid ()
virtual void	SetData (object value, LoaderBase.DataType dataType, InitializationContext initializingContext=InitializationContext.Programmatically)
Public Member Functions inherited from DepictionEngine.PersistentScriptableObject
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.
int	Save ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSaveOperationEvent.
int	Synchronize ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSynchronizeOperationEvent.
int	Delete ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceDeleteOperationEvent.
override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
Public Member Functions inherited from DepictionEngine.JsonScriptableObject
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.
Public Member Functions inherited from DepictionEngine.PropertyScriptableObject
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.
void	ResetId ()
	Resets the Id to DepictionEngine.SerializableGuid.Empty.
override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
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	ResetId ()
	Resets the Id to DepictionEngine.SerializableGuid.Empty.
int	Save ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSaveOperationEvent.
int	Synchronize ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSynchronizeOperationEvent.
int	Delete ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceDeleteOperationEvent.
bool	IsGridIndexValid ()

Protected Member Functions
override bool	InitializeLastFields ()
override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.
virtual byte[]	GetDataBytes (LoaderBase.DataType dataType)
virtual object	GetData ()
override void	Saving (Scene scene, string path)
override bool	UpdateHideFlags ()
virtual object	ProcessDataBytes (byte[] value, LoaderBase.DataType dataType)
void	DataPropertyAssigned ()
virtual void	DataChanged ()
virtual string	GetFileExtension ()
void	DisposeOldDataAndRegisterNewData< T > (T oldData, T newData, InitializationContext initializingContext)
Protected Member Functions inherited from DepictionEngine.PersistentScriptableObject
override bool	AddInstanceToManager ()
	Should this object be added to the DepictionEngine.InstanceManager.
override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.
override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.
override void	Saving (Scene scene, string path)
override bool	UpdateHideFlags ()
virtual bool	GetDefaultDontSaveToScene ()
Protected Member Functions inherited from DepictionEngine.JsonScriptableObject
override void	Initializing ()
	The first step of the initialization process.
override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.
override SerializableGuid	GetId (SerializableGuid id, InitializationContext initializingContext)
Protected Member Functions inherited from DepictionEngine.PropertyScriptableObject
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	InitializeFields (InitializationContext initializingContext)
virtual void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.
virtual bool	AddInstanceToManager ()
	Should this object be added to the DepictionEngine.InstanceManager.
override bool	AddToInstanceManager ()
	Add the object to the DepictionEngine.InstanceManager if possible.
virtual bool	SetValue< T > (string name, T value, ref T valueField, Action< T, T > assignedCallback=null, bool allowAutoDisposeOnOutOfSynchProperty=false)
void	PropertyAssigned< T > (IProperty property, string name, T newValue, T oldValue)
virtual bool	InitializeLastFields ()
Protected Member Functions inherited from DepictionEngine.MultithreadSafeScriptableObject
virtual bool	OnDisposedLocked ()
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 ()

Properties
GridIndexType	gridIndexType [get, set]
	The number of component required by the grid index.
Vector2Int	grid2DDimensions [get, set]
	The horizontal and vertical size of the grid.
Vector2Int	grid2DIndex [get, set]
	The horizontal and vertical index of this asset on the grid.
JSONNode	data [get, set]
	The name of the data file (Read Only).
Properties inherited from DepictionEngine.PersistentScriptableObject
Action< IPersistent, Action >	PersistenceSaveOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their save operation queue.
Action< IPersistent, Action >	PersistenceSynchronizeOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their synchronize operation queue.
Action< IPersistent, Action >	PersistenceDeleteOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their delete operation queue.
new string	name [get, set]
	The name of the object.
float	autoSynchronizeInterval [get, set]
	The interval (in seconds) at which we call the DepictionEngine.IPersistent.Synchronize function. Automatically calling DepictionEngine.IPersistent.Synchronize can be useful to keep objects in synch with a datasource. Set to zero to deactivate.
bool	autoDispose [get, set]
	When enabled the object can be disposed automatically by its datasource if it is no longer required in any loader and does not have any out of synch properties.
bool	dontSaveToScene [get, set]
	When enabled the object will not be saved as part of the Scene.
bool	createPersistentIfMissing [get, set]
	When enabled a new DepictionEngine.IPersistent will be created if none is present in the datasource.
bool	containsCopyrightedMaterial [get]
	Whether or not the object contains data that is copyrighted. If true the object may not be persisted in a Scene or DepictionEngine.Datasource.
Properties inherited from DepictionEngine.JsonScriptableObject
JSONNode	initializationJson [get]
Properties inherited from DepictionEngine.PropertyScriptableObject
Type	type [get]
	The Cass type.
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.
Properties inherited from DepictionEngine.MultithreadSafeScriptableObject
bool	locked [get, set]
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.
Properties inherited from DepictionEngine.IMultithreadSafe
bool	locked [get, set]
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.
Properties inherited from DepictionEngine.IPersistent
bool	autoDispose [get]
bool	dontSaveToScene [get, set]
bool	containsCopyrightedMaterial [get]
bool	createPersistentIfMissing [get]
Action< IPersistent, Action >	PersistenceSaveOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their save operation queue.
Action< IPersistent, Action >	PersistenceSynchronizeOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their synchronize operation queue.
Action< IPersistent, Action >	PersistenceDeleteOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their delete operation queue.
Properties inherited from DepictionEngine.IGrid2DIndex
Vector2Int	grid2DIndex [get]
Vector2Int	grid2DDimensions [get]

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 _)
Static Public Attributes inherited from DepictionEngine.PersistentScriptableObject
const float	DEFAULT_AUTO_SYNCHRONIZE_INTERVAL = 0.0f
const bool	DEFAULT_AUTO_DISPOSE = true
const bool	DEFAULT_DONT_SAVE_TO_SCENE = false

Member Function Documentation

DisposeOldDataAndRegisterNewData< T >()

void DepictionEngine.AssetBase.DisposeOldDataAndRegisterNewData< T > ( T  oldData, T  newData, InitializationContext  initializingContext  )

protected

Type Constraints

T

:

UnityEngine.Object

InitializeLastFields()

override bool DepictionEngine.AssetBase.InitializeLastFields ( )

protectedvirtual

Reimplemented from DepictionEngine.PropertyScriptableObject.

InitializeSerializedFields()

override void DepictionEngine.AssetBase.InitializeSerializedFields ( InitializationContext  initializingContext )

protectedvirtual

Initialize SerializedField's to their default values.

Parameters

initializingContext

Reimplemented from DepictionEngine.PropertyScriptableObject.

Reimplemented in DepictionEngine.Mesh, DepictionEngine.Elevation, and DepictionEngine.Texture.

IsGridIndexValid()

bool DepictionEngine.AssetBase.IsGridIndexValid

(

)

Implements DepictionEngine.IGrid2DIndex.

UpdateHideFlags()

override bool DepictionEngine.AssetBase.UpdateHideFlags ( )

protectedvirtual

Reimplemented from DepictionEngine.ScriptableObjectDisposable.

Property Documentation

grid2DDimensions

Vector2Int DepictionEngine.AssetBase.grid2DDimensions

getset

The horizontal and vertical size of the grid.

Implements DepictionEngine.IGrid2DIndex.

grid2DIndex

Vector2Int DepictionEngine.AssetBase.grid2DIndex

getset

The horizontal and vertical index of this asset on the grid.

Implements DepictionEngine.IGrid2DIndex.

---

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

• AssetBase.cs