Godot4 テキストを持つControl派生クラスの判別方法(4.3暫定)

## [param control] のサイズにフィットするように、 [param text] を描画できる最適なフォントサイズを設定します。
## [param text] が空文字列の場合は何もしません。
## フォントサイズは、 [param control] の Theme Overrides の Font Size で設定します。	
static func fit_control_font_size(control: Control, text: String) -> void:
	# 表示するテキストが空文字列の場合は調整できないので何もしません。
	if text.length() == 0:
		return
	
	# コントロールのサイズを取得します。
	var control_size = control.size
	
	# コントロールの用いるフォントを取得します。
	var font: Font = get_control_font(control)
	
	# 描画サイズを測定するために、テキストを描画するオブジェクトを生成します。
	# RefCounted 派生なので消去は自動的に行われます。
	var text_paragraph: TextParagraph = TextParagraph.new()
	
	# フォントサイズを１ずつ増やしていき、コントロールのサイズからはみ出ない最大のフォントサイズを探します。
	var font_size = 1 # 初期フォントサイズ
	while true:
		# 指定したフォント・フォントサイズ・テキストを設定して、その描画サイズを取得します。
		text_paragraph.clear()
		text_paragraph.add_string(text, font, font_size)
		var text_size: Vector2 = text_paragraph.get_size()
		# テキストの描画サイズがコントロールのサイズ（横または縦）を超えた場合、その直前のフォントサイズで調整します。
		if control_size.x < text_size.x or control_size.y < text_size.y:
			break
		# テキストの描画サイズがコントロールのサイズを超えない場合、さらに 1 増やしたフォントサイズで確認を繰り返します。
		font_size += 1
	
	# コントロールからはみでないフォントサイズを設定します。
	# すでに Theme Overrides で設定されている Font Size は上書きされます。
	control.add_theme_font_size_override("font_size", font_size)
	return

## [param control] が用いるフォントを取得します。
static func get_control_font(control: Control) -> Font:
	# control が使用しているフォントを取得します。
	# theme から取得する関数の引数には、テーマリソースのフォントに関する項目名 "font" (snake_case)を指定します。
	# 参照：https://docs.godotengine.org/ja/4.x/classes/class_control.html#class-control-method-get-theme-color
	var font: Font = null
	if control.has_theme_font_override("font") or control.has_theme_font("font") == true:
		# テーマの font 項目または Control クラス派生のノードが持つ Theme Overrides の font 項目が設定されている場合
		# テーマから font 項目の値(Font)を取得します。
		font = control.get_theme_font("font") 
	else:
		# フォントが設定されていない場合
		# テーマのデフォルトの font 項目の値(Font)を取得します。
		font = control.get_theme_default_font()
	return font

## [param control] の表示テキストの文字列を返します。
## また、[Control] 以下のクラスを継承した、独自の派生クラスも String 型の text プロパティを持たせることで
## 本関数で表示テキストを取得できます。
##
## 現状は [method ScUtil.get_control_text_from_text_property] と同じです。
## しかし text プロパティ以外から表示テキストを得るクラスが追加された場合は、
## 本関数で、クラス判別、クラス名判別を用いて、拡張する予定です。
## そのため、表示テキストを得る場合は、本関数を使用してください。
##
## Godot 4.3 の Control クラスの派生クラスを確認すると、表示テキストは全て String 型の text プロパティでした。
## 該当クラスは Button, TextEdit, LinkButton, Label, LineEdit, RichTextLabel とその派生クラスです。
## https://docs.godotengine.org/ja/4.3/classes/class_control.html#class-control
static func get_control_text(control: Control) -> String:
	return get_control_text_from_text_property(control)

## [Control] 派生のクラスが text プロパティを持っている場合、その text 文字列を返します。
## これは [Control] 派生の表示するテキストがあるクラスが text という名前のプロパティに設定している特徴を利用するものです。
## また、公式ではない独自の [Control] 派生クラスにも対応する方法としても使えます。
##
## [method ScUtil.get_control_text] は、現状同じ処理ですが、 text プロパティ以外にも対応する関数です。
static func get_control_text_from_text_property(control: Control) -> String:
	if control.get("text") != null and control.text is String:
		# String 型の text プロパティを持っている場合
		return control.text
	return ""

# Thmee Overrides のフォントサイズのプロパティ名をクラスから判別します。
var font_size_property_name: String = "font_size"
if control is RichTextLabel:
	font_size_property_name = "normal_font_size"https://compota-soft.work/archives/46367

## [param control] の派生クラスの型に応じて、表示するテキストの文字列を返します。
## テキストを持たない Control 派生クラス、または、本関数で対応していないクラスについては空文字列 "" を返します。
## また、公式リファレンスにない独自 Control 派生クラスも text プロパティに表示するテキストを持たせることで、対応します。 
##
## Godot 4.3 の Control クラスの派生クラスを確認しました。String text プロパティがあるかどうかで判断しました。
## https://docs.godotengine.org/ja/4.3/classes/class_control.html#class-control
static func get_control_text(control: Control) -> String:
	var text = null
	
	# Button, TextEdit がテキストを持ち、その派生も text プロパティを持ちます。 
	if control is Button:
		text = control.text
	elif control is TextEdit:
		text = control.text
	elif control is LinkButton:
		text = control.text
	elif control is Label:
		text = control.text
	elif control is LineEdit:
		text = control.text
	elif control is RichTextLabel:
		text = control.text
	
	if text == null:
		# クラス名の文字列で個別に判定して、テキストを text 変数に設定します。
		var name_of_class :String = control.get_class()
		match name_of_class:
			# テキストを持たないクラスの場合。
			# テキストを持たないクラスから派生した独自クラスがテキストを持つ可能性があるので、
			# is による派生を含めたクラス判定は避け、テキストを持っていないことを確認したすべての派生クラスを個別に確認します。
			"Container", "AspectRatioContainer", "BoxContainer", "CenterContainer", "EditorProperty", \
			"FlowContainer", "GraphElement", "GridContainer", "MarginContainer", "PanelContainer", \
			"ScrollContainer", "SplitContainer", "SubViewportContainer", "TabContainer", \
			"TextureButton", "ColorRect", "NinePatchRect", "Panel", "Range", "EditorSpinSlider", \
			"ProgressBar", "ScrollBar", "Slider", "SpinBox", "TextureProgressBar", "ReferenceRect", \
			"Separator", "HSeparator", "VSeparator", "TabBar", "TextureRect", "Tree", "VideoStreamPlayer":
				text = ""
			# Control 派生かつ想定していないクラス（独自の Control 以下の派生クラスを想定）の場合
			_ :
				# 公式リファレンスにない独自の派生クラスなどへの対応です。 text プロパティを持っていればテキストを得ます。
				text = get_control_text_from_text_property(control)
				push_warning("ScUtil.gd get_control_text: 本関数でサポートされていない Control 派生クラスです。公式のクラスの場合、処理の追加を要望します。クラス名 = ", name_of_class)
	return text

## [Control] 派生のクラスが text プロパティを持っている場合、その text 文字列を返します。
## これは [Control] 派生の表示するテキストがあるクラスが text という名前のプロパティに設定している特徴を利用するものです。
## また、公式ではない独自の [Control] 派生クラスにも対応する方法としても使えます。
##
## [method ScUtil.get_control_text] は、現状同じ処理ですが、 text プロパティ以外にも対応する関数です。
static func get_control_text_from_text_property(control: Control) -> String:
	print("control = ", control)
	if control.get("text") != null and control.text is String:
		print("テキストプロパティを持っています。", control.text)
		# String 型の text プロパティを持っている場合
		return control.text
	print("テキストプロパティを持っていません。")
	return ""

found_nodes = [Label:<Label#1781807513615>, ColorRect:<ColorRect#1782411493421>]
control = Label:<Label#1781807513615>
テキストプロパティを持っています。Label
↓のPanel,ColorRectは
  テキストがない
　コントロールです
control = ColorRect:<ColorRect#1782411493421>
テキストプロパティを持っていません。