494 lines
14 KiB
C++
494 lines
14 KiB
C++
/**
|
|
* @file llviewerregion.h
|
|
* @brief Description of the LLViewerRegion class.
|
|
*
|
|
* $LicenseInfo:firstyear=2001&license=viewergpl$
|
|
*
|
|
* Copyright (c) 2001-2009, Linden Research, Inc.
|
|
*
|
|
* Second Life Viewer Source Code
|
|
* The source code in this file ("Source Code") is provided by Linden Lab
|
|
* to you under the terms of the GNU General Public License, version 2.0
|
|
* ("GPL"), unless you have obtained a separate licensing agreement
|
|
* ("Other License"), formally executed by you and Linden Lab. Terms of
|
|
* the GPL can be found in doc/GPL-license.txt in this distribution, or
|
|
* online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
|
|
*
|
|
* There are special exceptions to the terms and conditions of the GPL as
|
|
* it is applied to this Source Code. View the full text of the exception
|
|
* in the file doc/FLOSS-exception.txt in this software distribution, or
|
|
* online at
|
|
* http://secondlifegrid.net/programs/open_source/licensing/flossexception
|
|
*
|
|
* By copying, modifying or distributing this software, you acknowledge
|
|
* that you have read and understood your obligations described above,
|
|
* and agree to abide by those obligations.
|
|
*
|
|
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
|
|
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
|
|
* COMPLETENESS OR PERFORMANCE.
|
|
* $/LicenseInfo$
|
|
*/
|
|
|
|
#ifndef LL_LLVIEWERREGION_H
|
|
#define LL_LLVIEWERREGION_H
|
|
|
|
// A ViewerRegion is a class that contains a bunch of objects and surfaces
|
|
// that are in to a particular region.
|
|
#include <string>
|
|
|
|
#include "lldarray.h"
|
|
#include "llwind.h"
|
|
#include "llcloud.h"
|
|
#include "llstat.h"
|
|
#include "v3dmath.h"
|
|
#include "llstring.h"
|
|
#include "llregionflags.h"
|
|
#include "lluuid.h"
|
|
#include "llweb.h"
|
|
#include "llcapabilityprovider.h"
|
|
#include "m4math.h" // LLMatrix4
|
|
#include "llhttpclient.h"
|
|
|
|
// Surface id's
|
|
#define LAND 1
|
|
#define WATER 2
|
|
const U32 MAX_OBJECT_CACHE_ENTRIES = 50000;
|
|
|
|
|
|
class LLEventPoll;
|
|
class LLVLComposition;
|
|
class LLViewerObject;
|
|
class LLMessageSystem;
|
|
class LLNetMap;
|
|
class LLViewerParcelOverlay;
|
|
class LLSurface;
|
|
class LLVOCache;
|
|
class LLVOCacheEntry;
|
|
class LLSpatialPartition;
|
|
class LLEventPump;
|
|
class LLDataPacker;
|
|
class LLDataPackerBinaryBuffer;
|
|
class LLHost;
|
|
class LLBBox;
|
|
|
|
class LLViewerRegionImpl;
|
|
|
|
class LLViewerRegion: public LLCapabilityProvider // implements this interface
|
|
{
|
|
public:
|
|
//MUST MATCH THE ORDER OF DECLARATION IN CONSTRUCTOR
|
|
typedef enum
|
|
{
|
|
PARTITION_HUD=0,
|
|
PARTITION_TERRAIN,
|
|
PARTITION_VOIDWATER,
|
|
PARTITION_WATER,
|
|
PARTITION_TREE,
|
|
PARTITION_PARTICLE,
|
|
#if ENABLE_CLASSIC_CLOUDS
|
|
PARTITION_CLOUD,
|
|
#endif
|
|
PARTITION_GRASS,
|
|
PARTITION_VOLUME,
|
|
PARTITION_BRIDGE,
|
|
PARTITION_HUD_PARTICLE,
|
|
PARTITION_NONE,
|
|
NUM_PARTITIONS
|
|
} eObjectPartitions;
|
|
|
|
typedef boost::signals2::signal<void(const LLUUID& region_id)> caps_received_signal_t;
|
|
|
|
LLViewerRegion(const U64 &handle,
|
|
const LLHost &host,
|
|
const U32 surface_grid_width,
|
|
const U32 patch_grid_width,
|
|
const F32 region_width_meters);
|
|
~LLViewerRegion();
|
|
|
|
// Call this after you have the region name and handle.
|
|
void loadObjectCache();
|
|
void saveObjectCache();
|
|
|
|
void sendMessage(); // Send the current message to this region's simulator
|
|
void sendReliableMessage(); // Send the current message to this region's simulator
|
|
|
|
void setOriginGlobal(const LLVector3d &origin);
|
|
//void setAgentOffset(const LLVector3d &offset);
|
|
void updateRenderMatrix();
|
|
|
|
void setAllowDamage(BOOL b) { setFlags(b, REGION_FLAGS_ALLOW_DAMAGE); }
|
|
void setAllowLandmark(BOOL b) { setFlags(b, REGION_FLAGS_ALLOW_LANDMARK); }
|
|
void setAllowSetHome(BOOL b) { setFlags(b, REGION_FLAGS_ALLOW_SET_HOME); }
|
|
void setResetHomeOnTeleport(BOOL b) { setFlags(b, REGION_FLAGS_RESET_HOME_ON_TELEPORT); }
|
|
void setSunFixed(BOOL b) { setFlags(b, REGION_FLAGS_SUN_FIXED); }
|
|
void setBlockFly(BOOL b) { setFlags(b, REGION_FLAGS_BLOCK_FLY); }
|
|
void setAllowDirectTeleport(BOOL b) { setFlags(b, REGION_FLAGS_ALLOW_DIRECT_TELEPORT); }
|
|
|
|
|
|
inline BOOL getAllowDamage() const;
|
|
inline BOOL getAllowLandmark() const;
|
|
inline BOOL getAllowSetHome() const;
|
|
inline BOOL getResetHomeOnTeleport() const;
|
|
inline BOOL getSunFixed() const;
|
|
inline BOOL getBlockFly() const;
|
|
inline BOOL getAllowDirectTeleport() const;
|
|
inline BOOL isPrelude() const;
|
|
inline BOOL getAllowTerraform() const;
|
|
inline BOOL getRestrictPushObject() const;
|
|
inline BOOL getReleaseNotesRequested() const;
|
|
|
|
bool isAlive(); // can become false if circuit disconnects
|
|
|
|
void setWaterHeight(F32 water_level);
|
|
F32 getWaterHeight() const;
|
|
|
|
BOOL isVoiceEnabled() const;
|
|
|
|
void setBillableFactor(F32 billable_factor) { mBillableFactor = billable_factor; }
|
|
F32 getBillableFactor() const { return mBillableFactor; }
|
|
|
|
// Maximum number of primitives allowed, regardless of object
|
|
// bonus factor.
|
|
U32 getMaxTasks() const { return mMaxTasks; }
|
|
void setMaxTasks(U32 max_tasks) { mMaxTasks = max_tasks; }
|
|
|
|
// Draw lines in the dirt showing ownership. Return number of
|
|
// vertices drawn.
|
|
S32 renderPropertyLines();
|
|
|
|
// Call this whenever you change the height data in the region.
|
|
// (Automatically called by LLSurfacePatch's update routine)
|
|
void dirtyHeights();
|
|
|
|
LLViewerParcelOverlay *getParcelOverlay() const
|
|
{ return mParcelOverlay; }
|
|
|
|
void setRegionFlags(U32 flags);
|
|
U32 getRegionFlags() const { return mRegionFlags; }
|
|
|
|
void setTimeDilation(F32 time_dilation);
|
|
F32 getTimeDilation() const { return mTimeDilation; }
|
|
|
|
// Origin height is at zero.
|
|
const LLVector3d &getOriginGlobal() const;
|
|
LLVector3 getOriginAgent() const;
|
|
|
|
// Center is at the height of the water table.
|
|
const LLVector3d &getCenterGlobal() const;
|
|
LLVector3 getCenterAgent() const;
|
|
|
|
void setRegionNameAndZone(const std::string& name_and_zone);
|
|
const std::string& getName() const { return mName; }
|
|
const std::string& getZoning() const { return mZoning; }
|
|
|
|
void setOwner(const LLUUID& owner_id);
|
|
const LLUUID& getOwner() const;
|
|
|
|
// Is the current agent on the estate manager list for this region?
|
|
void setIsEstateManager(BOOL b) { mIsEstateManager = b; }
|
|
BOOL isEstateManager() const { return mIsEstateManager; }
|
|
BOOL canManageEstate() const;
|
|
|
|
void setSimAccess(U8 sim_access) { mSimAccess = sim_access; }
|
|
U8 getSimAccess() const { return mSimAccess; }
|
|
const std::string getSimAccessString() const;
|
|
|
|
// Homestead-related getters; there are no setters as nobody should be
|
|
// setting them other than the individual message handler which is a member
|
|
S32 getSimClassID() const { return mClassID; }
|
|
S32 getSimCPURatio() const { return mCPURatio; }
|
|
const std::string& getSimColoName() const { return mColoName; }
|
|
const std::string& getSimProductSKU() const { return mProductSKU; }
|
|
std::string getLocalizedSimProductName() const;
|
|
|
|
// Returns "Sandbox", "Expensive", etc.
|
|
static std::string regionFlagsToString(U32 flags);
|
|
|
|
// Returns translated version of "Mature", "PG", "Adult", etc.
|
|
static std::string accessToString(U8 sim_access);
|
|
|
|
// Returns "M", "PG", "A" etc.
|
|
static std::string accessToShortString(U8 sim_access);
|
|
|
|
// Return access icon name
|
|
static std::string getAccessIcon(U8 sim_access);
|
|
|
|
// helper function which just makes sure all interested parties
|
|
// can process the message.
|
|
static void processRegionInfo(LLMessageSystem* msg, void**);
|
|
|
|
void setCacheID(const LLUUID& id);
|
|
|
|
F32 getWidth() const { return mWidth; }
|
|
|
|
BOOL idleUpdate(F32 max_update_time);
|
|
|
|
// Like idleUpdate, but forces everything to complete regardless of
|
|
// how long it takes.
|
|
void forceUpdate();
|
|
|
|
void connectNeighbor(LLViewerRegion *neighborp, U32 direction);
|
|
|
|
void updateNetStats();
|
|
|
|
U32 getPacketsLost() const;
|
|
|
|
S32 getHttpResponderID() const;
|
|
|
|
// Get/set named capability URLs for this region.
|
|
void setSeedCapability(const std::string& url);
|
|
void failedSeedCapability();
|
|
S32 getNumSeedCapRetries();
|
|
void setCapability(const std::string& name, const std::string& url);
|
|
// implements LLCapabilityProvider
|
|
virtual std::string getCapability(const std::string& name) const;
|
|
|
|
// has region received its final (not seed) capability list?
|
|
bool capabilitiesReceived() const;
|
|
void setCapabilitiesReceived(bool received);
|
|
boost::signals2::connection setCapabilitiesReceivedCallback(const caps_received_signal_t::slot_type& cb);
|
|
|
|
static bool isSpecialCapabilityName(const std::string &name);
|
|
void logActiveCapabilities() const;
|
|
|
|
/// Get LLEventPump on which we listen for capability requests
|
|
/// (https://wiki.lindenlab.com/wiki/Viewer:Messaging/Messaging_Notes#Capabilities)
|
|
LLEventPump& getCapAPI() const;
|
|
|
|
/// implements LLCapabilityProvider
|
|
/*virtual*/ const LLHost& getHost() const;
|
|
const U64 &getHandle() const { return mHandle; }
|
|
|
|
LLSurface &getLand() const;
|
|
|
|
// set and get the region id
|
|
const LLUUID& getRegionID() const;
|
|
void setRegionID(const LLUUID& region_id);
|
|
|
|
BOOL pointInRegionGlobal(const LLVector3d &point_global) const;
|
|
LLVector3 getPosRegionFromGlobal(const LLVector3d &point_global) const;
|
|
LLVector3 getPosRegionFromAgent(const LLVector3 &agent_pos) const;
|
|
LLVector3 getPosAgentFromRegion(const LLVector3 ®ion_pos) const;
|
|
LLVector3d getPosGlobalFromRegion(const LLVector3 &offset) const;
|
|
|
|
LLVLComposition *getComposition() const;
|
|
F32 getCompositionXY(const S32 x, const S32 y) const;
|
|
|
|
BOOL isOwnedSelf(const LLVector3& pos);
|
|
|
|
// Owned by a group you belong to? (officer OR member)
|
|
BOOL isOwnedGroup(const LLVector3& pos);
|
|
|
|
// deal with map object updates in the world.
|
|
void updateCoarseLocations(LLMessageSystem* msg);
|
|
|
|
F32 getLandHeightRegion(const LLVector3& region_pos);
|
|
|
|
void getInfo(LLSD& info);
|
|
|
|
bool meshRezEnabled() const;
|
|
bool meshUploadEnabled() const;
|
|
|
|
void getSimulatorFeatures(LLSD& info);
|
|
void setSimulatorFeatures(const LLSD& info);
|
|
|
|
typedef enum
|
|
{
|
|
CACHE_MISS_TYPE_FULL = 0,
|
|
CACHE_MISS_TYPE_CRC,
|
|
CACHE_MISS_TYPE_NONE
|
|
} eCacheMissType;
|
|
|
|
typedef enum
|
|
{
|
|
CACHE_UPDATE_DUPE = 0,
|
|
CACHE_UPDATE_CHANGED,
|
|
CACHE_UPDATE_ADDED,
|
|
CACHE_UPDATE_REPLACED
|
|
} eCacheUpdateResult;
|
|
|
|
// handle a full update message
|
|
eCacheUpdateResult cacheFullUpdate(LLViewerObject* objectp, LLDataPackerBinaryBuffer &dp);
|
|
LLDataPacker *getDP(U32 local_id, U32 crc, U8 &cache_miss_type);
|
|
void requestCacheMisses();
|
|
void addCacheMissFull(const U32 local_id);
|
|
|
|
void dumpCache();
|
|
|
|
void unpackRegionHandshake();
|
|
|
|
void calculateCenterGlobal();
|
|
void calculateCameraDistance();
|
|
|
|
friend std::ostream& operator<<(std::ostream &s, const LLViewerRegion ®ion);
|
|
|
|
// used by LCD to get details for debug screen
|
|
U32 getNetDetailsForLCD();
|
|
|
|
/// implements LLCapabilityProvider
|
|
virtual std::string getDescription() const;
|
|
std::string getHttpUrl() const { return mHttpUrl ;}
|
|
|
|
LLSpatialPartition* getSpatialPartition(U32 type);
|
|
|
|
bool objectIsReturnable(const LLVector3& pos, const std::vector<LLBBox>& boxes) const;
|
|
bool childrenObjectReturnable( const std::vector<LLBBox>& boxes ) const;
|
|
bool objectsCrossParcel(const std::vector<LLBBox>& boxes) const;
|
|
|
|
void getNeighboringRegions( std::vector<LLViewerRegion*>& uniqueRegions );
|
|
|
|
public:
|
|
struct CompareDistance
|
|
{
|
|
bool operator()(const LLViewerRegion* const& lhs, const LLViewerRegion* const& rhs)
|
|
{
|
|
return lhs->mCameraDistanceSquared < rhs->mCameraDistanceSquared;
|
|
}
|
|
};
|
|
|
|
void showReleaseNotes();
|
|
|
|
protected:
|
|
void disconnectAllNeighbors();
|
|
void initStats();
|
|
void setFlags(BOOL b, U32 flags);
|
|
|
|
public:
|
|
LLWind mWind;
|
|
#if ENABLE_CLASSIC_CLOUDS
|
|
LLCloudLayer mCloudLayer;
|
|
#endif
|
|
LLViewerParcelOverlay *mParcelOverlay;
|
|
|
|
LLStat mBitStat;
|
|
LLStat mPacketsStat;
|
|
LLStat mPacketsLostStat;
|
|
|
|
LLMatrix4 mRenderMatrix;
|
|
|
|
// These arrays are maintained in parallel. Ideally they'd be combined into a
|
|
// single array of an aggrigate data type but for compatibility with the old
|
|
// messaging system in which the previous message only sends and parses the
|
|
// positions stored in the first array so they're maintained separately until
|
|
// we stop supporting the old CoarseLocationUpdate message.
|
|
LLDynamicArray<U32> mMapAvatars;
|
|
LLDynamicArray<LLUUID> mMapAvatarIDs;
|
|
|
|
private:
|
|
LLViewerRegionImpl * mImpl;
|
|
|
|
F32 mWidth; // Width of region on a side (meters)
|
|
U64 mHandle;
|
|
F32 mTimeDilation; // time dilation of physics simulation on simulator
|
|
|
|
// simulator name
|
|
std::string mName;
|
|
std::string mZoning;
|
|
|
|
// Is this agent on the estate managers list for this region?
|
|
BOOL mIsEstateManager;
|
|
|
|
U32 mPacketsIn;
|
|
U32 mBitsIn;
|
|
U32 mLastBitsIn;
|
|
U32 mLastPacketsIn;
|
|
U32 mPacketsOut;
|
|
U32 mLastPacketsOut;
|
|
S32 mPacketsLost;
|
|
S32 mLastPacketsLost;
|
|
U32 mPingDelay;
|
|
F32 mDeltaTime; // Time since last measurement of lastPackets, Bits, etc
|
|
|
|
U32 mRegionFlags; // includes damage flags
|
|
U8 mSimAccess;
|
|
F32 mBillableFactor;
|
|
U32 mMaxTasks; // max prim count
|
|
F32 mCameraDistanceSquared; // updated once per frame
|
|
|
|
// Information for Homestead / CR-53
|
|
S32 mClassID;
|
|
S32 mCPURatio;
|
|
|
|
std::string mColoName;
|
|
std::string mProductSKU;
|
|
std::string mProductName;
|
|
std::string mHttpUrl ;
|
|
|
|
// Maps local ids to cache entries.
|
|
// Regions can have order 10,000 objects, so assume
|
|
// a structure of size 2^14 = 16,000
|
|
BOOL mCacheLoaded;
|
|
BOOL mCacheDirty;
|
|
|
|
LLDynamicArray<U32> mCacheMissFull;
|
|
LLDynamicArray<U32> mCacheMissCRC;
|
|
|
|
bool mAlive; // can become false if circuit disconnects
|
|
bool mCapabilitiesReceived;
|
|
caps_received_signal_t mCapabilitiesReceivedSignal;
|
|
|
|
BOOL mReleaseNotesRequested;
|
|
|
|
LLSD mSimulatorFeatures;
|
|
};
|
|
|
|
inline BOOL LLViewerRegion::getAllowDamage() const
|
|
{
|
|
return ((mRegionFlags & REGION_FLAGS_ALLOW_DAMAGE) !=0);
|
|
}
|
|
|
|
inline BOOL LLViewerRegion::getAllowLandmark() const
|
|
{
|
|
return ((mRegionFlags & REGION_FLAGS_ALLOW_LANDMARK) !=0);
|
|
}
|
|
|
|
inline BOOL LLViewerRegion::getAllowSetHome() const
|
|
{
|
|
return ((mRegionFlags & REGION_FLAGS_ALLOW_SET_HOME) != 0);
|
|
}
|
|
|
|
inline BOOL LLViewerRegion::getResetHomeOnTeleport() const
|
|
{
|
|
return ((mRegionFlags & REGION_FLAGS_RESET_HOME_ON_TELEPORT) !=0);
|
|
}
|
|
|
|
inline BOOL LLViewerRegion::getSunFixed() const
|
|
{
|
|
return ((mRegionFlags & REGION_FLAGS_SUN_FIXED) !=0);
|
|
}
|
|
|
|
inline BOOL LLViewerRegion::getBlockFly() const
|
|
{
|
|
return ((mRegionFlags & REGION_FLAGS_BLOCK_FLY) !=0);
|
|
}
|
|
|
|
inline BOOL LLViewerRegion::getAllowDirectTeleport() const
|
|
{
|
|
return ((mRegionFlags & REGION_FLAGS_ALLOW_DIRECT_TELEPORT) !=0);
|
|
}
|
|
|
|
inline BOOL LLViewerRegion::isPrelude() const
|
|
{
|
|
return is_prelude( mRegionFlags );
|
|
}
|
|
|
|
inline BOOL LLViewerRegion::getAllowTerraform() const
|
|
{
|
|
return ((mRegionFlags & REGION_FLAGS_BLOCK_TERRAFORM) == 0);
|
|
}
|
|
|
|
inline BOOL LLViewerRegion::getRestrictPushObject() const
|
|
{
|
|
return ((mRegionFlags & REGION_FLAGS_RESTRICT_PUSHOBJECT) != 0);
|
|
}
|
|
|
|
inline BOOL LLViewerRegion::getReleaseNotesRequested() const
|
|
{
|
|
return mReleaseNotesRequested;
|
|
}
|
|
|
|
#endif
|
|
|
|
|