ZCom_RSetupMovement< T > Class Template Reference

Inheritance diagram for ZCom_RSetupMovement< T >:

[legend]Collaboration diagram for ZCom_RSetupMovement< T >:

[legend]List of all members.

---

Detailed Description

template<typename T>
class ZCom_RSetupMovement< T >

Parameter class for movement replicators.

Public Member Functions
zFloat	getConstantErrorThreshold () const
	get constant error threshold
zU8	getExtendedFlags () const
	Get extended flags.
zU8	getFlags () const
	Get the flags(ZCOM_REPFLAG_*).
zU8	getInputsizeBits () const
	Get input size bits.
zU8	getInterceptID () const
	Get the interceptor id.
zU32	getInterpolationTime () const
	get interpolation time in msecs
zS16	getMaxDelay () const
	Get maximum delay.
zS16	getMinDelay () const
	Get minimum delay.
ZCOM_TAPI zU8	getRelevantBits () const
	Get relevant bits.
zU8	getRules () const
	Get the rules(ZCOM_REPRULE_*).
void	operator delete (void *_p)
	Overloaded memory operator ensuring that always Zoidcom's delete gets called.
void *	operator new (size_t _size)
	Overloaded memory operator ensuring that always Zoidcom's new gets called.
void	setConstantErrorThreshold (zFloat _threshold)
	set constant error threshold
void	setInputsizeBits (zU8 _inputbits)
	Set amount of bits needed to describe the largest size of the input bitstream in bits.
void	setInterceptID (zU8 _id)
	Set the intercept id.
void	setInterpolationTime (zU32 _time)
	set interpolation time
void	setMaxDelay (zS16 _dly)
	Set maximum delay.
void	setMinDelay (zS16 _dly)
	Set minimum delay.
ZCOM_TAPI void	setRelevantBits (zU8 _bits)
	Set relevant bits.
ZCOM_TAPI	ZCom_RSetupMovement (zU8 _rbits, zU8 _flags, zU8 _rules, zU8 _intercept_id=0, zS16 _mindelay=-1, zS16 _maxdelay=-1)
	constructor
Protected Attributes
zU8	m_flags
zU8	m_intercept_id
	interceptor id, 0 = default
zS16	m_maxdelay
	Maximum delay between updates.
zS16	m_mindelay
	Minimum delay between updates.
zU8	m_relevant_bits
zU8	m_rules

---

Constructor & Destructor Documentation

template<typename T> ZCOM_TAPI ZCom_RSetupMovement< T >::ZCom_RSetupMovement (  zU8  _rbits, zU8  _flags, zU8  _rules, zU8  _intercept_id = 0, zS16  _mindelay = -1, zS16  _maxdelay = -1 )  [inline]

constructor

---

Member Function Documentation

template<typename T> void ZCom_RSetupMovement< T >::setInputsizeBits (  zU8  _inputbits  )  [inline]

Set amount of bits needed to describe the largest size of the input bitstream in bits. Ex.: If the input bitstream has a maximum size of 255 bits, set this value to 8. Attention: Don't change value during operation of replicator.

template<typename T> zU8 ZCom_RSetupMovement< T >::getInputsizeBits (   )  const [inline]

Get input size bits.

template<typename T> zU8 ZCom_RSetupMovement< T >::getExtendedFlags (   )  const [inline]

Get extended flags.

template<typename T> void ZCom_RSetupMovement< T >::setConstantErrorThreshold (  zFloat  _threshold  )  [inline]

set constant error threshold

template<typename T> zFloat ZCom_RSetupMovement< T >::getConstantErrorThreshold (   )  const [inline]

get constant error threshold

template<typename T> zU32 ZCom_RSetupMovement< T >::getInterpolationTime (   )  const [inline]

get interpolation time in msecs

template<typename T> void ZCom_RSetupMovement< T >::setInterpolationTime (  zU32  _time  )  [inline]

set interpolation time

ZCOM_TAPI zU8 ZCom_RSetupNumeric::getRelevantBits (   )  const [inline, inherited]

Get relevant bits.

ZCOM_TAPI void ZCom_RSetupNumeric::setRelevantBits (  zU8  _bits  )  [inline, inherited]

Set relevant bits. Parameters: _bits  New amount of relevant bits. Attention: You should not change this value for an active replicator unless you are 100% certain that all peer replicators do that change, too, before they receive their next update.

zU8 ZCom_ReplicatorSetup::getInterceptID (   )  const [inline, inherited]

Get the interceptor id. Returns: Interceptor id.

void ZCom_ReplicatorSetup::setInterceptID (  zU8  _id  )  [inline, inherited]

Set the intercept id. Parameters: _id  New intercept id. The interceptor id can be used to distinguish different replicators inside an interceptor callback.

zS16 ZCom_ReplicatorSetup::getMinDelay (   )  const [inline, inherited]

Get minimum delay. Returns: Minimum delay.

void ZCom_ReplicatorSetup::setMinDelay (  zS16  _dly  )  [inline, inherited]

Set minimum delay. Parameters: _dly  New minimum delay. Attention: It is not allowed to change these value from -1 to >= 0 once a replicator is actively using this setup. All other changes are allowed.

zS16 ZCom_ReplicatorSetup::getMaxDelay (   )  const [inline, inherited]

Get maximum delay. Returns: Maximum delay.

void ZCom_ReplicatorSetup::setMaxDelay (  zS16  _dly  )  [inline, inherited]

Set maximum delay. Parameters: _dly  New maximum delay. Attention: It is not allowed to change these value from -1 to >= 0 once a replicator is actively using this setup. All other changes are allowed.

zU8 ZCom_ReplicatorSetup::getRules (   )  const [inline, inherited]

Get the rules(ZCOM_REPRULE_*). Returns: Replication rules.

zU8 ZCom_ReplicatorSetup::getFlags (   )  const [inline, inherited]

Get the flags(ZCOM_REPFLAG_*). Returns: Replication flags.

void* ZCom_ReplicatorSetup::operator new (  size_t  _size  )  [inherited]

Overloaded memory operator ensuring that always Zoidcom's new gets called.

void ZCom_ReplicatorSetup::operator delete (  void *  _p  )  [inherited]

Overloaded memory operator ensuring that always Zoidcom's delete gets called.

---

Member Data Documentation

zU8 ZCom_RSetupNumeric::m_relevant_bits [protected, inherited]

The amount of relevant bits for integer types or replicated mantissa bits for float values.

zU8 ZCom_ReplicatorSetup::m_flags [protected, inherited]

Holds replication flags (ZCOM_REPFLAG_*). Never ever modify these during operation.

zU8 ZCom_ReplicatorSetup::m_rules [protected, inherited]

Holds replication rules (ZCOM_REPRULE_*) Never ever modify these during operation.

zU8 ZCom_ReplicatorSetup::m_intercept_id [protected, inherited]

interceptor id, 0 = default

zS16 ZCom_ReplicatorSetup::m_mindelay [protected, inherited]

Minimum delay between updates. It is not allowed to change these value from -1 to >= 0 once a replicator is actively using this setup. All other changes are allowed.

zS16 ZCom_ReplicatorSetup::m_maxdelay [protected, inherited]

Maximum delay between updates. It is not allowed to change these value from -1 to >= 0 once a replicator is actively using this setup. All other changes are allowed.

---