Class Binding

Namespace

Coherence.Toolkit.Bindings

Assembly

Coherence.Toolkit.dll

Base class for everything that can be synced over the network. A binding holds the metadata that associates a user-facing unity component with its network replicated coherence component.

public abstract class Binding

Inheritance

object

Binding

Derived

CommandBinding

ValueBinding<T>

Constructors

Binding()

protected Binding()

Binding(Descriptor, Component)

public Binding(Descriptor descriptor, Component unityComponent)

Parameters

descriptor Descriptor

unityComponent Component

Fields

archetypeData

public BindingArchetypeData archetypeData

Field Value

BindingArchetypeData

coherenceSync

public CoherenceSync coherenceSync

Field Value

CoherenceSync

defaultInterpolationPath

public string defaultInterpolationPath

Field Value

string

descriptor

protected Descriptor descriptor

Field Value

Descriptor

genericPoolIndex

protected int genericPoolIndex

Field Value

int

guid

public string guid

Field Value

string

interpolationSettings

[InterpolationPicker]
public InterpolationSettings interpolationSettings

Field Value

InterpolationSettings

isPredicted

[Obsolete("Please use predictionMode instead.")]
public bool isPredicted

Field Value

bool

predictionMode

public PredictionMode predictionMode

Field Value

PredictionMode

routing

public MessageTarget routing

Field Value

MessageTarget

runtimeInterpolationSettings

protected InterpolationSettings runtimeInterpolationSettings

Field Value

InterpolationSettings

unityComponent

public Component unityComponent

Field Value

Component

Properties

BakedSyncScriptCSharpType

public string BakedSyncScriptCSharpType { get; }

Property Value

string

BakedSyncScriptGetter

public virtual string BakedSyncScriptGetter { get; }

Property Value

string

BakedSyncScriptSetter

public virtual string BakedSyncScriptSetter { get; }

Property Value

string

BindingArchetypeData

public BindingArchetypeData BindingArchetypeData { get; }

Property Value

BindingArchetypeData

CoherenceComponentAssemblyName

public virtual string CoherenceComponentAssemblyName { get; }

Property Value

string

CoherenceComponentName

public virtual string CoherenceComponentName { get; }

Property Value

string

CoherenceComponentNamespace

public virtual string CoherenceComponentNamespace { get; }

Property Value

string

CoherenceComponentType

public Type CoherenceComponentType { get; }

Property Value

Type

Descriptor

public Descriptor Descriptor { get; }

Property Value

Descriptor

EmitSchemaComponentDefinition

public virtual bool EmitSchemaComponentDefinition { get; }

Property Value

bool

EnforcesLODingWhenFieldsOverriden

public bool EnforcesLODingWhenFieldsOverriden { get; }

Property Value

bool

FieldMask

public virtual uint FieldMask { get; }

Property Value

uint

FullName

public string FullName { get; }

Property Value

string

IsMethod

public bool IsMethod { get; }

Property Value

bool

IsValid

public bool IsValid { get; }

Property Value

bool

Logger

protected Logger Logger { get; }

Property Value

Logger

MemberNameInComponentData

public virtual string MemberNameInComponentData { get; }

Property Value

string

MemberNameInUnityComponent

public virtual string MemberNameInUnityComponent { get; }

Property Value

string

MonoAssemblyRuntimeType

public Type MonoAssemblyRuntimeType { get; }

Property Value

Type

Name

public string Name { get; }

Property Value

string

OverrideGetter

public virtual bool OverrideGetter { get; }

Property Value

bool

OverrideSetter

public virtual bool OverrideSetter { get; }

Property Value

bool

RuntimeInterpolationSettings

public InterpolationSettings RuntimeInterpolationSettings { get; }

Property Value

InterpolationSettings

SchemaFieldName

public string SchemaFieldName { get; }

Property Value

string

SchemaFieldSimulationFrameName

public string SchemaFieldSimulationFrameName { get; }

Property Value

string

Signature

public virtual string Signature { get; }

Property Value

string

UnityComponent

public Component UnityComponent { get; }

Property Value

Component

UntypedValue

public virtual object UntypedValue { get; }

Property Value

object

Methods

Clone(Component)

public Binding Clone(Component c)

Parameters

c Component

Returns

Binding

CloneTo(Binding)

public virtual void CloneTo(Binding clone)

Parameters

clone Binding

CreateComponentData()

public virtual ICoherenceComponentData CreateComponentData()

Returns

ICoherenceComponentData

Dispose()

public void Dispose()

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override abstract int GetHashCode()

Returns

int

GetMemberInfo()

public virtual MemberInfo GetMemberInfo()

Returns

MemberInfo

Interpolate(double)

public virtual void Interpolate(double time)

Parameters

time double

InvokeValueSyncCallback()

public virtual void InvokeValueSyncCallback()

IsCurrentlyPredicted()

public virtual bool IsCurrentlyPredicted()

Returns

bool

IsDirty(AbsoluteSimulationFrame, out bool, out bool)

public abstract void IsDirty(AbsoluteSimulationFrame simulationFrame, out bool dirty, out bool justStopped)

Parameters

simulationFrame AbsoluteSimulationFrame

dirty bool

justStopped bool

MarkAsReadyToSend()

public abstract void MarkAsReadyToSend()

OnBindingCloned()

protected virtual void OnBindingCloned()

OnConnectedEntityChanged()

public virtual void OnConnectedEntityChanged()

ReceiveComponentData(ICoherenceComponentData, AbsoluteSimulationFrame, Vector3)

public virtual void ReceiveComponentData(ICoherenceComponentData coherenceComponent, AbsoluteSimulationFrame clientFrame, Vector3 floatingOriginDelta)

Parameters

coherenceComponent ICoherenceComponentData

clientFrame AbsoluteSimulationFrame

floatingOriginDelta Vector3

ReceiveSampleFromNetwork<T>(T, bool, AbsoluteSimulationFrame, AbsoluteSimulationFrame)

public void ReceiveSampleFromNetwork<T>(T data, bool stopped, AbsoluteSimulationFrame sampleFrame, AbsoluteSimulationFrame clientFrame)

Parameters

data T

stopped bool

sampleFrame AbsoluteSimulationFrame

clientFrame AbsoluteSimulationFrame

Type Parameters

T

RemoveOutdatedSamples(double)

public virtual void RemoveOutdatedSamples(double time)

Parameters

time double

ResetLastSentData()

public virtual void ResetLastSentData()

SampleValue()

public virtual void SampleValue()

SetToLastSample()

public virtual void SetToLastSample()

ValidateNotBound()

public virtual void ValidateNotBound()

WriteComponentData(ICoherenceComponentData, AbsoluteSimulationFrame)

public virtual ICoherenceComponentData WriteComponentData(ICoherenceComponentData coherenceComponent, AbsoluteSimulationFrame simFrame)

Parameters

coherenceComponent ICoherenceComponentData

simFrame AbsoluteSimulationFrame

Returns

ICoherenceComponentData

Events

OnNetworkSampleReceived

public event Action<object, bool, long> OnNetworkSampleReceived

Event Type

Action<object, bool, long>

See Also

ValueBinding<T>

CommandBinding