Package de.javagl.ply

Interface Descriptor

  • All Known Subinterfaces:
    MutableDescriptor
    public interface Descriptor
    A description of the structure of PLY data. This resembles the information that is given in the header of a PLY file, except for the numbers of elements.

    • Method Detail

      • getComments

        List<String> getComments()
        Returns an unmodifiable list of comments that appeared in the PLY file
        Returns:
        The comments

      • getElementName

        String getElementName​(int elementTypeIndex)
        Returns the name of the specified element type
        Parameters:
        elementTypeIndex - The element type index
        Returns:
        The name
        Throws:
        IndexOutOfBoundsException - If the index is negative or not smaller than the number of element types

      • getPropertyName

        String getPropertyName​(int elementTypeIndex,
                       int propertyIndex)
        Returns the name of the specified property
        Parameters:
        elementTypeIndex - The element type index
        propertyIndex - The property index
        Returns:
        The name
        Throws:
        IndexOutOfBoundsException - If the element type index is negative or not smaller than the number of element types, or the property index is negative or not smaller than the number of properties

      • getPropertyType

        PlyType getPropertyType​(int elementTypeIndex,
                        int propertyIndex)
        Returns the type of the specified property
        Parameters:
        elementTypeIndex - The element type index
        propertyIndex - The property index
        Returns:
        The type
        Throws:
        IndexOutOfBoundsException - If the element type index is negative or not smaller than the number of element types, or the property index is negative or not smaller than the number of properties

      • getPropertySizeType

        PlyType getPropertySizeType​(int elementTypeIndex,
                            int propertyIndex)
        Returns the size type of the specified property, or null if the specified property is not a list property.
        Parameters:
        elementTypeIndex - The element type index
        propertyIndex - The property index
        Returns:
        The name
        Throws:
        IndexOutOfBoundsException - If the element type index is negative or not smaller than the number of element types, or the property index is negative or not smaller than the number of properties