Visindigo::General::TickObject Class

成员函数文档

[since Visindigo 0.16.0] TickObject::TickObject()

构造函数

这个function 从 Visindigo 0.16.0 开始支持。

[virtual noexcept, since Visindigo 0.16.0] TickObject::~TickObject()

析构函数

这个function 从 Visindigo 0.16.0 开始支持。

[since Visindigo 0.16.0] void TickObject::disableAndDelete()

禁用并删除TickObject。它会先调用disable方法来禁用对象，然后在所在的TickLoop的当前循环结束后才真正删除对象。

如果它当前未启用，则会直接删除对象。

这个function 从 Visindigo 0.16.0 开始支持。

[since Visindigo 0.16.0] void TickObject::disableUpdate()

禁用TickObject，它会从当前TickLoop上卸载，使其停止接收更新调用。

它会在所在的TickLoop的当前循环结束后才真正停止调用，因此即使调用disable，也可能 在短时间内继续接收到更新调用，直到所在的TickLoop完成当前循环为止。

你不能在调用disable后立即重新调用enable，因此此时它仍处于激活状态，重新enable不产生任何效果。

你也不能在调用disble后立即销毁对象，要么手动判断在isEnabled为false时销毁，要么 改用disableAndDelete方法。

这个function 从 Visindigo 0.16.0 开始支持。

[since Visindigo 0.16.0] void TickObject::enableUpdate(Visindigo::General::TickLoop *loop = nullptr)

loop 可选的TickLoop对象，如果为nullptr，则默认为当前线程的TickLoop。

启用TickObject，挂载到目标TickLoop上。如果你不设置loop参数，则默认挂载到当前线程自己的TickLoop上。

如果你需要挂载到其他线程的TickLoop上，请在目标线程中调用enable方法。

如果你要挂载到自己创建的TickLoop上，请直接传入该TickLoop的指针。

调用此函数后，isEnable会开始返回true，但它并不会立即参与到当前的事件循环中，只从下一次循环开始生效。

这个function 从 Visindigo 0.16.0 开始支持。

[since Visindigo 0.16.0] qint64 TickObject::getCurrentMillisecondsSinceEpoch() const

return 当前时间戳，单位为毫秒。

如果TickObject处于启用状态，则返回所在的TickLoop的当前时间戳；否则返回系统当前时间戳。

请参见Visindigo::General::TickLoop::getCurrentMillisecondsSinceEpoch()以了解TickLoop的当前时间戳的定义和使用细节。

这个function 从 Visindigo 0.16.0 开始支持。

[since Visindigo 0.16.0] double TickObject::getFixUpdateInterval() const

return FixUpdate的时间间隔，单位为毫秒。

这个function 从 Visindigo 0.16.0 开始支持。

[since Visindigo 0.16.0] Visindigo::General::TickObject::UpdateType TickObject::getUpdateType() const

return 更新类型。

这个function 从 Visindigo 0.16.0 开始支持。

[since Visindigo 0.16.0] bool TickObject::isEnabled() const

return 是否启用状态。

这个function 从 Visindigo 0.16.0 开始支持。

[virtual, since Visindigo 0.16.0] void TickObject::onFixUpdate(double elapsedTime_ms)

elapsedTime_ms 当前Tick周期的时间增量，单位为毫秒。

每个固定更新周期调用的函数，用户可以通过重写此函数来定义在每个固定Tick周期执行的逻辑。

值得指出的是，在FixUpdate模式下，elapsedTime_ms参数的值可能会根据TickLoop的FixTickTimeoutPolicy设置而有所不同。

你不能假定它一定等于你通过setFixUpdateInterval设置的固定时间间隔，如果你这么假定，则在某些情况下（如应用负载过高时）可能会导致逻辑错误。 如果你利用它进行某些物理计算，则这种错误假定必然影响物理计算的准确性（譬如某些应用会出现非常 经典的在不同帧率下摩擦效果/加速效果不一致的问题）。请参见Visindigo::General::TickLoop的说明以了解更多细节。

这个function 从 Visindigo 0.16.0 开始支持。

[virtual, since Visindigo 0.16.0] void TickObject::onUpdate(double elapsedTime_ms)

elapsedTime_ms 当前Tick周期的时间增量，单位为毫秒。

每个更新周期调用的函数，用户可以通过重写此函数来定义在每个Tick周期执行的逻辑。

这个function 从 Visindigo 0.16.0 开始支持。

[since Visindigo 0.16.0] void TickObject::setFixUpdateInterval(Visindigo::General::TickObject::PresetInterval preset)

preset 预设的固定更新时间间隔。 设置FixUpdate的时间间隔，使用预设的固定更新时间间隔。

这个function 从 Visindigo 0.16.0 开始支持。

[since Visindigo 0.16.0] void TickObject::setFixUpdateInterval(double interval)

interval 固定更新时间间隔，单位为毫秒。

设置FixUpdate的时间间隔。

这个function 从 Visindigo 0.16.0 开始支持。

[since Visindigo 0.16.0] void TickObject::setUpdateType(Visindigo::General::TickObject::UpdateType type)

type 更新类型。

设置更新类型，可以是Update或FixUpdate。

这个function 从 Visindigo 0.16.0 开始支持。