Package io.github.toxicity188.javamesh

Record Class MeshNamedImage

java.lang.Object
java.lang.Record
io.github.toxicity188.javamesh.MeshNamedImage
Record Components:
images - images keyed by material or texture file name
public record MeshNamedImage(@NotNull @Unmodifiable Map<String,MeshImage> images) extends Record
Stores mesh textures by name so parsed material references can be resolved during conversion. 

 var images = new MeshNamedImage(Map.of("blade.png", MeshImage.from(bufferedImage)));
 MeshImage blade = images.get("blade.png");
Since:
0.0.1

  • Field Details

  • Constructor Details

    • MeshNamedImage

      public MeshNamedImage(@NotNull @NotNull @Unmodifiable Map<String,MeshImage> images)
      Creates an instance of a MeshNamedImage record class.
      Parameters:
      images - the value for the images record component

  • Method Details

    • get

      @NotNull public @NotNull MeshImage get(@Nullable @Nullable String name)
      Resolves a texture by name and falls back to MeshImage.EMPTY when absent.
      Parameters:
      name - texture name referenced by a parsed mesh face
      Returns:
      the resolved image, or MeshImage.EMPTY when no texture is available
      Since:
      0.0.1

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • images

      @NotNull public @NotNull @Unmodifiable Map<String,MeshImage> images()
      Returns the value of the images record component.
      Returns:
      the value of the images record component