//// ObjectDynamic.cpp// libraries/physcis/src//// Created by Seth Alves 2015-6-2// Copyright 2015 High Fidelity, Inc.//// Distributed under the Apache License, Version 2.0.// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html//#include "ObjectDynamic.h"#include <QtCore/QSharedPointer>#include "EntitySimulation.h"#include "PhysicsLogging.h"ObjectDynamic::ObjectDynamic(EntityDynamicType type, const QUuid& id, EntityItemPointer ownerEntity) : EntityDynamicInterface(type, id), _ownerEntity(ownerEntity) {}ObjectDynamic::~ObjectDynamic() {}void ObjectDynamic::remapIDs(QHash<EntityItemID, EntityItemID>& map) { withWriteLock([&]{ if (!_id.isNull()) { // just force our ID to something new -- action IDs don't go into the map _id = QUuid::createUuid(); } if (!_otherID.isNull()) { QHash<EntityItemID, EntityItemID>::iterator iter = map.find(_otherID); if (iter == map.end()) { // not found, add it QUuid oldOtherID = _otherID; _otherID = QUuid::createUuid(); map.insert(oldOtherID, _otherID); } else { _otherID = iter.value(); } } });}qint64 ObjectDynamic::getEntityServerClockSkew() const { auto nodeList = DependencyManager::get<NodeList>(); auto ownerEntity = _ownerEntity.lock(); if (!ownerEntity) { return 0; } const QUuid& entityServerNodeID = ownerEntity->getSourceUUID(); auto entityServerNode = nodeList->nodeWithUUID(entityServerNodeID); if (entityServerNode) { return entityServerNode->getClockSkewUsec(); } return 0;}bool ObjectDynamic::updateArguments(QVariantMap arguments) { bool somethingChanged = false; withWriteLock([&]{ quint64 previousExpires = _expires; QString previousTag = _tag; bool ttlSet = true; float ttl = EntityDynamicInterface::extractFloatArgument("dynamic", arguments, "ttl", ttlSet, false); if (ttlSet) { quint64 now = usecTimestampNow(); _expires = now + (quint64)(ttl * USECS_PER_SECOND); } else { _expires = 0; } bool tagSet = true; QString tag = EntityDynamicInterface::extractStringArgument("dynamic", arguments, "tag", tagSet, false); if (tagSet) { _tag = tag; } else { tag = ""; } if (previousExpires != _expires || previousTag != _tag) { somethingChanged = true; } }); return somethingChanged;}/*@jsdoc * Different entity action types have different arguments: some common to all actions (listed in the table) and some specific * to each {@link Entities.ActionType|ActionType} (linked to below). * * @typedef {object} Entities.ActionArguments * @property {Entities.ActionType} type - The type of action. * @property {string} tag="" - A string that a script can use for its own purposes. * @property {number} ttl=0 - How long the action should exist, in seconds, before it is automatically deleted. A value of * <code>0</code> means that the action should not be deleted. * @property {boolean} isMine=true - <code>true</code> if the action was created during the current client session, * <code>false</code> if it wasn't. <em>Read-only.</em> * @property {boolean} ::no-motion-state - Is present with a value of <code>true</code> when the entity hasn't been registered * with the physics engine yet (e.g., if the action hasn't been properly configured), otherwise the property is * <code>undefined</code>. <em>Read-only.</em> * @property {boolean} ::active - <code>true</code> when the action is modifying the entity's motion, <code>false</code> * otherwise. Is present once the entity has been registered with the physics engine, otherwise the property is * <code>undefined</code>. * <em>Read-only.</em> * @property {Entities.PhysicsMotionType} ::motion-type - How the entity moves with the action. Is present once the entity has * been registered with the physics engine, otherwise the property is <code>undefined</code>. <em>Read-only.</em> * * @comment The different action types have additional arguments as follows: * @see {@link Entities.ActionArguments-FarGrab|ActionArguments-FarGrab} * @see {@link Entities.ActionArguments-Hold|ActionArguments-Hold} * @see {@link Entities.ActionArguments-Offset|ActionArguments-Offset} * @see {@link Entities.ActionArguments-Tractor|ActionArguments-Tractor} * @see {@link Entities.ActionArguments-TravelOriented|ActionArguments-TravelOriented} * @see {@link Entities.ActionArguments-Hinge|ActionArguments-Hinge} * @see {@link Entities.ActionArguments-Slider|ActionArguments-Slider} * @see {@link Entities.ActionArguments-ConeTwist|ActionArguments-ConeTwist} * @see {@link Entities.ActionArguments-BallSocket|ActionArguments-BallSocket} */// Note: The "type" property is set in EntityItem::getActionArguments().QVariantMap ObjectDynamic::getArguments() { QVariantMap arguments; withReadLock([&]{ if (_expires == 0) { arguments["ttl"] = 0.0f; } else { quint64 now = usecTimestampNow(); arguments["ttl"] = (float)(_expires - now) / (float)USECS_PER_SECOND; } arguments["tag"] = _tag; EntityItemPointer entity = _ownerEntity.lock(); if (entity) { ObjectMotionState* motionState = static_cast<ObjectMotionState*>(entity->getPhysicsInfo()); if (motionState) { arguments["::active"] = motionState->isActive(); arguments["::motion-type"] = motionTypeToString(motionState->getMotionType()); } else { arguments["::no-motion-state"] = true; } } arguments["isMine"] = isMine(); }); return arguments;}void ObjectDynamic::removeFromSimulation(EntitySimulationPointer simulation) const { QUuid myID; withReadLock([&]{ myID = _id; }); simulation->removeDynamic(myID);}void ObjectDynamic::setOwnerEntity(const EntityItemPointer ownerEntity) { if (!ownerEntity) { activateBody(); } _ownerEntity = ownerEntity;}EntityItemPointer ObjectDynamic::getEntityByID(EntityItemID entityID) const { EntityItemPointer ownerEntity; withReadLock([&]{ ownerEntity = _ownerEntity.lock(); }); EntityTreeElementPointer element = ownerEntity ? ownerEntity->getElement() : nullptr; EntityTreePointer tree = element ? element->getTree() : nullptr; if (!tree) { return nullptr; } return tree->findEntityByID(entityID);}btRigidBody* ObjectDynamic::getRigidBody() { ObjectMotionState* motionState = nullptr; withReadLock([&]{ auto ownerEntity = _ownerEntity.lock(); if (!ownerEntity) { return; } void* physicsInfo = ownerEntity->getPhysicsInfo(); if (!physicsInfo) { return; } motionState = static_cast<ObjectMotionState*>(physicsInfo); }); if (motionState) { return motionState->getRigidBody(); } return nullptr;}void ObjectDynamic::activateBody(bool forceActivation) { auto rigidBody = getRigidBody(); if (rigidBody) { rigidBody->activate(forceActivation); } else { qCDebug(physics) << "ObjectDynamic::activateBody -- no rigid body" << (void*)rigidBody; }}void ObjectDynamic::forceBodyNonStatic() { auto ownerEntity = _ownerEntity.lock(); if (!ownerEntity) { return; } void* physicsInfo = ownerEntity->getPhysicsInfo(); ObjectMotionState* motionState = static_cast<ObjectMotionState*>(physicsInfo); if (motionState && motionState->getMotionType() == MOTION_TYPE_STATIC) { ownerEntity->flagForMotionStateChange(); }}bool ObjectDynamic::lifetimeIsOver() { if (_expires == 0) { return false; } quint64 now = usecTimestampNow(); if (now >= _expires) { return true; } return false;}quint64 ObjectDynamic::localTimeToServerTime(quint64 timeValue) const { // 0 indicates no expiration if (timeValue == 0) { return 0; } qint64 serverClockSkew = getEntityServerClockSkew(); if (serverClockSkew < 0 && timeValue <= (quint64)(-serverClockSkew)) { return 1; // non-zero but long-expired value to avoid negative roll-over } return timeValue + serverClockSkew;}quint64 ObjectDynamic::serverTimeToLocalTime(quint64 timeValue) const { // 0 indicates no expiration if (timeValue == 0) { return 0; } qint64 serverClockSkew = getEntityServerClockSkew(); if (serverClockSkew > 0 && timeValue <= (quint64)serverClockSkew) { return 1; // non-zero but long-expired value to avoid negative roll-over } return timeValue - serverClockSkew;}btRigidBody* ObjectDynamic::getOtherRigidBody(EntityItemID otherEntityID) { EntityItemPointer otherEntity = getEntityByID(otherEntityID); if (!otherEntity) { return nullptr; } void* otherPhysicsInfo = otherEntity->getPhysicsInfo(); if (!otherPhysicsInfo) { return nullptr; } ObjectMotionState* otherMotionState = static_cast<ObjectMotionState*>(otherPhysicsInfo); if (!otherMotionState) { return nullptr; } return otherMotionState->getRigidBody();}QList<btRigidBody*> ObjectDynamic::getRigidBodies() { QList<btRigidBody*> result; result += getRigidBody(); return result;}SpatiallyNestablePointer ObjectDynamic::getOther() { SpatiallyNestablePointer other; withWriteLock([&]{ if (_otherID == QUuid()) { // no other return; } other = _other.lock(); if (other && other->getID() == _otherID) { // other is already up-to-date return; } if (other) { // we have a pointer to other, but it's wrong other.reset(); _other.reset(); } // we have an other-id but no pointer to other cached QSharedPointer<SpatialParentFinder> parentFinder = DependencyManager::get<SpatialParentFinder>(); if (!parentFinder) { return; } EntityItemPointer ownerEntity = _ownerEntity.lock(); if (!ownerEntity) { return; } bool success; _other = parentFinder->find(_otherID, success, ownerEntity->getParentTree()); if (success) { other = _other.lock(); } }); return other;}
//
// ObjectDynamic.cpp
// libraries/physcis/src
//
// Created by Seth Alves 2015-6-2
// Copyright 2015 High Fidelity, Inc.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
#include "ObjectDynamic.h"
#include <QtCore/QSharedPointer>
#include "EntitySimulation.h"
#include "PhysicsLogging.h"
ObjectDynamic::ObjectDynamic(EntityDynamicType type, const QUuid& id, EntityItemPointer ownerEntity) :
EntityDynamicInterface(type, id),
_ownerEntity(ownerEntity) {
}
ObjectDynamic::~ObjectDynamic() {
}
void ObjectDynamic::remapIDs(QHash<EntityItemID, EntityItemID>& map) {
withWriteLock([&]{
if (!_id.isNull()) {
// just force our ID to something new -- action IDs don't go into the map
_id = QUuid::createUuid();
}
if (!_otherID.isNull()) {
QHash<EntityItemID, EntityItemID>::iterator iter = map.find(_otherID);
if (iter == map.end()) {
// not found, add it
QUuid oldOtherID = _otherID;
_otherID = QUuid::createUuid();
map.insert(oldOtherID, _otherID);
} else {
_otherID = iter.value();
}
}
});
}
qint64 ObjectDynamic::getEntityServerClockSkew() const {
auto nodeList = DependencyManager::get<NodeList>();
auto ownerEntity = _ownerEntity.lock();
if (!ownerEntity) {
return 0;
}
const QUuid& entityServerNodeID = ownerEntity->getSourceUUID();
auto entityServerNode = nodeList->nodeWithUUID(entityServerNodeID);
if (entityServerNode) {
return entityServerNode->getClockSkewUsec();
}
return 0;
}
bool ObjectDynamic::updateArguments(QVariantMap arguments) {
bool somethingChanged = false;
withWriteLock([&]{
quint64 previousExpires = _expires;
QString previousTag = _tag;
bool ttlSet = true;
float ttl = EntityDynamicInterface::extractFloatArgument("dynamic", arguments, "ttl", ttlSet, false);
if (ttlSet) {
quint64 now = usecTimestampNow();
_expires = now + (quint64)(ttl * USECS_PER_SECOND);
} else {
_expires = 0;
}
bool tagSet = true;
QString tag = EntityDynamicInterface::extractStringArgument("dynamic", arguments, "tag", tagSet, false);
if (tagSet) {
_tag = tag;
} else {
tag = "";
}
if (previousExpires != _expires || previousTag != _tag) {
somethingChanged = true;
}
});
return somethingChanged;
}
/*@jsdoc
* Different entity action types have different arguments: some common to all actions (listed in the table) and some specific
* to each {@link Entities.ActionType|ActionType} (linked to below).
*
* @typedef {object} Entities.ActionArguments
* @property {Entities.ActionType} type - The type of action.
* @property {string} tag="" - A string that a script can use for its own purposes.
* @property {number} ttl=0 - How long the action should exist, in seconds, before it is automatically deleted. A value of
* <code>0</code> means that the action should not be deleted.
* @property {boolean} isMine=true - <code>true</code> if the action was created during the current client session,
* <code>false</code> if it wasn't. <em>Read-only.</em>
* @property {boolean} ::no-motion-state - Is present with a value of <code>true</code> when the entity hasn't been registered
* with the physics engine yet (e.g., if the action hasn't been properly configured), otherwise the property is
* <code>undefined</code>. <em>Read-only.</em>
* @property {boolean} ::active - <code>true</code> when the action is modifying the entity's motion, <code>false</code>
* otherwise. Is present once the entity has been registered with the physics engine, otherwise the property is
* <code>undefined</code>.
* <em>Read-only.</em>
* @property {Entities.PhysicsMotionType} ::motion-type - How the entity moves with the action. Is present once the entity has
* been registered with the physics engine, otherwise the property is <code>undefined</code>. <em>Read-only.</em>
*
* @comment The different action types have additional arguments as follows:
* @see {@link Entities.ActionArguments-FarGrab|ActionArguments-FarGrab}
* @see {@link Entities.ActionArguments-Hold|ActionArguments-Hold}
* @see {@link Entities.ActionArguments-Offset|ActionArguments-Offset}
* @see {@link Entities.ActionArguments-Tractor|ActionArguments-Tractor}
* @see {@link Entities.ActionArguments-TravelOriented|ActionArguments-TravelOriented}
* @see {@link Entities.ActionArguments-Hinge|ActionArguments-Hinge}
* @see {@link Entities.ActionArguments-Slider|ActionArguments-Slider}
* @see {@link Entities.ActionArguments-ConeTwist|ActionArguments-ConeTwist}
* @see {@link Entities.ActionArguments-BallSocket|ActionArguments-BallSocket}
*/
// Note: The "type" property is set in EntityItem::getActionArguments().
QVariantMap ObjectDynamic::getArguments() {
QVariantMap arguments;
withReadLock([&]{
if (_expires == 0) {
arguments["ttl"] = 0.0f;
} else {
quint64 now = usecTimestampNow();
arguments["ttl"] = (float)(_expires - now) / (float)USECS_PER_SECOND;
}
arguments["tag"] = _tag;
EntityItemPointer entity = _ownerEntity.lock();
if (entity) {
ObjectMotionState* motionState = static_cast<ObjectMotionState*>(entity->getPhysicsInfo());
if (motionState) {
arguments["::active"] = motionState->isActive();
arguments["::motion-type"] = motionTypeToString(motionState->getMotionType());
} else {
arguments["::no-motion-state"] = true;
}
}
arguments["isMine"] = isMine();
});
return arguments;
}
void ObjectDynamic::removeFromSimulation(EntitySimulationPointer simulation) const {
QUuid myID;
withReadLock([&]{
myID = _id;
});
simulation->removeDynamic(myID);
}
void ObjectDynamic::setOwnerEntity(const EntityItemPointer ownerEntity) {
if (!ownerEntity) {
activateBody();
}
_ownerEntity = ownerEntity;
}
EntityItemPointer ObjectDynamic::getEntityByID(EntityItemID entityID) const {
EntityItemPointer ownerEntity;
withReadLock([&]{
ownerEntity = _ownerEntity.lock();
});
EntityTreeElementPointer element = ownerEntity ? ownerEntity->getElement() : nullptr;
EntityTreePointer tree = element ? element->getTree() : nullptr;
if (!tree) {
return nullptr;
}
return tree->findEntityByID(entityID);
}
btRigidBody* ObjectDynamic::getRigidBody() {
ObjectMotionState* motionState = nullptr;
withReadLock([&]{
auto ownerEntity = _ownerEntity.lock();
if (!ownerEntity) {
return;
}
void* physicsInfo = ownerEntity->getPhysicsInfo();
if (!physicsInfo) {
return;
}
motionState = static_cast<ObjectMotionState*>(physicsInfo);
});
if (motionState) {
return motionState->getRigidBody();
}
return nullptr;
}
void ObjectDynamic::activateBody(bool forceActivation) {
auto rigidBody = getRigidBody();
if (rigidBody) {
rigidBody->activate(forceActivation);
} else {
qCDebug(physics) << "ObjectDynamic::activateBody -- no rigid body" << (void*)rigidBody;
}
}
void ObjectDynamic::forceBodyNonStatic() {
auto ownerEntity = _ownerEntity.lock();
if (!ownerEntity) {
return;
}
void* physicsInfo = ownerEntity->getPhysicsInfo();
ObjectMotionState* motionState = static_cast<ObjectMotionState*>(physicsInfo);
if (motionState && motionState->getMotionType() == MOTION_TYPE_STATIC) {
ownerEntity->flagForMotionStateChange();
}
}
bool ObjectDynamic::lifetimeIsOver() {
if (_expires == 0) {
return false;
}
quint64 now = usecTimestampNow();
if (now >= _expires) {
return true;
}
return false;
}
quint64 ObjectDynamic::localTimeToServerTime(quint64 timeValue) const {
// 0 indicates no expiration
if (timeValue == 0) {
return 0;
}
qint64 serverClockSkew = getEntityServerClockSkew();
if (serverClockSkew < 0 && timeValue <= (quint64)(-serverClockSkew)) {
return 1; // non-zero but long-expired value to avoid negative roll-over
}
return timeValue + serverClockSkew;
}
quint64 ObjectDynamic::serverTimeToLocalTime(quint64 timeValue) const {
// 0 indicates no expiration
if (timeValue == 0) {
return 0;
}
qint64 serverClockSkew = getEntityServerClockSkew();
if (serverClockSkew > 0 && timeValue <= (quint64)serverClockSkew) {
return 1; // non-zero but long-expired value to avoid negative roll-over
}
return timeValue - serverClockSkew;
}
btRigidBody* ObjectDynamic::getOtherRigidBody(EntityItemID otherEntityID) {
EntityItemPointer otherEntity = getEntityByID(otherEntityID);
if (!otherEntity) {
return nullptr;
}
void* otherPhysicsInfo = otherEntity->getPhysicsInfo();
if (!otherPhysicsInfo) {
return nullptr;
}
ObjectMotionState* otherMotionState = static_cast<ObjectMotionState*>(otherPhysicsInfo);
if (!otherMotionState) {
return nullptr;
}
return otherMotionState->getRigidBody();
}
QList<btRigidBody*> ObjectDynamic::getRigidBodies() {
QList<btRigidBody*> result;
result += getRigidBody();
return result;
}
SpatiallyNestablePointer ObjectDynamic::getOther() {
SpatiallyNestablePointer other;
withWriteLock([&]{
if (_otherID == QUuid()) {
// no other
return;
}
other = _other.lock();
if (other && other->getID() == _otherID) {
// other is already up-to-date
return;
}
if (other) {
// we have a pointer to other, but it's wrong
other.reset();
_other.reset();
}
// we have an other-id but no pointer to other cached
QSharedPointer<SpatialParentFinder> parentFinder = DependencyManager::get<SpatialParentFinder>();
if (!parentFinder) {
return;
}
EntityItemPointer ownerEntity = _ownerEntity.lock();
if (!ownerEntity) {
return;
}
bool success;
_other = parentFinder->find(_otherID, success, ownerEntity->getParentTree());
if (success) {
other = _other.lock();
}
});
return other;
}