Interface ILcdEarthAssetCodec

All Known Implementing Classes:
TLcdEarthClippedRasterAssetCodec, TLcdEarthRasterAssetCodec

public interface ILcdEarthAssetCodec
Interface for a class that can encode and decode ILcdEarthAsset objects, thus supporting persistency for 3D terrain metadata. Assets are encoded and decoded by converting them to and from Properties objects. These objects, in turn, can be written to disk by TLcdEarthAssetModelCodec.
Since:
8.2
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Property name that is used to store the type name of an asset in a Properties object.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Returns true if this codec can create an ILcdEarthAsset based on the given Properties object.
    boolean
    Returns true if this codec can create a Properties object for the given ILcdEarthAsset.
    decodeAsset(Properties aProperties)
    Create an ILcdEarthAsset based on a Properties object.
    Create a Properties object based on an ILcdEarthAsset
    Returns a user-displayable name for this codec.
  • Field Details

  • Method Details

    • decodeAsset

      ILcdEarthAsset decodeAsset(Properties aProperties)
      Create an ILcdEarthAsset based on a Properties object.
      Parameters:
      aProperties - the properties of the asset
      Returns:
      a new ILcdEarthAsset
    • encodeAsset

      Properties encodeAsset(ILcdEarthAsset aAsset)
      Create a Properties object based on an ILcdEarthAsset
      Parameters:
      aAsset - the asset to encode into a Properties object
      Returns:
      a Properties object based on an ILcdEarthAsset
    • canDecodeAsset

      boolean canDecodeAsset(Properties aProperties)
      Returns true if this codec can create an ILcdEarthAsset based on the given Properties object.
      Parameters:
      aProperties - a Properties object representing an ILcdEarthAsset
      Returns:
      true if the properties can be decoded by this codec
    • canEncodeAsset

      boolean canEncodeAsset(ILcdEarthAsset aAsset)
      Returns true if this codec can create a Properties object for the given ILcdEarthAsset.
      Parameters:
      aAsset - the ILcdEarthAsset to be encoded
      Returns:
      true if this codec can encode the given asset
    • getDisplayName

      String getDisplayName()
      Returns a user-displayable name for this codec.
      Returns:
      a user-displayable name for this codec