[#19] vob: rename camera_lock_mode -> sprite_alignment

As per suggestion in [OpenGothic#272](Try/OpenGothic#271 (comment)).

(cherry picked from commit 30de6a4)

Author: lmichaelis

include/phoenix/vobs/vob.hh

@@ -82,12 +82,16 @@ namespace phoenix {
 	};
 
 	/// \brief Ways the camera may behave with a VOb.
-	enum class camera_lock_mode : std::uint8_t {
-		none = 0, ///< The camera is not affected by this VOb.
-		yaw = 1,  ///< The camera's yaw is locked to the VOb's yaw.
-		full = 2, ///< The camera is fully locked to the VOb.
+	enum class sprite_alignment : std::uint8_t {
+		none = 0, ///< The sprite is not affected by the camera's position.
+		yaw = 1,  ///< The sprite rotates with the camera's yaw axis.
+		full = 2, ///< The sprite rotates with camera fully.
 	};
 
+	/// \brief Ways the camera may behave with a VOb. Same as sprite_alignment
+	/// \deprecated Use sprite_alignment instead.
+	using camera_lock_mode [[deprecated("use phoenix::sprite_alignment")]] = sprite_alignment;
+
 	/// \brief Types of wavy animation.
 	enum class animation_mode : std::uint8_t {
 		none = 0, ///< No wave animation.
@@ -125,7 +129,12 @@ namespace phoenix {
 		glm::vec3 position {};
 		glm::mat3x3 rotation {};
 		bool show_visual {};
-		camera_lock_mode camera_alignment {};
+
+		union {
+			[[deprecated("use phoenix::vob::sprite_camera_facing_mode")]] sprite_alignment camera_alignment;
+			sprite_alignment sprite_camera_facing_mode;
+		};
+
 		bool cd_static {};
 		bool cd_dynamic {};
 		bool vob_static {};

source/vobs/vob.cc

@@ -60,7 +60,7 @@ namespace phoenix {
 			}
 
 			obj.show_visual = static_cast<bool>((bit0 & 0b00000001) >> 0);
-			obj.camera_alignment = static_cast<camera_lock_mode>((bit0 & 0b00000110) >> 1);
+			obj.sprite_camera_facing_mode = static_cast<sprite_alignment>((bit0 & 0b00000110) >> 1);
 			obj.cd_static = static_cast<bool>((bit0 & 0b00001000) >> 3);
 			obj.cd_dynamic = static_cast<bool>((bit0 & 0b00010000) >> 4);
 			obj.vob_static = static_cast<bool>((bit0 & 0b00100000) >> 5);
@@ -101,10 +101,10 @@ namespace phoenix {
 			obj.rotation = in.read_mat3x3(); // trafoOSToWSRot
 			obj.position = in.read_vec3();   // trafoOSToWSPos
 
-			obj.vob_name = in.read_string();                                      // vobName
-			obj.visual_name = in.read_string();                                   // visual
-			obj.show_visual = in.read_bool();                                     // showVisual
-			obj.camera_alignment = static_cast<camera_lock_mode>(in.read_enum()); // visualCamAlign
+			obj.vob_name = in.read_string();                                               // vobName
+			obj.visual_name = in.read_string();                                            // visual
+			obj.show_visual = in.read_bool();                                              // showVisual
+			obj.sprite_camera_facing_mode = static_cast<sprite_alignment>(in.read_enum()); // visualCamAlign
 
 			if (version == game_version::gothic_1) {
 				obj.cd_static = in.read_bool();                                 // cdStatic

tests/test_world.cc

@@ -169,7 +169,7 @@ TEST_SUITE("world") {
 			CHECK(vob0->preset_name.empty());
 			CHECK(vob0->position == glm::vec3 {0, 0, 0});
 			CHECK(!vob0->show_visual);
-			CHECK(vob0->camera_alignment == phoenix::camera_lock_mode::none);
+			CHECK(vob0->sprite_camera_facing_mode == phoenix::sprite_alignment::none);
 			CHECK(vob0->anim_mode == phoenix::animation_mode::none);
 			CHECK(vob0->anim_strength == 0.0f);
 			CHECK(vob0->far_clip_scale == 0);
@@ -209,7 +209,7 @@ TEST_SUITE("world") {
 				CHECK(child1->preset_name.empty());
 				CHECK(child1->position == glm::vec3 {-18544.4863, -136.171906, 4141.19727});
 				CHECK(!child1->show_visual);
-				CHECK(child1->camera_alignment == phoenix::camera_lock_mode::none);
+				CHECK(child1->sprite_camera_facing_mode == phoenix::sprite_alignment::none);
 				CHECK(child1->anim_mode == phoenix::animation_mode::none);
 				CHECK(child1->anim_strength == 0.0f);
 				CHECK(child1->far_clip_scale == 0);
@@ -246,7 +246,7 @@ TEST_SUITE("world") {
 			CHECK(vob13->preset_name.empty());
 			CHECK(vob13->position == glm::vec3 {0, 0, 0});
 			CHECK(!vob13->show_visual);
-			CHECK(vob13->camera_alignment == phoenix::camera_lock_mode::none);
+			CHECK(vob13->sprite_camera_facing_mode == phoenix::sprite_alignment::none);
 			CHECK(vob13->anim_mode == phoenix::animation_mode::none);
 			CHECK(vob13->anim_strength == 0.0f);
 			CHECK(vob13->far_clip_scale == 0);