Package mil.nga.geopackage.extension.nga.style

Class IconRow

java.lang.Object
mil.nga.geopackage.user.UserCoreRow<TColumn,TTable>
mil.nga.geopackage.user.UserRow<UserCustomColumn,UserCustomTable>
mil.nga.geopackage.user.custom.UserCustomRow
mil.nga.geopackage.extension.related.media.MediaRow
mil.nga.geopackage.extension.nga.style.IconRow
public class IconRow extends MediaRow
Icon Row containing the values from a single cursor row
Since:
3.2.0

  • Constructor Details

    • IconRow

      public IconRow()
      Constructor to create an empty row

    • IconRow

      public IconRow(IconTable table)
      Constructor to create an empty row
      Parameters:
      table - icon table

    • IconRow

      public IconRow(UserCustomRow userCustomRow)
      Constructor
      Parameters:
      userCustomRow - user custom row

    • IconRow

      public IconRow(IconRow iconRow)
      Copy Constructor
      Parameters:
      iconRow - icon row to copy

  • Method Details

    • getTable

      public IconTable getTable()
      Overrides:
      getTable in class MediaRow

    • isTableIcon

      public boolean isTableIcon()
      Is a table icon
      Returns:
      table icon flag
      Since:
      3.5.0

    • setTableIcon

      public void setTableIcon(boolean tableIcon)
      Set table icon flag
      Parameters:
      tableIcon - table icon flag
      Since:
      3.5.0

    • getNameColumnIndex

      public int getNameColumnIndex()
      Get the name column index
      Returns:
      name column index

    • getNameColumn

      public UserCustomColumn getNameColumn()
      Get the name column
      Returns:
      name column

    • getName

      public String getName()
      Get the name
      Returns:
      name

    • setName

      public void setName(String name)
      Set the name
      Parameters:
      name - Feature Icon name

    • getDescriptionColumnIndex

      public int getDescriptionColumnIndex()
      Get the description column index
      Returns:
      description column index

    • getDescriptionColumn

      public UserCustomColumn getDescriptionColumn()
      Get the description column
      Returns:
      description column

    • getDescription

      public String getDescription()
      Get the description
      Returns:
      description

    • setDescription

      public void setDescription(String description)
      Set the description
      Parameters:
      description - Feature Icon description

    • getWidthColumnIndex

      public int getWidthColumnIndex()
      Get the width column index
      Returns:
      width column index

    • getWidthColumn

      public UserCustomColumn getWidthColumn()
      Get the width column
      Returns:
      width column

    • getWidth

      public Double getWidth()
      Get the width
      Returns:
      width

    • setWidth

      public void setWidth(Double width)
      Set the width
      Parameters:
      width - Icon display width, when null use actual icon width

    • getDerivedWidth

      public double getDerivedWidth()
      Get the width or derived width from the icon data and scaled as needed for the height
      Returns:
      derived width

    • getHeightColumnIndex

      public int getHeightColumnIndex()
      Get the height column index
      Returns:
      height column index

    • getHeightColumn

      public UserCustomColumn getHeightColumn()
      Get the height column
      Returns:
      height column

    • getHeight

      public Double getHeight()
      Get the height
      Returns:
      height

    • setHeight

      public void setHeight(Double height)
      Set the height
      Parameters:
      height - Icon display height, when null use actual icon height

    • getDerivedHeight

      public double getDerivedHeight()
      Get the height or derived height from the icon data and scaled as needed for the width
      Returns:
      derived height

    • getDerivedDimensions

      public double[] getDerivedDimensions()
      Get the derived width and height from the values and icon data, scaled as needed
      Returns:
      derived dimensions array with two values, width at index 0, height at index 1

    • getAnchorUColumnIndex

      public int getAnchorUColumnIndex()
      Get the anchor u column index
      Returns:
      anchor u column index

    • getAnchorUColumn

      public UserCustomColumn getAnchorUColumn()
      Get the anchor u column
      Returns:
      anchor u column

    • getAnchorU

      public Double getAnchorU()
      Get the anchor u
      Returns:
      anchor u

    • setAnchorU

      public void setAnchorU(Double anchor)
      Set the anchor u
      Parameters:
      anchor - UV Mapping horizontal anchor distance inclusively between 0.0 and 1.0 from the left edge, when null assume 0.5 (middle of icon)

    • getAnchorUOrDefault

      public double getAnchorUOrDefault()
      Get the anchor u value or the default value of 0.5
      Returns:
      anchor u value

    • getAnchorVColumnIndex

      public int getAnchorVColumnIndex()
      Get the anchor v column index
      Returns:
      anchor v column index

    • getAnchorVColumn

      public UserCustomColumn getAnchorVColumn()
      Get the anchor v column
      Returns:
      anchor v column

    • getAnchorV

      public Double getAnchorV()
      Get the anchor v
      Returns:
      anchor v

    • setAnchorV

      public void setAnchorV(Double anchor)
      Set the anchor v
      Parameters:
      anchor - UV Mapping vertical anchor distance inclusively between 0.0 and 1.0 from the top edge, when null assume 1.0 (bottom of icon)

    • getAnchorVOrDefault

      public double getAnchorVOrDefault()
      Get the anchor v value or the default value of 1.0
      Returns:
      anchor v value

    • copy

      public IconRow copy()
      Copy the row
      Overrides:
      copy in class MediaRow
      Returns:
      row copy