pluginbase.Objects.Syncable.Watchers.SmoothSync< T > Class Template Reference

Class to synchronize primitives that support addition and multiplication Smoothing (Interpolation) the result across time. Great for linear interpolation of positions, rotation and other such variable data. More...

Inheritance diagram for pluginbase.Objects.Syncable.Watchers.SmoothSync< T >:

Public Member Functions
	SmoothSync ()
	SmoothSync (T val)
	SmoothSync (T val, TimeSpan period)
void	ClearFactor ()
	Clear the interpolative factor More...
void	Jump (T val)
	Jump to a specific value, over the network, ignoring interpolation More...
Public Member Functions inherited from pluginbase.Objects.Syncable.Watchers.SyncBase< T >
	SyncBase ()
	SyncBase (T val)
override string	ToString ()
sealed override bool	Equals (object obj)
sealed override int	GetHashCode ()

Static Public Member Functions
static implicit	operator T (SmoothSync< T > sync)
Static Public Member Functions inherited from pluginbase.Objects.Syncable.Watchers.SyncBase< T >
static implicit	operator T (SyncBase< T > sync)
static bool	operator== (SyncBase< T > left, T right)
static bool	operator!= (SyncBase< T > left, T right)
static bool	operator== (SyncBase< T > left, SyncBase< T > right)
static bool	operator!= (SyncBase< T > left, SyncBase< T > right)

Protected Member Functions
override void	EncodeTo (System.IO.BinaryWriter writer, EncodeContext context)
override void	DecodeFrom (System.IO.BinaryReader reader, DecodeContext context)
override void	Load (pluginbase.Objects.Libs.Persist.IReadPersistObject obj)
Protected Member Functions inherited from pluginbase.Objects.Syncable.Watchers.SyncBase< T >
override void	EncodeTo (BinaryWriter writer, EncodeContext context)
override void	DecodeFrom (BinaryReader reader, DecodeContext context)
override void	Persist (IPersistObject obj)
override void	Load (IReadPersistObject obj)

Properties
float	Factor [get, set]
	The current factor of which the interpolative multiplcation happens. Can be overriden with a value. To clear override, use ClearFactor() More...
TimeSpan	Period [get, set]
	The length of time over which interpolative smoothing occurs More...
bool	FinishedInterpolating [get]
	Has the interpolation finished More...
T	RawValue [get, set]
	The raw, real-value, of the underlying syncable object, without smoothing More...
T	Value [get, set]
	The smoothed value over time More...

Additional Inherited Members
Protected Attributes inherited from pluginbase.Objects.Syncable.Watchers.SyncBase< T >
T	InternalValue
Static Protected Attributes inherited from pluginbase.Objects.Syncable.Watchers.SyncBase< T >
static readonly IEqualityComparer< T >	Comparer
static readonly string	TypeName

Detailed Description

Class to synchronize primitives that support addition and multiplication Smoothing (Interpolation) the result across time. Great for linear interpolation of positions, rotation and other such variable data.

Can interpolate anything with basic arithmatic expressions (Convert from float, add, subtract, multiply)

Type Constraints

T

:

struct

Constructor & Destructor Documentation

SmoothSync() [1/3]

pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.SmoothSync

(

)

        {
        }

SmoothSync() [2/3]

pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.SmoothSync

(

T

val

)

            :base(val)
        {
            _previous = val;
        }

SmoothSync() [3/3]

pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.SmoothSync	(	T	val,
		TimeSpan	period
	)

            :this(val)
        {
            this.Period = period;
        }

Member Function Documentation

ClearFactor()

void pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.ClearFactor

(

)

Clear the interpolative factor

        {
            _factor = null;
        }

DecodeFrom()

override void pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.DecodeFrom ( System.IO.BinaryReader  reader, DecodeContext  context  )

protected

        {
            T preDecodeVal = this.Value;

            bool jumped = reader.ReadBoolean();
            base.DecodeFrom(reader, context);

            if (!context.Failed)
            {
                if (_jump && !context.Declarative)
                {
                    //Don't listen to network if we're about to jump
                    this.InternalValue = preDecodeVal;
                }
                else
                {
                    if (context.Declarative || jumped)
                    {
                        _previous = this.InternalValue;
                    }
                    else
                    {
                        _previous = preDecodeVal;
                    }

                    if (context.TimeState != null)
                    {
                        _lastUpdate = context.TimeState.CurrentTime;
                    }
                }
            }
        }

EncodeTo()

override void pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.EncodeTo ( System.IO.BinaryWriter  writer, EncodeContext  context  )

protected

        {
            writer.Write(_jump);
            base.EncodeTo(writer, context);

            _jump = false;
        }

Jump()

void pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.Jump

(

T

val

)

Jump to a specific value, over the network, ignoring interpolation

Parameters

val

Value.

        {
            _jump = true;
            this.Value = val;
        }

Load()

override void pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.Load ( pluginbase.Objects.Libs.Persist.IReadPersistObject  obj )

protected

        {
            base.Load(obj);
            _lastUpdate = DateTime.MinValue;
            _previous = this.InternalValue;
        }

operator T()

static implicit pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.operator T ( SmoothSync< T >  sync )

static

        {
            return sync.Value;
        }

Property Documentation

Factor

float pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.Factor

getset

The current factor of which the interpolative multiplcation happens. Can be overriden with a value. To clear override, use ClearFactor()

The factor.

FinishedInterpolating

bool pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.FinishedInterpolating

get

Has the interpolation finished

true if finished interpolating; otherwise, false.

Period

TimeSpan pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.Period

getset

The length of time over which interpolative smoothing occurs

The period.

RawValue

T pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.RawValue

getset

The raw, real-value, of the underlying syncable object, without smoothing

The raw value.

Value

T pluginbase.Objects.Syncable.Watchers.SmoothSync< T >.Value

getset

The smoothed value over time

The value.

---

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

• pluginbase/Objects/Syncable/Watchers/SmoothSync.cs