Package kr.toxicity.model.api.data.raw

Record Class ModelElement.NullObject

java.lang.Object
java.lang.Record
kr.toxicity.model.api.data.raw.ModelElement.NullObject
Record Components:
name - the name of the null object
uuid - the UUID of the null object
ikTarget - the UUID of the IK target, if any
ikSource - the UUID of the IK source, if any
position - the position of the null object
All Implemented Interfaces:
ModelElement
Enclosing interface:
ModelElement
public static record ModelElement.NullObject(@NotNull String name, @NotNull String uuid, @Nullable String ikTarget, @Nullable String ikSource, @Nullable Float3 position) extends Record implements ModelElement
Represents a null object, often used for grouping or IK targets.
Since:
1.15.2

  • Constructor Details

    • NullObject

      public NullObject(@NotNull @NotNull String name, @NotNull @NotNull String uuid, @Nullable @Nullable String ikTarget, @Nullable @Nullable String ikSource, @Nullable @Nullable Float3 position)
      Creates an instance of a NullObject record class.
      Parameters:
      name - the value for the name record component
      uuid - the value for the uuid record component
      ikTarget - the value for the ikTarget record component
      ikSource - the value for the ikSource record component
      position - the value for the position record component

  • Method Details

    • type

      @NotNull public @NotNull String type()
      Description copied from interface: ModelElement
      Returns the type identifier of this element (e.g., "cube", "locator").
      Specified by:
      type in interface ModelElement
      Returns:
      the type string

    • position

      @NotNull public @NotNull Float3 position()
      Returns the position of the null object.
      Returns:
      the position, or Float3.ZERO if not specified
      Since:
      1.15.2

    • toBlueprint

      @NotNull public @NotNull BlueprintElement toBlueprint()
      Description copied from interface: ModelElement
      Converts this raw element into a processed BlueprintElement.
      Specified by:
      toBlueprint in interface ModelElement
      Returns:
      the blueprint element

    • 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.

    • name

      @NotNull public @NotNull String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • uuid

      @NotNull public @NotNull String uuid()
      Returns the value of the uuid record component.
      Specified by:
      uuid in interface ModelElement
      Returns:
      the value of the uuid record component

    • ikTarget

      @Nullable @SerializedName("ik_target") public @Nullable String ikTarget()
      Returns the value of the ikTarget record component.
      Returns:
      the value of the ikTarget record component

    • ikSource

      @Nullable @SerializedName("ik_source") public @Nullable String ikSource()
      Returns the value of the ikSource record component.
      Returns:
      the value of the ikSource record component