From e93070504b8c589297de4ccfdddbd223b07e1853 Mon Sep 17 00:00:00 2001 From: Alexander Bock Date: Tue, 25 Jul 2017 01:08:20 -0400 Subject: [PATCH] Some more property documentation --- .../cache/memoryawaretilecache.cpp | 67 +++++++++++++------ .../tile/tileprovider/singleimageprovider.cpp | 11 ++- src/interaction/orbitalnavigator.cpp | 21 ++++-- src/network/parallelconnection.cpp | 42 ++++++++---- 4 files changed, 97 insertions(+), 44 deletions(-) diff --git a/modules/globebrowsing/cache/memoryawaretilecache.cpp b/modules/globebrowsing/cache/memoryawaretilecache.cpp index 704fdaf705..5ad33722c5 100644 --- a/modules/globebrowsing/cache/memoryawaretilecache.cpp +++ b/modules/globebrowsing/cache/memoryawaretilecache.cpp @@ -37,6 +37,46 @@ namespace { const char* _loggerCat = "MemoryAwareTileCache"; + + static const openspace::properties::Property::PropertyInfo CpuAllocatedDataInfo = { + "CpuAllocatedTileData", + "CPU allocated tile data (MB)", + "This value denotes the amount of RAM memory (in MB) that this tile cache is " + "utilizing." + }; + + static const openspace::properties::Property::PropertyInfo GpuAllocatedDataInfo = { + "GpuAllocatedTileData", + "GPU allocated tile data (MB)", + "This value denotes the amount of GPU memory (in MB) that this tile cache is " + "utilizing." + }; + + static const openspace::properties::Property::PropertyInfo TileCacheSizeInfo = { + "TileCacheSize", + "Tile cache size", + "" // @TODO Missing documentation + }; + + static const openspace::properties::Property::PropertyInfo ApplyTileCacheInfo = { + "ApplyTileCacheSize", + "Apply tile cache size", + "" // @TODO Missing documentation + }; + + static const openspace::properties::Property::PropertyInfo ClearTileCacheInfo = { + "ClearTileCache", + "Clear tile cache", + "" // @TODO Missing documentation + }; + + static const openspace::properties::Property::PropertyInfo UsePboInfo = { + "UsePbo", + "Use PBO", + "If this value is enabled, pixel buffer objects are used to upload the texture " + "data asynchronously. If this value is disabled, the upload is synchronously." + }; + } // namespace namespace openspace::globebrowsing::cache { @@ -44,27 +84,12 @@ namespace openspace::globebrowsing::cache { MemoryAwareTileCache::MemoryAwareTileCache() : PropertyOwner("TileCache") , _numTextureBytesAllocatedOnCPU(0) - , _cpuAllocatedTileData( - { "CpuAllocatedTileData", "CPU allocated tile data (MB)", "" }, // @TODO Missing documentation - 1024, // Default - 128, // Minimum - 2048, // Maximum - 1) // Step: One MB - , _gpuAllocatedTileData( - { "GpuAllocatedTileData", "GPU allocated tile data (MB)", ""}, // @TODO Missing documentation - 1024, // Default - 128, // Minimum - 2048, // Maximum - 1) // Step: One MB - , _tileCacheSize( - { "TileCacheSize", "Tile cache size", ""}, // @TODO Missing documentation - 1024, // Default - 128, // Minimum - 2048, // Maximum - 1) // Step: One MB - , _applyTileCacheSize({ "ApplyTileCacheSize", "Apply tile cache size", "" }) // @TODO Missing documentation - , _clearTileCache({ "ClearTileCache", "Clear tile cache", "" }) // @TODO Missing documentation - , _usePbo({ "UsePbo", "Use PBO", "" }, false) // @TODO Missing documentation + , _cpuAllocatedTileData(CpuAllocatedDataInfo, 1024, 128, 2048, 1) + , _gpuAllocatedTileData(GpuAllocatedDataInfo, 1024, 128, 2048, 1) + , _tileCacheSize(TileCacheSizeInfo, 1024, 128, 2048, 1) + , _applyTileCacheSize(ApplyTileCacheInfo) + , _clearTileCache(ClearTileCacheInfo) + , _usePbo(UsePboInfo, false) { createDefaultTextureContainers(); diff --git a/modules/globebrowsing/tile/tileprovider/singleimageprovider.cpp b/modules/globebrowsing/tile/tileprovider/singleimageprovider.cpp index 60bb55434c..6a4397fc00 100644 --- a/modules/globebrowsing/tile/tileprovider/singleimageprovider.cpp +++ b/modules/globebrowsing/tile/tileprovider/singleimageprovider.cpp @@ -30,13 +30,20 @@ namespace { const char* KeyFilePath = "FilePath"; + + static const openspace::properties::Property::PropertyInfo FilePathInfo = { + "FilePath", + "File Path", + "The file path that is used for this image provider. The file must point to an " + "image that is then loaded and used for all tiles." + }; } // namespace namespace openspace::globebrowsing::tileprovider { SingleImageProvider::SingleImageProvider(const ghoul::Dictionary& dictionary) : _tile(nullptr, nullptr, Tile::Status::Unavailable) - , _filePath({ "FilePath", "File Path", "" }) // @TODO Missing documentation + , _filePath(FilePathInfo) { // Required input std::string filePath; @@ -50,7 +57,7 @@ SingleImageProvider::SingleImageProvider(const ghoul::Dictionary& dictionary) SingleImageProvider::SingleImageProvider(const std::string& imagePath) : _tile(nullptr, nullptr, Tile::Status::Unavailable) - , _filePath({ "FilePath", "File Path", "" }, imagePath) // @TODO Missing documentation + , _filePath(FilePathInfo, imagePath) { reset(); } diff --git a/src/interaction/orbitalnavigator.cpp b/src/interaction/orbitalnavigator.cpp index 008c4c0a47..9f6021650e 100644 --- a/src/interaction/orbitalnavigator.cpp +++ b/src/interaction/orbitalnavigator.cpp @@ -74,6 +74,18 @@ namespace { "Friction', and 'Zoom Friction' values are enabled. The lower this value is, the " "faster the camera movements will stop." }; + + static const openspace::properties::Property::PropertyInfo FollowFocusNodeInfo = { + "FollowFocusNodeRotationDistance", + "Follow focus node rotation distance", + "" // @TODO Missing documentation + }; + + static const openspace::properties::Property::PropertyInfo MinimumDistanceInfo = { + "MinimumAllowedDistance", + "Minimum allowed distance", + "" // @TODO Missing documentation + } } // namespace namespace openspace::interaction { @@ -83,13 +95,8 @@ OrbitalNavigator::OrbitalNavigator() , _rollFriction(RollFrictionInfo, true) , _rotationalFriction(RotationalFrictionInfo, true) , _zoomFriction(ZoomFrictionInfo, true) - , _followFocusNodeRotationDistance( - { "FollowFocusNodeRotationDistance", "Follow focus node rotation distance", "" }, // @TODO Missing documentation - 2.0f, 0.0f, 10.f - ) - , _minimumAllowedDistance( - {"MinimumAllowedDistance", "Minimum allowed distance", "" }, // @TODO Missing documentation - 10.0f, 0.0f, 10000.f) + , _followFocusNodeRotationDistance(FollowFocusNodeInfo, 2.0f, 0.0f, 10.f) + , _minimumAllowedDistance(FollowFocusNodeInfo, 10.0f, 0.0f, 10000.f) , _sensitivity(SensitivityInfo, 20.0f, 1.0f, 50.f) , _motionLag(FrictionInfo, 0.5f, 0.f, 1.f) , _mouseStates(_sensitivity * pow(10.0,-4), 1 / (_motionLag + 0.0000001)) diff --git a/src/network/parallelconnection.cpp b/src/network/parallelconnection.cpp index aa12b3ddfb..0407543276 100644 --- a/src/network/parallelconnection.cpp +++ b/src/network/parallelconnection.cpp @@ -115,6 +115,30 @@ namespace { "The name of this OpenSpace instance that will be potentially broadcast to other " "connected instances." }; + + static const openspace::properties::Property::PropertyInfo BufferTimeInfo = { + "BufferTime", + "Buffer Time", + "" // @TODO Missing documentation + }; + + static const openspace::properties::Property::PropertyInfo TimeKeyFrameInfo = { + "TimeKeyframeInterval", + "Time keyframe interval", + "" // @TODO Missing documentation + }; + + static const openspace::properties::Property::PropertyInfo CameraKeyFrameInfo = { + "CameraKeyframeInterval", + "Camera Keyframe interval", + "" // @TODO Missing documentation + }; + + static const openspace::properties::Property::PropertyInfo TimeToleranceInfo = { + "TimeTolerance", + "Time tolerance", + "" // @TODO Missing documentation + }; } // namespace namespace openspace { @@ -126,20 +150,10 @@ ParallelConnection::ParallelConnection() , _port(PortInfo, "20501") , _address(AddressInfo, "localhost") , _name(NameInfo, "Anonymous") - , _bufferTime({ "BufferTime", "Buffer Time", "" }, 1, 0.5, 10) // @TODO Missing documentation - , _timeKeyframeInterval( - { "TimeKeyframeInterval", "Time keyframe interval", ""}, // @TODO Missing documentation - 0.1f, - 0.f, - 1.f - ) - , _cameraKeyframeInterval( - { "CameraKeyframeInterval", "Camera Keyframe interval", "" }, // @TODO Missing documentation - 0.1f, - 0.f, - 1.f - ) - , _timeTolerance({ "TimeTolerance", "Time tolerance", "" }, 1.f, 0.5f, 5.f) // @TODO Missing documentation + , _bufferTime(BufferTimeInfo, 1, 0.5, 10) + , _timeKeyframeInterval(TimeKeyFrameInfo, 0.1f, 0.f, 1.f) + , _cameraKeyframeInterval(CameraKeyFrameInfo, 0.1f, 0.f, 1.f) + , _timeTolerance(TimeToleranceInfo, 1.f, 0.5f, 5.f) , _lastTimeKeyframeTimestamp(0) , _lastCameraKeyframeTimestamp(0) , _clientSocket(INVALID_SOCKET)