Merge pull request #5444 from Goober5000/5401_followup

refinements of jump node features

Author: TRBlount

code/hud/hudbrackets.cpp

@@ -675,10 +675,7 @@ void HudGaugeBrackets::renderBoundingBrackets(int x1, int y1, int x2, int y2, in
 					if(jnp->GetSCPObject() == t_objp)
 						break;
 				}
-				
-				strcpy_s(temp_name, jnp->GetDisplayName());
-				end_string_at_first_hash_symbol(temp_name);
-				tinfo_name = temp_name;
+				tinfo_name = jnp->GetDisplayName();
 				break;
 		}
 

code/hud/hudtargetbox.cpp

@@ -1320,9 +1320,7 @@ void HudGaugeTargetBox::renderTargetJumpNode(object *target_objp)
 		renderTargetIntegrity(1);
 		setGaugeColor();
 
-		strcpy_s(outstr, jnp->GetDisplayName());
-		end_string_at_first_hash_symbol(outstr);
-		renderString(position[0] + Name_offsets[0], position[1] + Name_offsets[1], EG_TBOX_NAME, outstr);	
+		renderString(position[0] + Name_offsets[0], position[1] + Name_offsets[1], EG_TBOX_NAME, jnp->GetDisplayName());
 
 		dist = Player_ai->current_target_distance;
 		if ( Hud_unit_multiplier > 0.0f ) {	// use a different displayed distance scale

code/jumpnode/jumpnode.cpp

@@ -39,11 +39,9 @@ CJumpNode::CJumpNode(const vec3d* position)
 
 	gr_init_alphacolor(&m_display_color, 0, 255, 0, 255);
 
-	// Set m_name
+	// Set m_name and m_display
 	sprintf(m_name, XSTR( "Jump Node %d", 632), Jump_nodes.size());
-
-	// Set m_display
-	sprintf(m_display, XSTR("Jump Node %d", 632), Jump_nodes.size());
+	m_display[0] = '\0';
 
 	// Set m_modelnum and m_radius
 	m_modelnum = model_load(NOX(JN_DEFAULT_MODEL), 0, NULL, 0);
@@ -145,7 +143,10 @@ const char *CJumpNode::GetName()
  */
 const char* CJumpNode::GetDisplayName()
 {
-	return m_display;
+	if (HasDisplayName())
+		return m_display;
+	else
+		return m_name;
 }
 
 /**
@@ -214,7 +215,15 @@ void CJumpNode::SetAlphaColor(int r, int g, int b, int alpha)
 	CLAMP(b, 0, 255);
 	CLAMP(alpha, 0, 255);
 
-	m_flags |= JN_USE_DISPLAY_COLOR;
+	// see whether this is actually the default color
+	// (which actually means to use the HUD color rather than this exact color;
+	// it might be useful to change this design in the future, but beware of
+	// FRED calling this function in the background)
+	if (r == 0 && g == 255 && b == 0 && alpha == 255)
+		m_flags &= ~JN_USE_DISPLAY_COLOR;
+	else
+		m_flags |= JN_USE_DISPLAY_COLOR;
+
 	gr_init_alphacolor(&m_display_color, r, g, b, alpha);
 }
 
@@ -266,20 +275,38 @@ void CJumpNode::SetName(const char *new_name)
 	CJumpNode* check = jumpnode_get_by_name(new_name);
 	Assertion((check == this || !check), "Jumpnode %s is being renamed to %s, but a jump node with that name already exists in the mission!\n", m_name, new_name);
 	#endif
-    
+
 	strcpy_s(m_name, new_name);
+
+	// if this name has a hash, create a default display name
+	if (get_pointer_to_first_hash_symbol(new_name))
+	{
+		strcpy_s(m_display, new_name);
+		end_string_at_first_hash_symbol(m_display);
+		m_flags |= JN_HAS_DISPLAY_NAME;
+	}
 }
 
 /**
- * Set jump node name
+ * Set jump node display name
  *
- * @param new_name New name to set
+ * @param new_display_name New name to set
  */
-void CJumpNode::SetDisplayName(const char* new_name)
+void CJumpNode::SetDisplayName(const char *new_display_name)
 {
-	Assert(new_name != NULL);
+	Assert(new_display_name != NULL);
 
-	strcpy_s(m_display, new_name);
+	// if display name is blank or matches the actual name, clear it
+	if (*new_display_name == '\0' || !stricmp(new_display_name, m_name))
+	{
+		*m_display = '\0';
+		m_flags &= ~JN_HAS_DISPLAY_NAME;
+	}
+	else
+	{
+		strcpy_s(m_display, new_display_name);
+		m_flags |= JN_HAS_DISPLAY_NAME;
+	}
 }
 
 /**
@@ -307,7 +334,7 @@ void CJumpNode::SetVisibility(bool enabled)
 /**
  * @return Is the jump node hidden when rendering?
  */
-bool CJumpNode::IsHidden()
+bool CJumpNode::IsHidden() const
 {
 	if(m_flags & JN_HIDE)
 		return true;
@@ -318,19 +345,27 @@ bool CJumpNode::IsHidden()
 /**
  * @return Is the jump node colored any other color than default white?
  */
-bool CJumpNode::IsColored()
+bool CJumpNode::IsColored() const
 {
 	return ((m_flags & JN_USE_DISPLAY_COLOR) != 0);
 }
 
 /**
  * @return Is the jump node model set differently from the default one?
  */
-bool CJumpNode::IsSpecialModel()
+bool CJumpNode::IsSpecialModel() const
 {
 	return ((m_flags & JN_SPECIAL_MODEL) != 0);
 }
 
+/**
+ * @return Does the jump node have a display name?
+ */
+bool CJumpNode::HasDisplayName() const
+{
+	return ((m_flags & JN_HAS_DISPLAY_NAME) != 0);
+}
+
 /**
 * Render jump node. Creates its own draw list to render
 *

code/jumpnode/jumpnode.h

@@ -27,6 +27,7 @@ class model_draw_list;
 #define JN_SHOW_POLYS				(1<<1)		//Display model normally, rather than as wireframe
 #define JN_HIDE						(1<<2)		//Hides a jump node
 #define JN_SPECIAL_MODEL			(1<<3)		//If non-default model
+#define JN_HAS_DISPLAY_NAME			(1<<4)		//If it has a display name
 
 #define JN_DEFAULT_MODEL            "subspacenode.pof"
 
@@ -76,9 +77,10 @@ class CJumpNode
     void SetVisibility(bool enabled);
 
     //Query
-    bool IsHidden();
-    bool IsColored();
-    bool IsSpecialModel();
+    bool IsHidden() const;
+    bool IsColored() const;
+    bool IsSpecialModel() const;
+    bool HasDisplayName() const;
 
     //Rendering
 	void Render(vec3d *pos, vec3d *view_pos = NULL);

code/mission/missionparse.cpp

@@ -5280,8 +5280,6 @@ void parse_waypoints_and_jumpnodes(mission *pm)
 		if (optional_string("+Display Name:")) {
 			stuff_string(jump_display_name, F_NAME, NAME_LENGTH);
 			jnp.SetDisplayName(jump_display_name);
-		} else {
-			jnp.SetDisplayName(jump_name);
 		}
 
 		if(optional_string("+Model File:")){

code/parse/sexp.cpp

@@ -35251,7 +35251,7 @@ int get_subcategory(int op_id)
 		case OP_SET_MOTION_DEBRIS:
 			return CHANGE_SUBCATEGORY_BACKGROUND_AND_NEBULA;
 
-		case OP_JUMP_NODE_SET_JUMPNODE_NAME: //
+		case OP_JUMP_NODE_SET_JUMPNODE_NAME:
 		case OP_JUMP_NODE_SET_JUMPNODE_DISPLAY_NAME:
 		case OP_JUMP_NODE_SET_JUMPNODE_COLOR:
 		case OP_JUMP_NODE_SET_JUMPNODE_MODEL:
@@ -39577,7 +39577,7 @@ SCP_vector<sexp_help_struct> Sexp_help = {
 		"\t4: Everywhere (optional).  Whether the effect is applied to all camera views.\r\n"
 	},
 
-	{ OP_JUMP_NODE_SET_JUMPNODE_NAME, "set-jumpnode-name\r\n"
+	{ OP_JUMP_NODE_SET_JUMPNODE_NAME, "set-jumpnode-name (deprecated in favor of set-jumpnode-display-name)\r\n"
 		"\tSets the name of a jump node. Takes 2 arguments...\r\n"
 		"\t1: Name of jump node to change name for\r\n"
 		"\t2: New name for jump node\r\n\r\n"

fred2/jumpnodedlg.cpp

@@ -68,6 +68,7 @@ BEGIN_MESSAGE_MAP(jumpnode_dlg, CDialog)
 	ON_BN_CLICKED(IDC_NODE_HIDDEN, OnHidden)
 	ON_WM_CLOSE()
 	ON_WM_INITMENU()
+	ON_EN_KILLFOCUS(IDC_NAME, OnKillfocusName)
 	//}}AFX_MSG_MAP
 END_MESSAGE_MAP()
 
@@ -181,7 +182,7 @@ int jumpnode_dlg::update_data()
 	if (!GetSafeHwnd())
 		return 0;
 
-	if (Objects[cur_object_index].type == OBJ_JUMP_NODE) {
+	if (query_valid_object() && Objects[cur_object_index].type == OBJ_JUMP_NODE) {
 		for (jnp = Jump_nodes.begin(); jnp != Jump_nodes.end(); ++jnp) {
 			if(jnp->GetSCPObject() == &Objects[cur_object_index])
 				break;
@@ -376,3 +377,20 @@ void jumpnode_dlg::OnHidden()
 
 	((CButton*)GetDlgItem(IDC_NODE_HIDDEN))->SetCheck(m_hidden);
 }
+
+void jumpnode_dlg::OnKillfocusName()
+{
+	char buffer[NAME_LENGTH];
+
+	// Note, in this dialog, UpdateData(TRUE) is not used to move data from controls to variables until the dialog is closed, so we edit the control text directly
+
+	// grab the name
+	GetDlgItemText(IDC_NAME, buffer, NAME_LENGTH);
+
+	// if this name has a hash, truncate it for the display name
+	if (get_pointer_to_first_hash_symbol(buffer))
+		end_string_at_first_hash_symbol(buffer);
+
+	// set the display name derived from this name
+	SetDlgItemText(IDC_ALT_NAME, buffer);
+}

fred2/jumpnodedlg.h

@@ -55,6 +55,7 @@ class jumpnode_dlg : public CDialog
 	afx_msg void OnInitMenu(CMenu* pMenu);
 	afx_msg void OnClose();
 	afx_msg void OnHidden();
+	afx_msg void OnKillfocusName();
 	//}}AFX_MSG
 	DECLARE_MESSAGE_MAP()
 };

fred2/missionsave.cpp

@@ -4610,14 +4610,22 @@ int CFred_mission_save::save_waypoints()
 
 		if (Mission_save_format != FSO_FORMAT_RETAIL) {
 
-			if (jnp->GetDisplayName()[0] != '\0') {
-				if (optional_string_fred("+Display Name:", "$Jump Node:")) {
-					parse_comments();
-				} else {
-					fout("\n+Display Name:");
+			// The display name is only written if there was one at the start to avoid introducing inconsistencies
+			if (jnp->HasDisplayName()) {
+				char truncated_name[NAME_LENGTH];
+				strcpy_s(truncated_name, jnp->GetName());
+				end_string_at_first_hash_symbol(truncated_name);
+
+				// Also, the display name is not written if it's just the truncation of the name at the hash
+				if (strcmp(jnp->GetDisplayName(), truncated_name) != 0) {
+					if (optional_string_fred("+Display Name:", "$Jump Node:")) {
+						parse_comments();
+					} else {
+						fout("\n+Display Name:");
+					}
+
+					fout_ext("", "%s", jnp->GetDisplayName());
 				}
-					
-				fout_ext("", "%s", jnp->GetDisplayName());
 			}
 
 			if (jnp->IsSpecialModel()) {

fred2/sexp_tree.cpp

@@ -1011,6 +1011,7 @@ void sexp_tree::right_clicked(int mode)
 							case OP_TRIGGER_SUBMODEL_ANIMATION:
 							case OP_ADD_BACKGROUND_BITMAP:
 							case OP_ADD_SUN_BITMAP:
+							case OP_JUMP_NODE_SET_JUMPNODE_NAME:
 								j = (int)op_menu.size();	// don't allow these operators to be visible
 								break;
 						}
@@ -1065,6 +1066,7 @@ void sexp_tree::right_clicked(int mode)
 							case OP_TRIGGER_SUBMODEL_ANIMATION:
 							case OP_ADD_BACKGROUND_BITMAP:
 							case OP_ADD_SUN_BITMAP:
+							case OP_JUMP_NODE_SET_JUMPNODE_NAME:
 								j = (int)op_submenu.size();	// don't allow these operators to be visible
 								break;
 						}