com.simsilica.ethereal

Class SharedObject

java.lang.Object

com.simsilica.ethereal.SharedObject

public class SharedObject
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SharedObject(SharedObjectSpace space, int networkId, java.lang.Long realId)

Method Summary

Modifier and Type	Method and Description
boolean	applyNetworkState(long sequence, ObjectState state, LocalZoneIndex zoneIndex)
ObjectState	getDelta()
java.lang.Long	getEntityId()
int	getNetworkId()
java.lang.Long	getParentId()
long	getVersion()
com.simsilica.mathd.Vec3d	getWorldPosition()
com.simsilica.mathd.Quatd	getWorldRotation()
boolean	isFullyMarkedRemoved() Returns true if the object is fully marked for removal in both the current version and in the baseline (if it exists).
boolean	isMarkedRemoved() Returns true if the current version is marked for removal even if the baseline is not.
boolean	isNotifiedRemoved() Returns true if the client side state receiver has already notified listeners above the markRemoved.
void	markNotifiedRemoved(boolean b) The client side state receiver sets this flag if it has already notified listeners about a removal.
void	markRemoved(long time) Marks this version of the object as removed if the specified time is after the current object's last update time.
boolean	updateBaseline(long sequence, ObjectState state)
boolean	updateState(long time, ZoneKey zone, int zoneId, java.lang.Long parentId, com.simsilica.mathd.Vec3d pos, com.simsilica.mathd.Quatd rot) Updates the current object state with the supplied world state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SharedObject

public SharedObject(SharedObjectSpace space,
                    int networkId,
                    java.lang.Long realId)

Method Detail

getNetworkId

public int getNetworkId()

getEntityId

public java.lang.Long getEntityId()

getParentId

public java.lang.Long getParentId()

getVersion

public long getVersion()

getDelta

public ObjectState getDelta()

getWorldPosition

public com.simsilica.mathd.Vec3d getWorldPosition()

getWorldRotation

public com.simsilica.mathd.Quatd getWorldRotation()

isMarkedRemoved

public boolean isMarkedRemoved()

Returns true if the current version is marked for removal even if the baseline is not.

isFullyMarkedRemoved

public boolean isFullyMarkedRemoved()

Returns true if the object is fully marked for removal in both the current version and in the baseline (if it exists). If the baseline does not exist then this method returns false since we can never fully remove an object until we at least know the client and server share a common baseline.

markRemoved

public void markRemoved(long time)

Marks this version of the object as removed if the specified time is after the current object's last update time.

markNotifiedRemoved

public void markNotifiedRemoved(boolean b)

The client side state receiver sets this flag if it has already notified listeners about a removal. SharedObject will unset it if the object becomes unremoved.

isNotifiedRemoved

public boolean isNotifiedRemoved()

Returns true if the client side state receiver has already notified listeners above the markRemoved.

updateState

public boolean updateState(long time,
                           ZoneKey zone,
                           int zoneId,
                           java.lang.Long parentId,
                           com.simsilica.mathd.Vec3d pos,
                           com.simsilica.mathd.Quatd rot)

Updates the current object state with the supplied world state. This is called on the server as real object history/state is streamed to the shared space.

updateBaseline

public boolean updateBaseline(long sequence,
                              ObjectState state)

applyNetworkState

public boolean applyNetworkState(long sequence,
                                 ObjectState state,
                                 LocalZoneIndex zoneIndex)