Basic camera control API (#15796)

src/client/camera.cpp

@@ -375,6 +375,9 @@ void Camera::update(LocalPlayer* player, f32 frametime, f32 tool_reload_ratio)
 	{
 		v3f eye_offset = player->getEyeOffset();
 		switch(m_camera_mode) {
+		case CAMERA_MODE_ANY:
+			assert(false);
+			break;
 		case CAMERA_MODE_FIRST:
 			eye_offset += player->eye_offset_first;
 			break;

src/client/camera.h

@@ -57,8 +57,6 @@ struct Nametag
 	}
 };
 
-enum CameraMode {CAMERA_MODE_FIRST, CAMERA_MODE_THIRD, CAMERA_MODE_THIRD_FRONT};
-
 /*
 	Client camera class, manages the player and camera scene nodes, the viewing distance
 	and performs view bobbing etc. It also displays the wielded tool in front of the
@@ -169,7 +167,8 @@ public:
 	void drawWieldedTool(irr::core::matrix4* translation=NULL);
 
 	// Toggle the current camera mode
-	void toggleCameraMode() {
+	void toggleCameraMode()
+	{
 		if (m_camera_mode == CAMERA_MODE_FIRST)
 			m_camera_mode = CAMERA_MODE_THIRD;
 		else if (m_camera_mode == CAMERA_MODE_THIRD)
@@ -185,7 +184,7 @@ public:
 	}
 
 	//read the current camera mode
-	inline CameraMode getCameraMode()
+	inline CameraMode getCameraMode() const
 	{
 		return m_camera_mode;
 	}

src/client/client.h

@@ -217,6 +217,7 @@ public:
 	void handleCommand_MediaPush(NetworkPacket *pkt);
 	void handleCommand_MinimapModes(NetworkPacket *pkt);
 	void handleCommand_SetLighting(NetworkPacket *pkt);
+	void handleCommand_Camera(NetworkPacket* pkt);
 
 	void ProcessData(NetworkPacket *pkt);
 

src/client/clientevent.h

@@ -36,6 +36,7 @@ enum ClientEventType : u8
 	CE_SET_STARS,
 	CE_OVERRIDE_DAY_NIGHT_RATIO,
 	CE_CLOUD_PARAMS,
+	CE_UPDATE_CAMERA,
 	CLIENTEVENT_MAX,
 };
 
@@ -66,11 +67,14 @@ struct ClientEventHudChange
 
 struct ClientEvent
 {
+	// TODO: should get rid of this ctor
+	ClientEvent() : type(CE_NONE) {}
+
+	ClientEvent(ClientEventType type) : type(type) {}
+
 	ClientEventType type;
 	union
 	{
-		// struct{
-		//} none;
 		struct
 		{
 			u16 amount;
@@ -86,8 +90,6 @@ struct ClientEvent
 			std::string *formspec;
 			std::string *formname;
 		} show_formspec;
-		// struct{
-		//} textures_updated;
 		ParticleParameters *spawn_particle;
 		struct
 		{

src/client/game.cpp

@@ -564,6 +564,7 @@ protected:
 	void updatePauseState();
 	void step(f32 dtime);
 	void processClientEvents(CameraOrientation *cam);
+	void updateCameraMode(); // call after changing it
 	void updateCameraOffset();
 	void updateCamera(f32 dtime);
 	void updateSound(f32 dtime);
@@ -665,6 +666,7 @@ private:
 	void handleClientEvent_OverrideDayNigthRatio(ClientEvent *event,
 		CameraOrientation *cam);
 	void handleClientEvent_CloudParams(ClientEvent *event, CameraOrientation *cam);
+	void handleClientEvent_UpdateCamera(ClientEvent *event, CameraOrientation *cam);
 
 	void updateChat(f32 dtime);
 
@@ -1921,6 +1923,9 @@ void Game::processKeyInput()
 		toggleFog();
 	} else if (wasKeyDown(KeyType::TOGGLE_UPDATE_CAMERA)) {
 		toggleUpdateCamera();
+	} else if (wasKeyPressed(KeyType::CAMERA_MODE)) {
+		camera->toggleCameraMode();
+		updateCameraMode();
 	} else if (wasKeyPressed(KeyType::TOGGLE_DEBUG)) {
 		toggleDebug();
 	} else if (wasKeyPressed(KeyType::TOGGLE_PROFILER)) {
@@ -2575,6 +2580,7 @@ const ClientEventHandler Game::clientEventHandler[CLIENTEVENT_MAX] = {
 	{&Game::handleClientEvent_SetStars},
 	{&Game::handleClientEvent_OverrideDayNigthRatio},
 	{&Game::handleClientEvent_CloudParams},
+	{&Game::handleClientEvent_UpdateCamera},
 };
 
 void Game::handleClientEvent_None(ClientEvent *event, CameraOrientation *cam)
@@ -2879,6 +2885,13 @@ void Game::handleClientEvent_CloudParams(ClientEvent *event, CameraOrientation *
 	clouds->setSpeed(v2f(event->cloud_params.speed_x, event->cloud_params.speed_y));
 }
 
+void Game::handleClientEvent_UpdateCamera(ClientEvent *event, CameraOrientation *cam)
+{
+	// no parameters to update here, this just makes sure the camera is in the
+	// state it should be after something was changed.
+	updateCameraMode();
+}
+
 void Game::processClientEvents(CameraOrientation *cam)
 {
 	while (client->hasClientEvents()) {
@@ -2935,12 +2948,7 @@ void Game::updateCamera(f32 dtime)
 	ClientEnvironment &env = client->getEnv();
 	LocalPlayer *player = env.getLocalPlayer();
 
-	/*
-		For interaction purposes, get info about the held item
-		- What item is it?
-		- Is it a usable item?
-		- Can it point to liquids?
-	*/
+	// For interaction purposes, get info about the held item
 	ItemStack playeritem;
 	{
 		ItemStack selected, hand;
@@ -2950,23 +2958,6 @@ void Game::updateCamera(f32 dtime)
 	ToolCapabilities playeritem_toolcap =
 		playeritem.getToolCapabilities(itemdef_manager);
 
-	if (wasKeyPressed(KeyType::CAMERA_MODE)) {
-		GenericCAO *playercao = player->getCAO();
-
-		// If playercao not loaded, don't change camera
-		if (!playercao)
-			return;
-
-		camera->toggleCameraMode();
-
-		if (g_touchcontrols)
-			g_touchcontrols->setUseCrosshair(!isTouchCrosshairDisabled());
-
-		// Make the player visible depending on camera mode.
-		playercao->updateMeshCulling();
-		playercao->setChildrenVisible(camera->getCameraMode() > CAMERA_MODE_FIRST);
-	}
-
 	float full_punch_interval = playeritem_toolcap.full_punch_interval;
 	float tool_reload_ratio = runData.time_from_last_punch / full_punch_interval;
 
@@ -2981,6 +2972,25 @@ void Game::updateCamera(f32 dtime)
 	}
 }
 
+void Game::updateCameraMode()
+{
+	LocalPlayer *player = client->getEnv().getLocalPlayer();
+
+	// Obey server choice
+	if (player->allowed_camera_mode != CAMERA_MODE_ANY)
+		camera->setCameraMode(player->allowed_camera_mode);
+
+	if (g_touchcontrols)
+		g_touchcontrols->setUseCrosshair(!isTouchCrosshairDisabled());
+
+	GenericCAO *playercao = player->getCAO();
+	if (playercao) {
+		// Make the player visible depending on camera mode.
+		playercao->updateMeshCulling();
+		playercao->setChildrenVisible(camera->getCameraMode() > CAMERA_MODE_FIRST);
+	}
+}
+
 void Game::updateCameraOffset()
 {
 	ClientEnvironment &env = client->getEnv();
@@ -3057,6 +3067,9 @@ void Game::processPlayerInteraction(f32 dtime, bool show_hud)
 	core::line3d<f32> shootline;
 
 	switch (camera->getCameraMode()) {
+	case CAMERA_MODE_ANY:
+		assert(false);
+		break;
 	case CAMERA_MODE_FIRST:
 		// Shoot from camera position, with bobbing
 		shootline.start = camera->getPosition();