Depiction Engine For Unity 2023.0 (Alpha)
Loading...
Searching...
No Matches
DepictionEngine.PropertyScriptableObject Class Reference

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.
 
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.
 

Protected Member Functions

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

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< IDisposableInitializedEvent [get, set]
 Dispatched after the object as been initialized.
 
Action< IDisposable, DisposeContextDisposedEvent [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< IDisposableInitializedEvent [get, set]
 Dispatched after the object as been initialized.
 
Action< IDisposable, DisposeContextDisposedEvent [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.
 

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 _)
 

Member Function Documentation

◆ AddInstanceToManager()

virtual bool DepictionEngine.PropertyScriptableObject.AddInstanceToManager ( )
protectedvirtual

Should this object be added to the DepictionEngine.InstanceManager.

Returns
True of the object should be added.

Reimplemented in DepictionEngine.PersistentScriptableObject.

◆ AddToInstanceManager()

override bool DepictionEngine.PropertyScriptableObject.AddToInstanceManager ( )
protectedvirtual

Add the object to the DepictionEngine.InstanceManager if possible.

Returns
True if the instance was added successfully.

Reimplemented from DepictionEngine.ScriptableObjectDisposable.

◆ Initialize()

override bool DepictionEngine.PropertyScriptableObject.Initialize ( InitializationContext  initializingContext)
protectedvirtual

The main initialization function.

Parameters
initializingContext
Returns
False if the initialization failed.

Reimplemented from DepictionEngine.ScriptableObjectDisposable.

Reimplemented in DepictionEngine.QuadMesh, and DepictionEngine.PersistentScriptableObject.

◆ InitializeSerializedFields()

virtual void DepictionEngine.PropertyScriptableObject.InitializeSerializedFields ( InitializationContext  initializingContext)
protectedvirtual

Initialize SerializedField's to their default values.

Parameters
initializingContext

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

◆ InitializeUID()

override void DepictionEngine.PropertyScriptableObject.InitializeUID ( InitializationContext  initializingContext)
protectedvirtual

Initializes the object's unique identifiers.

Parameters
initializingContext

Reimplemented from DepictionEngine.ScriptableObjectDisposable.

◆ Initializing()

override void DepictionEngine.PropertyScriptableObject.Initializing ( )
protectedvirtual

The first step of the initialization process.

Reimplemented from DepictionEngine.ScriptableObjectDisposable.

◆ OnDispose()

override bool DepictionEngine.PropertyScriptableObject.OnDispose ( DisposeContext  disposeContext)
virtual

This is where you dispose any remaining dependencies.

Parameters
disposeContextThe context under which the object is being destroyed.
Returns
False if the object was already disposed otherwise True.

Reimplemented from DepictionEngine.MultithreadSafeScriptableObject.

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

◆ Recycle()

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

Reimplemented in DepictionEngine.FeatureMesh, DepictionEngine.Mesh, DepictionEngine.Elevation, and DepictionEngine.PersistentScriptableObject.

◆ ResetId()

void DepictionEngine.PropertyScriptableObject.ResetId ( )

Resets the Id to DepictionEngine.SerializableGuid.Empty.

Implements DepictionEngine.IProperty.

Property Documentation

◆ id

SerializableGuid DepictionEngine.PropertyScriptableObject.id
get

Global unique identifier.

Implements DepictionEngine.IProperty.

◆ PropertyAssignedEvent

Action<IProperty, string, object, object> DepictionEngine.PropertyScriptableObject.PropertyAssignedEvent
getset

Dispatched when a new value as been assigned to a field using the DepictionEngine.PropertyMonoBehaviour.SetValue method.

Implements DepictionEngine.IProperty.


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