mirror of
https://github.com/overte-org/overte.git
synced 2025-07-15 11:36:46 +02:00
484 lines
No EOL
19 KiB
C++
484 lines
No EOL
19 KiB
C++
//
|
|
// BoxEntityItem.cpp
|
|
// libraries/entities/src
|
|
//
|
|
// Created by Brad Hefta-Gaub on 12/4/13.
|
|
// Copyright 2013 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 <QDebug>
|
|
|
|
#include <ByteCountCoding.h>
|
|
|
|
#include "EntityTree.h"
|
|
#include "EntityTreeElement.h"
|
|
#include "BoxEntityItem.h"
|
|
|
|
|
|
//static bool registerBox = EntityTypes::registerEntityType(EntityTypes::Box, "Box", BoxEntityItem::factory);
|
|
|
|
|
|
EntityItem* BoxEntityItem::factory(const EntityItemID& entityID, const EntityItemProperties& properties) {
|
|
qDebug() << "BoxEntityItem::factory(const EntityItemID& entityItemID, const EntityItemProperties& properties)...";
|
|
return new BoxEntityItem(entityID, properties);
|
|
}
|
|
|
|
// our non-pure virtual subclass for now...
|
|
BoxEntityItem::BoxEntityItem(const EntityItemID& entityItemID, const EntityItemProperties& properties) :
|
|
EntityItem(entityItemID, properties)
|
|
{
|
|
qDebug() << "BoxEntityItem::BoxEntityItem(const EntityItemID& entityItemID, const EntityItemProperties& properties)...";
|
|
_type = EntityTypes::Box;
|
|
|
|
qDebug() << "BoxEntityItem::BoxEntityItem() properties.getModelURL()=" << properties.getModelURL();
|
|
|
|
qDebug() << "BoxEntityItem::BoxEntityItem() calling setProperties()";
|
|
setProperties(properties);
|
|
|
|
|
|
}
|
|
|
|
EntityItemProperties BoxEntityItem::getProperties() const {
|
|
qDebug() << "BoxEntityItem::getProperties()... <<<<<<<<<<<<<<<< <<<<<<<<<<<<<<<<<<<<<<<<<";
|
|
|
|
EntityItemProperties properties = EntityItem::getProperties(); // get the properties from our base class
|
|
|
|
properties._color = getXColor();
|
|
properties._colorChanged = false;
|
|
|
|
properties._glowLevel = getGlowLevel();
|
|
properties._glowLevelChanged = false;
|
|
|
|
return properties;
|
|
}
|
|
|
|
void BoxEntityItem::setProperties(const EntityItemProperties& properties, bool forceCopy) {
|
|
qDebug() << "BoxEntityItem::setProperties()...";
|
|
qDebug() << "BoxEntityItem::BoxEntityItem() properties.getModelURL()=" << properties.getModelURL();
|
|
bool somethingChanged = false;
|
|
|
|
EntityItem::setProperties(properties, forceCopy); // set the properties in our base class
|
|
|
|
if (properties._colorChanged || forceCopy) {
|
|
setColor(properties._color);
|
|
somethingChanged = true;
|
|
}
|
|
|
|
if (properties._glowLevelChanged || forceCopy) {
|
|
setGlowLevel(properties._glowLevel);
|
|
somethingChanged = true;
|
|
}
|
|
|
|
if (somethingChanged) {
|
|
bool wantDebug = false;
|
|
if (wantDebug) {
|
|
uint64_t now = usecTimestampNow();
|
|
int elapsed = now - _lastEdited;
|
|
qDebug() << "BoxEntityItem::setProperties() AFTER update... edited AGO=" << elapsed <<
|
|
"now=" << now << " _lastEdited=" << _lastEdited;
|
|
}
|
|
setLastEdited(properties._lastEdited);
|
|
}
|
|
}
|
|
|
|
|
|
|
|
int BoxEntityItem::readEntityDataFromBuffer(const unsigned char* data, int bytesLeftToRead, ReadBitstreamToTreeParams& args) {
|
|
|
|
|
|
qDebug() << "BoxEntityItem::readEntityDataFromBuffer()... <<<<<<<<<<<<<<<< <<<<<<<<<<<<<<<<<<<<<<<<<";
|
|
|
|
// Header bytes
|
|
// object ID [16 bytes]
|
|
// ByteCountCoded(type code) [~1 byte]
|
|
// last edited [8 bytes]
|
|
// ByteCountCoded(last_edited to last_updated delta) [~1-8 bytes]
|
|
// PropertyFlags<>( everything ) [1-2 bytes]
|
|
// ~27-35 bytes...
|
|
const int MINIMUM_HEADER_BYTES = 27; // TODO: this is not correct, we don't yet have 16 byte IDs
|
|
|
|
int bytesRead = 0;
|
|
if (bytesLeftToRead >= MINIMUM_HEADER_BYTES) {
|
|
|
|
int originalLength = bytesLeftToRead;
|
|
QByteArray originalDataBuffer((const char*)data, originalLength);
|
|
|
|
int clockSkew = args.sourceNode ? args.sourceNode->getClockSkewUsec() : 0;
|
|
|
|
const unsigned char* dataAt = data;
|
|
|
|
// id
|
|
QByteArray encodedID = originalDataBuffer.mid(bytesRead); // maximum possible size
|
|
ByteCountCoded<quint32> idCoder = encodedID;
|
|
encodedID = idCoder; // determine true length
|
|
dataAt += encodedID.size();
|
|
bytesRead += encodedID.size();
|
|
_id = idCoder;
|
|
_creatorTokenID = UNKNOWN_ENTITY_TOKEN; // if we know the id, then we don't care about the creator token
|
|
_newlyCreated = false;
|
|
|
|
// type
|
|
QByteArray encodedType = originalDataBuffer.mid(bytesRead); // maximum possible size
|
|
ByteCountCoded<quint32> typeCoder = encodedType;
|
|
encodedType = typeCoder; // determine true length
|
|
dataAt += encodedType.size();
|
|
bytesRead += encodedType.size();
|
|
quint32 type = typeCoder;
|
|
_type = (EntityTypes::EntityType_t)type;
|
|
|
|
// XXXBHG: is this a good place to handle the last edited time client vs server??
|
|
|
|
// If the edit time encoded in the packet is NEWER than our known edit time...
|
|
// then we WANT to over-write our local data.
|
|
// If the edit time encoded in the packet is OLDER than our known edit time...
|
|
// then we WANT to preserve our local data. (NOTE: what if I change color, and you change position?? last one wins!)
|
|
|
|
bool overwriteLocalData = true; // assume the new content overwrites our local data
|
|
|
|
quint64 lastEditedFromBuffer = 0;
|
|
|
|
// _lastEdited
|
|
memcpy(&lastEditedFromBuffer, dataAt, sizeof(lastEditedFromBuffer));
|
|
dataAt += sizeof(lastEditedFromBuffer);
|
|
bytesRead += sizeof(lastEditedFromBuffer);
|
|
lastEditedFromBuffer -= clockSkew;
|
|
|
|
// If we've changed our local tree more recently than the new data from this packet
|
|
// then we will not be changing our values, instead we just read and skip the data
|
|
if (_lastEdited > lastEditedFromBuffer) {
|
|
overwriteLocalData = false;
|
|
qDebug() << "IGNORING old data from server!!! **************** _lastEdited=" << _lastEdited
|
|
<< "lastEditedFromBuffer=" << lastEditedFromBuffer << "now=" << usecTimestampNow();
|
|
} else {
|
|
|
|
qDebug() << "USING NEW data from server!!! **************** OLD _lastEdited=" << _lastEdited
|
|
<< "lastEditedFromBuffer=" << lastEditedFromBuffer << "now=" << usecTimestampNow();
|
|
|
|
_lastEdited = lastEditedFromBuffer;
|
|
}
|
|
|
|
// last updated is stored as ByteCountCoded delta from lastEdited
|
|
QByteArray encodedUpdateDelta = originalDataBuffer.mid(bytesRead); // maximum possible size
|
|
ByteCountCoded<quint64> updateDeltaCoder = encodedUpdateDelta;
|
|
quint64 updateDelta = updateDeltaCoder;
|
|
if (overwriteLocalData) {
|
|
_lastUpdated = _lastEdited + updateDelta; // don't adjust for clock skew since we already did that for _lastEdited
|
|
}
|
|
encodedUpdateDelta = updateDeltaCoder; // determine true length
|
|
dataAt += encodedUpdateDelta.size();
|
|
bytesRead += encodedUpdateDelta.size();
|
|
|
|
// Property Flags
|
|
QByteArray encodedPropertyFlags = originalDataBuffer.mid(bytesRead); // maximum possible size
|
|
EntityPropertyFlags propertyFlags = encodedPropertyFlags;
|
|
dataAt += propertyFlags.getEncodedLength();
|
|
bytesRead += propertyFlags.getEncodedLength();
|
|
|
|
// PROP_POSITION
|
|
if (propertyFlags.getHasProperty(PROP_POSITION)) {
|
|
glm::vec3 positionFromBuffer;
|
|
memcpy(&positionFromBuffer, dataAt, sizeof(positionFromBuffer));
|
|
dataAt += sizeof(positionFromBuffer);
|
|
bytesRead += sizeof(positionFromBuffer);
|
|
if (overwriteLocalData) {
|
|
_position = positionFromBuffer;
|
|
}
|
|
}
|
|
|
|
// PROP_RADIUS
|
|
if (propertyFlags.getHasProperty(PROP_RADIUS)) {
|
|
float radiusFromBuffer;
|
|
memcpy(&radiusFromBuffer, dataAt, sizeof(radiusFromBuffer));
|
|
dataAt += sizeof(radiusFromBuffer);
|
|
bytesRead += sizeof(radiusFromBuffer);
|
|
if (overwriteLocalData) {
|
|
_radius = radiusFromBuffer;
|
|
}
|
|
}
|
|
|
|
// PROP_ROTATION
|
|
if (propertyFlags.getHasProperty(PROP_ROTATION)) {
|
|
glm::quat rotation;
|
|
int bytes = unpackOrientationQuatFromBytes(dataAt, rotation);
|
|
dataAt += bytes;
|
|
bytesRead += bytes;
|
|
if (overwriteLocalData) {
|
|
_rotation = rotation;
|
|
}
|
|
}
|
|
|
|
// PROP_SHOULD_BE_DELETED
|
|
if (propertyFlags.getHasProperty(PROP_SHOULD_BE_DELETED)) {
|
|
bool shouldBeDeleted;
|
|
memcpy(&shouldBeDeleted, dataAt, sizeof(shouldBeDeleted));
|
|
dataAt += sizeof(shouldBeDeleted);
|
|
bytesRead += sizeof(shouldBeDeleted);
|
|
if (overwriteLocalData) {
|
|
_shouldBeDeleted = shouldBeDeleted;
|
|
}
|
|
}
|
|
|
|
// PROP_SCRIPT
|
|
// script would go here...
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// TODO: only handle these subclass items here, use the base class for the rest...
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
// PROP_COLOR
|
|
if (propertyFlags.getHasProperty(PROP_COLOR)) {
|
|
rgbColor color;
|
|
if (overwriteLocalData) {
|
|
memcpy(_color, dataAt, sizeof(_color));
|
|
}
|
|
dataAt += sizeof(color);
|
|
bytesRead += sizeof(color);
|
|
}
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
}
|
|
return bytesRead;
|
|
}
|
|
|
|
|
|
OctreeElement::AppendState BoxEntityItem::appendEntityData(OctreePacketData* packetData, EncodeBitstreamParams& params,
|
|
EntityTreeElementExtraEncodeData* modelTreeElementExtraEncodeData) const {
|
|
|
|
|
|
|
|
qDebug() << "BoxEntityItem::appendEntityData()... ********************************************";
|
|
|
|
// ALL this fits...
|
|
// object ID [16 bytes]
|
|
// ByteCountCoded(type code) [~1 byte]
|
|
// last edited [8 bytes]
|
|
// ByteCountCoded(last_edited to last_updated delta) [~1-8 bytes]
|
|
// PropertyFlags<>( everything ) [1-2 bytes]
|
|
// ~27-35 bytes...
|
|
|
|
OctreeElement::AppendState appendState = OctreeElement::COMPLETED; // assume the best
|
|
|
|
// encode our ID as a byte count coded byte stream
|
|
ByteCountCoded<quint32> idCoder = getID();
|
|
QByteArray encodedID = idCoder;
|
|
|
|
// encode our type as a byte count coded byte stream
|
|
|
|
EntityTypes::EntityType_t type = getType();
|
|
qDebug() << "BoxEntityItem::appendEntityData()... type=" << type;
|
|
|
|
|
|
ByteCountCoded<quint32> typeCoder = type;
|
|
QByteArray encodedType = typeCoder;
|
|
|
|
quint64 updateDelta = getLastUpdated() <= getLastEdited() ? 0 : getLastUpdated() - getLastEdited();
|
|
ByteCountCoded<quint64> updateDeltaCoder = updateDelta;
|
|
QByteArray encodedUpdateDelta = updateDeltaCoder;
|
|
EntityPropertyFlags propertyFlags(PROP_LAST_ITEM);
|
|
EntityPropertyFlags requestedProperties;
|
|
|
|
requestedProperties += PROP_POSITION;
|
|
requestedProperties += PROP_RADIUS;
|
|
requestedProperties += PROP_ROTATION;
|
|
requestedProperties += PROP_COLOR;
|
|
requestedProperties += PROP_SHOULD_BE_DELETED;
|
|
|
|
EntityPropertyFlags propertiesDidntFit = requestedProperties;
|
|
|
|
// If we are being called for a subsequent pass at appendEntityData() that failed to completely encode this item,
|
|
// then our modelTreeElementExtraEncodeData should include data about which properties we need to append.
|
|
if (modelTreeElementExtraEncodeData && modelTreeElementExtraEncodeData->includedItems.contains(getEntityItemID())) {
|
|
requestedProperties = modelTreeElementExtraEncodeData->includedItems.value(getEntityItemID());
|
|
}
|
|
|
|
//qDebug() << "requestedProperties=";
|
|
//requestedProperties.debugDumpBits();
|
|
|
|
LevelDetails modelLevel = packetData->startLevel();
|
|
|
|
bool successIDFits = packetData->appendValue(encodedID);
|
|
bool successTypeFits = packetData->appendValue(encodedType);
|
|
|
|
quint64 lastEdited = getLastEdited();
|
|
qDebug() << "BoxEntityItem::appendEntityData() ... lastEdited=" << lastEdited;
|
|
|
|
bool successLastEditedFits = packetData->appendValue(lastEdited);
|
|
bool successLastUpdatedFits = packetData->appendValue(encodedUpdateDelta);
|
|
|
|
int propertyFlagsOffset = packetData->getUncompressedByteOffset();
|
|
QByteArray encodedPropertyFlags = propertyFlags;
|
|
int oldPropertyFlagsLength = encodedPropertyFlags.length();
|
|
bool successPropertyFlagsFits = packetData->appendValue(encodedPropertyFlags);
|
|
int propertyCount = 0;
|
|
|
|
bool headerFits = successIDFits && successTypeFits && successLastEditedFits
|
|
&& successLastUpdatedFits && successPropertyFlagsFits;
|
|
|
|
int startOfEntityItemData = packetData->getUncompressedByteOffset();
|
|
|
|
if (headerFits) {
|
|
bool successPropertyFits;
|
|
|
|
propertyFlags -= PROP_LAST_ITEM; // clear the last item for now, we may or may not set it as the actual item
|
|
|
|
// These items would go here once supported....
|
|
// PROP_PAGED_PROPERTY,
|
|
// PROP_CUSTOM_PROPERTIES_INCLUDED,
|
|
// PROP_VISIBLE,
|
|
|
|
// PROP_POSITION
|
|
if (requestedProperties.getHasProperty(PROP_POSITION)) {
|
|
//qDebug() << "PROP_POSITION requested...";
|
|
LevelDetails propertyLevel = packetData->startLevel();
|
|
successPropertyFits = packetData->appendPosition(getPosition());
|
|
if (successPropertyFits) {
|
|
propertyFlags |= PROP_POSITION;
|
|
propertiesDidntFit -= PROP_POSITION;
|
|
propertyCount++;
|
|
packetData->endLevel(propertyLevel);
|
|
} else {
|
|
//qDebug() << "PROP_POSITION didn't fit...";
|
|
packetData->discardLevel(propertyLevel);
|
|
appendState = OctreeElement::PARTIAL;
|
|
}
|
|
} else {
|
|
//qDebug() << "PROP_POSITION NOT requested...";
|
|
propertiesDidntFit -= PROP_POSITION;
|
|
}
|
|
|
|
// PROP_RADIUS
|
|
if (requestedProperties.getHasProperty(PROP_RADIUS)) {
|
|
//qDebug() << "PROP_RADIUS requested...";
|
|
LevelDetails propertyLevel = packetData->startLevel();
|
|
successPropertyFits = packetData->appendValue(getRadius());
|
|
if (successPropertyFits) {
|
|
propertyFlags |= PROP_RADIUS;
|
|
propertiesDidntFit -= PROP_RADIUS;
|
|
propertyCount++;
|
|
packetData->endLevel(propertyLevel);
|
|
} else {
|
|
//qDebug() << "PROP_RADIUS didn't fit...";
|
|
packetData->discardLevel(propertyLevel);
|
|
appendState = OctreeElement::PARTIAL;
|
|
}
|
|
} else {
|
|
//qDebug() << "PROP_RADIUS NOT requested...";
|
|
propertiesDidntFit -= PROP_RADIUS;
|
|
}
|
|
|
|
// PROP_ROTATION
|
|
if (requestedProperties.getHasProperty(PROP_ROTATION)) {
|
|
//qDebug() << "PROP_ROTATION requested...";
|
|
LevelDetails propertyLevel = packetData->startLevel();
|
|
successPropertyFits = packetData->appendValue(getRotation());
|
|
if (successPropertyFits) {
|
|
propertyFlags |= PROP_ROTATION;
|
|
propertiesDidntFit -= PROP_ROTATION;
|
|
propertyCount++;
|
|
packetData->endLevel(propertyLevel);
|
|
} else {
|
|
//qDebug() << "PROP_ROTATION didn't fit...";
|
|
packetData->discardLevel(propertyLevel);
|
|
appendState = OctreeElement::PARTIAL;
|
|
}
|
|
} else {
|
|
//qDebug() << "PROP_ROTATION NOT requested...";
|
|
propertiesDidntFit -= PROP_ROTATION;
|
|
}
|
|
|
|
// PROP_SHOULD_BE_DELETED
|
|
if (requestedProperties.getHasProperty(PROP_SHOULD_BE_DELETED)) {
|
|
//qDebug() << "PROP_SHOULD_BE_DELETED requested...";
|
|
LevelDetails propertyLevel = packetData->startLevel();
|
|
successPropertyFits = packetData->appendValue(getShouldBeDeleted());
|
|
if (successPropertyFits) {
|
|
propertyFlags |= PROP_SHOULD_BE_DELETED;
|
|
propertiesDidntFit -= PROP_SHOULD_BE_DELETED;
|
|
propertyCount++;
|
|
packetData->endLevel(propertyLevel);
|
|
} else {
|
|
//qDebug() << "PROP_SHOULD_BE_DELETED didn't fit...";
|
|
packetData->discardLevel(propertyLevel);
|
|
appendState = OctreeElement::PARTIAL;
|
|
}
|
|
} else {
|
|
//qDebug() << "PROP_SHOULD_BE_DELETED NOT requested...";
|
|
propertiesDidntFit -= PROP_SHOULD_BE_DELETED;
|
|
}
|
|
|
|
// PROP_SCRIPT
|
|
// script would go here...
|
|
|
|
|
|
// PROP_COLOR
|
|
if (requestedProperties.getHasProperty(PROP_COLOR)) {
|
|
//qDebug() << "PROP_COLOR requested...";
|
|
LevelDetails propertyLevel = packetData->startLevel();
|
|
successPropertyFits = packetData->appendColor(getColor());
|
|
if (successPropertyFits) {
|
|
propertyFlags |= PROP_COLOR;
|
|
propertiesDidntFit -= PROP_COLOR;
|
|
propertyCount++;
|
|
packetData->endLevel(propertyLevel);
|
|
} else {
|
|
//qDebug() << "PROP_COLOR didn't fit...";
|
|
packetData->discardLevel(propertyLevel);
|
|
appendState = OctreeElement::PARTIAL;
|
|
}
|
|
} else {
|
|
//qDebug() << "PROP_COLOR NOT requested...";
|
|
propertiesDidntFit -= PROP_COLOR;
|
|
}
|
|
}
|
|
if (propertyCount > 0) {
|
|
int endOfEntityItemData = packetData->getUncompressedByteOffset();
|
|
|
|
encodedPropertyFlags = propertyFlags;
|
|
int newPropertyFlagsLength = encodedPropertyFlags.length();
|
|
packetData->updatePriorBytes(propertyFlagsOffset,
|
|
(const unsigned char*)encodedPropertyFlags.constData(), encodedPropertyFlags.length());
|
|
|
|
// if the size of the PropertyFlags shrunk, we need to shift everything down to front of packet.
|
|
if (newPropertyFlagsLength < oldPropertyFlagsLength) {
|
|
int oldSize = packetData->getUncompressedSize();
|
|
|
|
const unsigned char* modelItemData = packetData->getUncompressedData(propertyFlagsOffset + oldPropertyFlagsLength);
|
|
int modelItemDataLength = endOfEntityItemData - startOfEntityItemData;
|
|
int newEntityItemDataStart = propertyFlagsOffset + newPropertyFlagsLength;
|
|
packetData->updatePriorBytes(newEntityItemDataStart, modelItemData, modelItemDataLength);
|
|
|
|
int newSize = oldSize - (oldPropertyFlagsLength - newPropertyFlagsLength);
|
|
packetData->setUncompressedSize(newSize);
|
|
|
|
} else {
|
|
assert(newPropertyFlagsLength == oldPropertyFlagsLength); // should not have grown
|
|
}
|
|
|
|
packetData->endLevel(modelLevel);
|
|
} else {
|
|
packetData->discardLevel(modelLevel);
|
|
appendState = OctreeElement::NONE; // if we got here, then we didn't include the item
|
|
}
|
|
|
|
//qDebug() << "propertyFlags=";
|
|
//propertyFlags.debugDumpBits();
|
|
|
|
//qDebug() << "propertiesDidntFit=";
|
|
//propertiesDidntFit.debugDumpBits();
|
|
|
|
// If any part of the model items didn't fit, then the element is considered partial
|
|
if (appendState != OctreeElement::COMPLETED) {
|
|
// add this item into our list for the next appendElementData() pass
|
|
modelTreeElementExtraEncodeData->includedItems.insert(getEntityItemID(), propertiesDidntFit);
|
|
}
|
|
|
|
return appendState;
|
|
} |