Class RelationEngine

Adapts the Xareus relation engine to the Unity system.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

RelationEngine

UFRelationEngine

Implements

IRelationEngine

Namespace: Xareus.Relations.Unity

Assembly: Xareus.Relations.Unity.dll

Syntax

public class RelationEngine : MonoBehaviour, IRelationEngine

Fields

HideRealizationsInHierarchy

Hide realizations in the editor hierarchy

Declaration

public bool HideRealizationsInHierarchy

Field Value

Type	Description
bool

Instance

The only instance of RelationEngine

Declaration

public static RelationEngine Instance

Field Value

Type	Description
RelationEngine

RealizationCreationRate

Maximum number of realization to create each frame for each request. Only works if UseAutoSmoothRealizationCreation is disabled and a request with a callbkac has been made

Declaration

public int RealizationCreationRate

Field Value

Type	Description
int

UseAutoSmoothRealizationCreation

Creates realizations over multiple framesusing our algorithm

Declaration

public bool UseAutoSmoothRealizationCreation

Field Value

Type	Description
bool

UseSmoothRealizationCreation

Creates realizations over multiple frames

Declaration

[Tooltip("Creation of realizations over multiple frames")]
public bool UseSmoothRealizationCreation

Field Value

Type	Description
bool

Properties

Engine

The wrapper of the relation engine

Declaration

public IEngine Engine { get; }

Property Value

Type	Description
IEngine

IsApplicationStopping

Property that tells if the application is stopping (useful for OnDestroy)

Declaration

public static bool IsApplicationStopping { get; }

Property Value

Type	Description
bool

Ready

Ready

Declaration

public bool Ready { get; }

Property Value

Type	Description
bool

RegisteredObjects

Declaration

public IEnumerable<IObject> RegisteredObjects { get; }

Property Value

Type	Description
IEnumerable<IObject>

RegisteredRelations

Declaration

public IEnumerable<IRelation> RegisteredRelations { get; }

Property Value

Type	Description
IEnumerable<IRelation>

instance

Declaration

[Obsolete("Use Instance instead.")]
public static RelationEngine instance { get; }

Property Value

Type	Description
RelationEngine

Methods

CreateXURealizationsFromRealizations(List<Realization>)

Creates the XURealizations corresponding to the given realizations and returns them

Declaration

public static List<XURealization> CreateXURealizationsFromRealizations(List<Realization> realizations)

Parameters

Type	Name	Description
List<Realization>	realizations	The realizations to create

Returns

Type	Description
List<XURealization>

CreateXURealizationsFromRealizations(List<Realization>, Action<List<XURealization>>)

Declaration

public void CreateXURealizationsFromRealizations(List<Realization> realizationList, Action<List<XURealization>> resultCallback)

Parameters

Type	Name	Description
List<Realization>	realizationList
Action<List<XURealization>>	resultCallback

GetObjects()

Declaration

[Obsolete("Use RegisteredObjects instead")]
public IEnumerable<IObject> GetObjects()

Returns

Type	Description
IEnumerable<IObject>

GetObjects(IEnumerable<ObjectQueryParameters>, Action<List<IObject>>, bool)

Declaration

public void GetObjects(IEnumerable<ObjectQueryParameters> queriesParameters, Action<List<IObject>> resultCallback, bool checkRegistered = true)

Parameters

Type	Name	Description
IEnumerable<ObjectQueryParameters>	queriesParameters
Action<List<IObject>>	resultCallback
bool	checkRegistered

GetObjects(IEnumerable<ObjectQueryParameters>, bool)

Declaration

public List<IObject> GetObjects(IEnumerable<ObjectQueryParameters> queriesParameters, bool checkRegistered = true)

Parameters

Type	Name	Description
IEnumerable<ObjectQueryParameters>	queriesParameters
bool	checkRegistered

Returns

Type	Description
List<IObject>

GetObjects(List<ObjectQueryWithCallback>, bool)

Declaration

public void GetObjects(List<ObjectQueryWithCallback> queriesParametersWithCallbacks, bool checkRegistered = true)

Parameters

Type	Name	Description
List<ObjectQueryWithCallback>	queriesParametersWithCallbacks
bool	checkRegistered

GetObjects(ObjectQueryParameters, Action<List<IObject>>, bool)

Declaration

public void GetObjects(ObjectQueryParameters queryParameters, Action<List<IObject>> resultCallback, bool checkRegistered = true)

Parameters

Type	Name	Description
ObjectQueryParameters	queryParameters
Action<List<IObject>>	resultCallback
bool	checkRegistered

GetObjects(ObjectQueryParameters, bool)

Declaration

public List<IObject> GetObjects(ObjectQueryParameters queryParameters, bool checkRegistered = true)

Parameters

Type	Name	Description
ObjectQueryParameters	queryParameters
bool	checkRegistered

Returns

Type	Description
List<IObject>

GetRealizations(IEnumerable<RealizationQueryParameters>, Action<List<XURealization>>, bool)

Declaration

public void GetRealizations(IEnumerable<RealizationQueryParameters> queriesParameters, Action<List<XURealization>> resultCallback, bool checkRegistered = true)

Parameters

Type	Name	Description
IEnumerable<RealizationQueryParameters>	queriesParameters
Action<List<XURealization>>	resultCallback
bool	checkRegistered

GetRealizations(IEnumerable<RealizationQueryParameters>, bool)

Declaration

public List<XURealization> GetRealizations(IEnumerable<RealizationQueryParameters> queriesParameters, bool checkRegistered = true)

Parameters

Type	Name	Description
IEnumerable<RealizationQueryParameters>	queriesParameters
bool	checkRegistered

Returns

Type	Description
List<XURealization>

GetRealizations(List<RealizationQueryWithCallback>, bool)

Declaration

public void GetRealizations(List<RealizationQueryWithCallback> queriesParametersWithCallbacks, bool checkRegistered = true)

Parameters

Type	Name	Description
List<RealizationQueryWithCallback>	queriesParametersWithCallbacks
bool	checkRegistered

GetRealizations(RealizationQueryParameters, Action<List<XURealization>>, bool)

Declaration

public void GetRealizations(RealizationQueryParameters queryParameters, Action<List<XURealization>> resultCallback, bool checkRegistered = true)

Parameters

Type	Name	Description
RealizationQueryParameters	queryParameters
Action<List<XURealization>>	resultCallback
bool	checkRegistered

GetRealizations(RealizationQueryParameters, bool)

Declaration

public List<XURealization> GetRealizations(RealizationQueryParameters queryParameters, bool checkRegistered = true)

Parameters

Type	Name	Description
RealizationQueryParameters	queryParameters
bool	checkRegistered

Returns

Type	Description
List<XURealization>

GetRelations()

Declaration

[Obsolete("Use RegisteredRelations instead")]
public IEnumerable<IRelation> GetRelations()

Returns

Type	Description
IEnumerable<IRelation>

IsReady()

Declaration

[Obsolete("Use Ready instead.")]
public bool IsReady()

Returns

Type	Description
bool

OnApplicationQuit()

Know when the application is stopping

Declaration

protected void OnApplicationQuit()

Implements

IRelationEngine