hkxEnvironment.h
上传用户:yisoukefu
上传日期:2020-08-09
资源大小:39506k
文件大小:4k
源码类别:

其他游戏

开发平台:

Visual C++

  1. /* 
  2.  * 
  3.  * Confidential Information of Telekinesys Research Limited (t/a Havok). Not for disclosure or distribution without Havok's
  4.  * prior written consent. This software contains code, techniques and know-how which is confidential and proprietary to Havok.
  5.  * Level 2 and Level 3 source code contains trade secrets of Havok. Havok Software (C) Copyright 1999-2009 Telekinesys Research Limited t/a Havok. All Rights Reserved. Use of this software is subject to the terms of an end user license agreement.
  6.  * 
  7.  */
  8. #ifndef HKX_ENVIRONMENT_H
  9. #define HKX_ENVIRONMENT_H
  10. /// hkxEnvironment meta information
  11. extern const class hkClass hkxEnvironmentClass;
  12. /// An hkxEnvironment represent a set of variables+values (string+string) used during processing of assets.
  13. /// It is similar to the concept of the OS shell environment variables. Examples of them
  14. /// would be: the name of the asset, the current configuration being used, etc.
  15. /// NOTE : Variables are considered case-insensitive. Values are returned with the case they were stored
  16. class hkxEnvironment
  17. {
  18. public:
  19. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_SCENE_DATA, hkxEnvironment );
  20. HK_DECLARE_REFLECTION();
  21. /// Sets the value of the given variable. If the variable is new, it adds it. If value is HK_NULL, the 
  22. /// variable is removed. Returns HK_FAILURE if trying to remove a non-existent variable.
  23. hkResult setVariable (const char* name, const char* value);
  24. /// Returns the stored value for the given variable. Return HK_NULL is the variable is unknown.
  25. const char* getVariableValue (const char* name) const;
  26. /// Erases all variables
  27. void clear ();
  28. /// Returns a single string representation of the environment, of the form 
  29. /// var=value ; var = value ;. 
  30. hkString convertToString () const;
  31. /// Interprets a string as a sequence of name=value pairs, separated by semicolons. Quotes can be used on
  32. /// either side. If no value is provided, the variable will be removed (if present). Returns HK_FAILURE
  33. /// if the string couldn't be properly parsed.
  34. /// Example of a string is :
  35. /// var1 = "How are you?"; "var 2"= well ;var_3=; "var 4"= "thank you"
  36. hkResult interpretString(const hkString& str);
  37. /// Direct access to the variables. Returns the number of variables stored.
  38. int getNumVariables () const;
  39. /// Direct access to the variables. Returns the name of the i-th variable
  40. const char* getVariableName (int i) const;
  41. /// Direct access to the variables. Returns the value of the i-th variable
  42. const char* getVariableValue (int i) const;
  43. // Public for serialization
  44. struct Variable
  45. {
  46. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_SCENE_DATA, hkxEnvironment::Variable );
  47. HK_DECLARE_REFLECTION();
  48. const char* m_name;
  49. const char* m_value;
  50. };
  51. private:
  52. int findVariableByName (const char* name) const;
  53. hkArray<struct Variable> m_variables;
  54. };
  55. #endif //HKX_ENVIRONMENT_H
  56. /*
  57. * Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
  58. * Confidential Information of Havok.  (C) Copyright 1999-2009
  59. * Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
  60. * Logo, and the Havok buzzsaw logo are trademarks of Havok.  Title, ownership
  61. * rights, and intellectual property rights in the Havok software remain in
  62. * Havok and/or its suppliers.
  63. * Use of this software for evaluation purposes is subject to and indicates
  64. * acceptance of the End User licence Agreement for this product. A copy of
  65. * the license is included with this software and is also available at www.havok.com/tryhavok.
  66. */