llvolumemessage.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:3k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llvolumemessage.h
  3.  * @brief LLVolumeMessage base class
  4.  *
  5.  * $LicenseInfo:firstyear=2001&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2001-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_LLVOLUMEMESSAGE_H
  33. #define LL_LLVOLUMEMESSAGE_H
  34. #include "llvolume.h"
  35. class LLMessageSystem;
  36. class LLDataPacker;
  37. // wrapper class for some volume/message functions
  38. class LLVolumeMessage
  39. {
  40. protected:
  41. // The profile and path params are protected since they do not do
  42. // any kind of parameter validation or clamping. Use the public
  43. // pack and unpack volume param methods below
  44. static bool packProfileParams(
  45. const LLProfileParams* params,
  46. LLMessageSystem* mesgsys);
  47. static bool packProfileParams(
  48. const LLProfileParams* params,
  49. LLDataPacker& dp);
  50. static bool unpackProfileParams(
  51. LLProfileParams* params,
  52. LLMessageSystem* mesgsys,
  53. char* block_name,
  54. S32 block_num = 0);
  55. static bool unpackProfileParams(LLProfileParams* params, LLDataPacker& dp);
  56. static bool packPathParams(
  57. const LLPathParams* params,
  58. LLMessageSystem* mesgsys);
  59. static bool packPathParams(const LLPathParams* params, LLDataPacker& dp);
  60. static bool unpackPathParams(
  61. LLPathParams* params,
  62. LLMessageSystem* mesgsys,
  63. char* block_name,
  64. S32 block_num = 0);
  65. static bool unpackPathParams(LLPathParams* params, LLDataPacker& dp);
  66. public:
  67. /**
  68.  * @brief This method constrains any volume params to make them valid.
  69.  *
  70.  * @param[in,out] Possibly invalid params in, always valid out.
  71.  * @return Returns true if the in params were valid, and therefore
  72.  * unchanged.
  73.  */
  74. static bool constrainVolumeParams(LLVolumeParams& params);
  75. static bool packVolumeParams(
  76. const LLVolumeParams* params,
  77. LLMessageSystem* mesgsys);
  78. static bool packVolumeParams(
  79. const LLVolumeParams* params,
  80. LLDataPacker& dp);
  81. static bool unpackVolumeParams(
  82. LLVolumeParams* params,
  83. LLMessageSystem* mesgsys,
  84. char* block_name,
  85. S32 block_num = 0);
  86. static bool unpackVolumeParams(LLVolumeParams* params, LLDataPacker &dp);
  87. };
  88. #endif // LL_LLVOLUMEMESSAGE_H