tip of the day #6841
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,246 @@ | ||
| /* | ||
| * Copyright (c) 2025 - The MegaMek Team. All Rights Reserved. | ||
| * | ||
| * This file is part of MegaMek. | ||
| * | ||
| * MegaMek is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * MegaMek is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with MegaMek. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
There was a problem hiding this comment. This still isn't the correct new copyright notice.
exeea marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| package megamek.common.util; | ||
|
|
||
| import java.awt.BasicStroke; | ||
| import java.awt.Color; | ||
| import java.awt.Component; | ||
| import java.awt.Dimension; | ||
| import java.awt.Font; | ||
| import java.awt.Graphics2D; | ||
| import java.awt.Rectangle; | ||
| import java.awt.RenderingHints; | ||
| import java.awt.Shape; | ||
| import java.awt.font.FontRenderContext; | ||
| import java.awt.font.LineBreakMeasurer; | ||
| import java.awt.font.TextAttribute; | ||
| import java.awt.font.TextLayout; | ||
| import java.awt.geom.AffineTransform; | ||
| import java.text.AttributedString; | ||
| import java.time.LocalDate; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import megamek.client.ui.swing.util.UIUtil; | ||
| import megamek.client.ui.swing.widget.SkinSpecification; | ||
| import megamek.client.ui.swing.widget.SkinSpecification.UIComponents; | ||
| import megamek.client.ui.swing.widget.SkinXMLHandler; | ||
| import megamek.common.internationalization.Internationalization; | ||
|
|
||
| /** | ||
| * @author Drake | ||
| * | ||
| * Provides a daily/random tip functionality | ||
| */ | ||
| public class TipOfTheDay { | ||
| // Enum for positioning the tip text | ||
| public enum Position { | ||
| TOP_BORDER, | ||
| BOTTOM_BORDER | ||
| } | ||
|
|
||
| private static final String TIP_BUNDLE_KEY = "TipOfTheDay.tip."; | ||
| private static final String TIP_BUNDLE_TITLE_KEY = "TipOfTheDay.title.text"; | ||
| private static final int TIP_BORDER_MARGIN = 40; | ||
| private static final int TIP_SIDE_PADDING = 20; | ||
| private static final float TIP_TITLE_FONT_SIZE = 14f; | ||
| private static final float TIP_FONT_SIZE = 18f; | ||
| private static final float STROKE_WIDTH = 3.0f; | ||
| private static final Color TIP_STROKE_COLOR = Color.BLACK; | ||
| private static final Color TIP_TITLE_FONT_COLOR = Color.WHITE; | ||
| private static final Color TIP_FONT_COLOR = Color.WHITE; | ||
| private final String bundleName; | ||
| private final int countTips; | ||
| private final String tipOfTheDay; | ||
| private final String tipLabel; | ||
| private Font tipFont; | ||
| private Font tipLabelFont; | ||
| private float scaleFactor; | ||
|
|
||
| /** | ||
| * Constructor for TipOfTheDay | ||
| * | ||
| * @param bundleName The name of the resource bundle containing the tips | ||
| * @param referenceComponent A component to determine scaling | ||
| */ | ||
| public TipOfTheDay(String bundleName, Component referenceComponent) { | ||
| this.bundleName = bundleName; | ||
| countTips = countTips(); | ||
| tipLabel = Internationalization.getTextAt(bundleName, TIP_BUNDLE_TITLE_KEY); | ||
| tipOfTheDay = getRandomTip(); | ||
| updateScaleFactor(referenceComponent); | ||
| } | ||
|
|
||
| /** | ||
| * Updates the scale factor and adjusts the font sizes accordingly. | ||
| * | ||
| * @param referenceComponent A component to determine scaling | ||
| */ | ||
| public void updateScaleFactor(Component referenceComponent) { | ||
| scaleFactor = (float) UIUtil.getResolutionScaleFactor(referenceComponent); | ||
| SkinSpecification skinSpec = SkinXMLHandler.getSkin(UIComponents.MainMenuBorder.getComp(), true); | ||
| Font baseFont = new Font(skinSpec.fontName, Font.PLAIN, skinSpec.fontSize); | ||
| tipLabelFont = baseFont.deriveFont(Font.BOLD, TIP_TITLE_FONT_SIZE * scaleFactor); // Tip title font | ||
| tipFont = baseFont.deriveFont(Font.BOLD, TIP_FONT_SIZE * scaleFactor); // Tip font | ||
| } | ||
|
|
||
| /** | ||
| * Count the number of tips in the resource bundle | ||
| */ | ||
| private int countTips() { | ||
| int count = 0; | ||
| try { | ||
| while (true) { | ||
| count++; | ||
| String tip = Internationalization.getTextAt(bundleName, TIP_BUNDLE_KEY + count); | ||
| if (tip.startsWith("!") && tip.endsWith("!")) { | ||
| return count - 1; | ||
| } | ||
| } | ||
| } catch (Exception e) { | ||
| // When we get an exception, we've found all tips | ||
| return count - 1; | ||
| } | ||
|
There was a problem hiding this comment. Has to be a better way to do this to get the number of tips. There was a problem hiding this comment. I don't see many other options: There was a problem hiding this comment. If you get the ? There was a problem hiding this comment. I was thinking making a resource file JUST for the tips for easier translation and just get the keys that way. The ResourceBundle will handle I18N for us anyways and I plan to update the I18N class itself to be more dynamic in nature with ability to have defaults for the class as well as add in additional bundles as needed. A way to keep the resource files smaller and easier to manage for translations. There was a problem hiding this comment. Ok then, let's do a dedicated file without Key=Value pairs structure |
||
| } | ||
|
|
||
| /** | ||
| * Gets the tip for today based on the current date | ||
| * | ||
| * @return A tip string for today | ||
| */ | ||
| public String getTodaysTip() { | ||
| LocalDate today = LocalDate.now(); | ||
| int dayOfYear = today.getDayOfYear(); | ||
| int tipIndex = (dayOfYear % countTips) + 1; | ||
| return Internationalization.getTextAt(bundleName, TIP_BUNDLE_KEY + tipIndex); | ||
| } | ||
|
|
||
| /** | ||
| * Gets a random tip from the list | ||
| * | ||
| * @return A random tip string | ||
| */ | ||
| public String getRandomTip() { | ||
| int randomIndex = (int) (Math.random() * countTips) + 1; | ||
| return Internationalization.getTextAt(bundleName, TIP_BUNDLE_KEY + randomIndex); | ||
| } | ||
|
|
||
| /** | ||
| * Draws the Tip of the Day text with word wrap and styling. | ||
| */ | ||
| public void drawTipOfTheDay(Graphics2D graphics2D, Rectangle referenceBounds, Position position) { | ||
| if (tipOfTheDay == null || tipOfTheDay.isEmpty() || tipLabelFont == null || tipFont == null) { | ||
| return; | ||
| } | ||
| if (referenceBounds == null || referenceBounds.width <= 0 || referenceBounds.height <= 0) { | ||
| return; // Cannot draw if referenceBounds is invalid | ||
| } | ||
| float availableWidth = referenceBounds.width - (TIP_SIDE_PADDING * 2); | ||
| if (availableWidth <= 0) | ||
| return; // Not enough space to draw | ||
|
|
||
| Graphics2D tipGraphics = (Graphics2D) graphics2D.create(); | ||
|
|
||
| try { | ||
| tipGraphics.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON); | ||
| tipGraphics.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON); | ||
| tipGraphics.setRenderingHint(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY); | ||
| tipGraphics.setRenderingHint(RenderingHints.KEY_STROKE_CONTROL, RenderingHints.VALUE_STROKE_PURE); | ||
|
|
||
| FontRenderContext frc = tipGraphics.getFontRenderContext(); | ||
|
|
||
| // "Tip of the Day:" label | ||
| AttributedString labelAS = new AttributedString(tipLabel); | ||
| labelAS.addAttribute(TextAttribute.FONT, tipLabelFont); | ||
| TextLayout labelLayout = new TextLayout(labelAS.getIterator(), frc); | ||
| float labelHeight = labelLayout.getAscent() + labelLayout.getDescent() + labelLayout.getLeading(); | ||
| float labelWidth = (float) labelLayout.getBounds().getWidth(); | ||
|
|
||
| // Actual tip text with word wrapping | ||
| AttributedString tipAS = new AttributedString(tipOfTheDay); | ||
| tipAS.addAttribute(TextAttribute.FONT, tipFont); | ||
| LineBreakMeasurer measurer = new LineBreakMeasurer(tipAS.getIterator(), frc); | ||
| List<TextLayout> tipLayouts = new ArrayList<>(); | ||
| float totalTipHeight = 0; | ||
| measurer.setPosition(0); | ||
| while (measurer.getPosition() < tipAS.getIterator().getEndIndex()) { | ||
| TextLayout layout = measurer.nextLayout(availableWidth); | ||
| if (layout != null) { | ||
| tipLayouts.add(layout); | ||
| totalTipHeight += layout.getAscent() + layout.getDescent() + layout.getLeading(); | ||
| } else { | ||
| break; // Should not happen with LineBreakMeasurer unless width is tiny | ||
| } | ||
| if (measurer.getPosition() == layout.getCharacterCount() + measurer.getPosition() | ||
| && measurer.getPosition() < tipAS.getIterator().getEndIndex()) { | ||
| break; | ||
| } | ||
exeea marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // Positioning// Positioning | ||
exeea marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| float totalBlockHeight = labelHeight + totalTipHeight; | ||
| float startY; | ||
| if (position == Position.BOTTOM_BORDER) { | ||
| startY = referenceBounds.y + referenceBounds.height - (TIP_BORDER_MARGIN * scaleFactor) - totalBlockHeight; | ||
| } else { | ||
| startY = referenceBounds.y + (TIP_BORDER_MARGIN * scaleFactor); | ||
| } | ||
| float startX = referenceBounds.x + TIP_SIDE_PADDING; | ||
|
|
||
| // Draw the text (outline then fill) | ||
| BasicStroke outlineStroke = new BasicStroke(STROKE_WIDTH * scaleFactor, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND); | ||
| tipGraphics.setStroke(outlineStroke); | ||
|
|
||
| // Draw Label | ||
| float labelDrawX = startX + (availableWidth - labelWidth) / 2; // Center label | ||
| float labelDrawY = startY + labelLayout.getAscent(); | ||
| Shape labelShape = labelLayout.getOutline(null); | ||
|
|
||
| tipGraphics.translate(labelDrawX, labelDrawY); | ||
| tipGraphics.setColor(TIP_STROKE_COLOR); | ||
| tipGraphics.draw(labelShape); // Draw outline | ||
| tipGraphics.setColor(TIP_TITLE_FONT_COLOR); // Fill color | ||
| tipGraphics.fill(labelShape); // Draw fill | ||
| tipGraphics.translate(-labelDrawX, -labelDrawY); // Translate back | ||
|
|
||
| // Draw Tip Lines | ||
| float currentY = startY + labelHeight; // Start drawing tips below the label | ||
| for (TextLayout tipLayout : tipLayouts) { | ||
| float lineAscent = tipLayout.getAscent(); | ||
| float lineHeight = lineAscent + tipLayout.getDescent() + tipLayout.getLeading(); | ||
| float lineDrawY = currentY + lineAscent; // Baseline for this line | ||
| float lineWidth = (float) tipLayout.getBounds().getWidth(); | ||
|
|
||
| float lineDrawX = startX + (availableWidth - lineWidth) / 2f; // Center line | ||
| lineDrawX = Math.max(startX, lineDrawX); // Ensure it doesn't go out of bounds | ||
| Shape tipShape = tipLayout.getOutline(AffineTransform.getTranslateInstance(lineDrawX, lineDrawY)); | ||
| tipGraphics.setColor(TIP_STROKE_COLOR); // Outline color | ||
| tipGraphics.draw(tipShape); // Draw outline | ||
| tipGraphics.setColor(TIP_FONT_COLOR); // Fill color | ||
| tipGraphics.fill(tipShape); // Draw fill | ||
|
|
||
| currentY += lineHeight; | ||
| } | ||
|
|
||
| } finally { | ||
| tipGraphics.dispose(); | ||
| } | ||
| } | ||
|
|
||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.