AmberFrost: LX86 moved page JCM:Scripting:Documentation:Dynamic Textures to JCM:Scripting/Dynamic Textures

2025-02-23T15:29:11Z

LX86 moved page JCM:Scripting:Documentation:Dynamic Textures to JCM:Scripting/Dynamic Textures

← Older revision	Revision as of 23:29, 23 February 2025
(No difference)

AmberFrost: Created page with "= Dynamic Textures = NTE provides a GraphicsTexture class to use JS-controlled textures with dynamic content on models for LCD displays, blinking indicators, scrolling text LED, and so on. === GraphicsTexture === {| class="wikitable" !Functions And Objects !Description |- |`new GraphicsTexture(width: int, height: int)` |To create a dynamic texture, you need to specify the width and height. If you plan to draw contents related to per-block/per-train, you shou..."

2024-11-03T14:50:48Z

Created page with "= Dynamic Textures = NTE provides a GraphicsTexture class to use JS-controlled textures with dynamic content on models for LCD displays, blinking indicators, scrolling text LED, and so on. === GraphicsTexture === {| class="wikitable" !Functions And Objects !Description |- |<code>new GraphicsTexture(width: int, height: int)</code> |To create a dynamic texture, you need to specify the width and height. If you plan to draw contents related to per-block/per-train, you shou..."

New page

= Dynamic Textures =
NTE provides a GraphicsTexture class to use JS-controlled textures with dynamic content on models for LCD displays, blinking indicators, scrolling text LED, and so on.

=== GraphicsTexture ===
{| class="wikitable"
!Functions And Objects
!Description
|-
|<code>new GraphicsTexture(width: int, height: int)</code>
|To create a dynamic texture, you need to specify the width and height.
If you plan to draw contents related to per-block/per-train, you should use this in the <code>create</code> function and store in <code>state</code>.
|-
|<code>GraphicsTexture.close(): void</code>
|Releases the memory used by this texture. It cannot be used after that.
If it was created in the <code>create</code> train function, it must be deleted in the <code>dispose</code> function, otherwise it will continue to occupy memory, thus creating a memory leak.
|-
|<code>GraphicsTexture.bufferedImage: BufferedImage</code>
|Java AWT's BufferedImage for use as a temporary canvas.
|-
|<code>GraphicsTexture.graphics: Graphics2D</code>
|This is the Java AWT's Graphics for this texture. You can call different functions to draw on the bufferedImage.
|-
|<code>GraphicsTexture.upload(): void</code>
|Loads the contents of bufferedImage into video memory and immediately displays it on the model.
This operation can significantly reduce FPS. It is recommended to use it in combination with <code>RateLimit</code> to reduce the frequency of texture updates.

For example, the screen can be updated only 10 times per second, and it may not be updated at far distances, in some cases the information may not be updated at all.
|-
|<code>GraphicsTexture.identifier: Identifier</code>
|The identifier of the virtual resource of this dynamic texture. You can use this to replace the model texture/draw a texture with this id.
|}

=== AWT-related classes ===
You can use the importPackage function from Rhino to satisfy the java.awt dependency when using AWT classes.

You can find some AWT tutorials on the Internet or look at the JavaDoc to see what drawing capabilities are available in Graphics2D:

* JavaDoc: [https://docs.oracle.com/javase/8/docs/api/java/awt/Graphics.html Graphics] (is a parent class for Graphics2D, which means everything in it can be used in GraphicsTexture.graphics as well)
* JavaDoc: [https://docs.oracle.com/javase/8/docs/api/java/awt/Graphics2D.html Graphics2D]

The following functions can be used:

* <code>static Color.decode</code>, <code>Color.WHITE…</code>, <code>new Color</code>
* <code>Graphics.setColor</code>, <code>Graphics.setFont</code>, <code>Graphics.setStroke(new BasicStroke(…))</code>
* <code>Graphics.drawRect</code>, <code>Graphics.fillRect</code>, <code>Graphics.drawRoundRect</code>, <code>Graphics.fillRoundRect</code>
* <code>Graphics.drawImage</code>, <code>Graphics.drawString</code>, <code>Font.deriveFont</code>
* <code>Graphics.setPaint(new GradientPaint(…))</code>, <code>Graphics.fill(new Rectangle(…))</code>
* <code>Graphics.getTransform</code>, <code>Graphics.transform</code>, <code>Graphics.setTransform</code>, <code>AffineTransform.getTranslateInstance</code>, <code>AffineTransform.getRotateInstance</code>
* <code>Graphics.setClip</code>
* <code>Graphics.getComposite</code>, <code>Graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER, …))</code>, <code>Graphics.setComposite</code>

=== Source ===

* https://wiki.minecrafttransitrailway.com/mtr_addon:nte:js:dynamic_texture

JCM:Scripting/Dynamic Textures - Revision history

AmberFrost: LX86 moved page JCM:Scripting:Documentation:Dynamic Textures to JCM:Scripting/Dynamic Textures