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

Classes

class  SynchronizeWebRequestProcessingFunctions
 

Protected Member Functions

override IEnumerator WebRequestDataProcessorFunction (ProcessorOutput data, ProcessorParameters parameters)
 
- Protected Member Functions inherited from DepictionEngine.WebRequestDatasourceOperationBase
override void KillLoading ()
 
virtual UnityWebRequest CreateUnityWebRequest (string uri, int timeout=60, List< string > headers=null, byte[] bodyData=null, HTTPMethod httpMethod=HTTPMethod.Get)
 
virtual IEnumerator WebRequestDataProcessorFunction (ProcessorOutput data, ProcessorParameters parameters)
 
virtual Type InitWebRequestProcessorParametersType ()
 
virtual void InitWebRequestProcessorParameters (ProcessorParameters parameters)
 
- Protected Member Functions inherited from DepictionEngine.DatasourceOperationBase
void OperationDone (OperationDoneResult loadingResults)
 
CreateOperationResult< T > ()
 
CreateResultData< T > ()
 
virtual void KillLoading ()
 
- 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 ()
 

Additional Inherited Members

- Public Types inherited from DepictionEngine.DatasourceOperationBase
enum  LoadingState {
  None , Interval , Loading , Loaded ,
  Failed , Interrupted
}
 The different types of loading state.

None:
Not loading.

Interval:
A delay before the loading.

Loading:
The Loading is ongoing.

Loaded:
The loading as complete.

Failed:
The Loading failed.

Interrupted :
The Loading was interrupted. More...
 
- Public Member Functions inherited from DepictionEngine.WebRequestDatasourceOperationBase
void Init (string uri, int timeout, List< string > headers, byte[] bodyData)
 
override DatasourceOperationBase Execute (Action< bool, OperationResult > operationResultCallback)
 
override bool LoadingWasCompromised ()
 
- Public Member Functions inherited from DepictionEngine.DatasourceOperationBase
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.
 
virtual bool LoadingWasCompromised ()
 
virtual DatasourceOperationBase Execute (Action< bool, OperationResult > operationResultCallback)
 
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)
 
- Static Public Member Functions inherited from DepictionEngine.ScriptableObjectDisposable
static bool operator!= (ScriptableObjectDisposable lhs, Disposable.Null rhs)
 
static bool operator== (ScriptableObjectDisposable lhs, Disposable.Null _)
 
- Protected Types inherited from DepictionEngine.WebRequestDatasourceOperationBase
enum  HTTPMethod {
  Get , GetTexture , Put , Post ,
  Delete
}
 The different types of HTTP method.

Get:
Requests a representation of the specified resource.

GetTexture:
Requests a representation of the specified texture.

Put:
Replaces all current representations of the target resource with the request payload.

Post:
Submits an entity to the specified resource.

Delete:
Deletes the specified resource. More...
 
- Properties inherited from DepictionEngine.WebRequestDatasourceOperationBase
Processor webRequestDataProcessor [get, set]
 
- Properties inherited from DepictionEngine.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< 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.
 

Member Function Documentation

◆ WebRequestDataProcessorFunction()

override IEnumerator DepictionEngine.SynchronizeWebRequestDatasourceOperation.WebRequestDataProcessorFunction ( ProcessorOutput  data,
ProcessorParameters  parameters 
)
protectedvirtual

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