Interface Frame

    • Method Detail

      • coord

        java.lang.String[] coord()
        Returns coordinate names. The length of the coordinate vector is always 3.
        Returns:
        List of coordinate names.
      • coord

        Frame coord​(java.lang.String[] coordlist)
        Sets the coordinate names. The length of the coordinate vector is always 3.
        Parameters:
        coordlist - List of coordinate names.
        Returns:
        Frame.
      • coord

        Frame coord​(int pos,
                    java.lang.String coord)
        Set the coordinate name in position pos. The length of the coordinate vector is always 3.
        Parameters:
        pos - Position index.
        coord - Coordinate name.
        Returns:
        Frame.
      • geom

        java.lang.String geom()
        Returns the geometry.
        Returns:
        Geometry sequence tag.
      • geom

        Frame geom​(java.lang.String gtag)
        Sets the geometry.
        Parameters:
        gtag - Geometry sequence tag.
        Returns:
        Frame.
      • geometryFrame

        Frame geometryFrame()
        Sets this frame to be the geometry frame.
        Returns:
        Frame.
      • identifier

        java.lang.String identifier()
        Returns the frame's identifier.
        Returns:
        Frame identifier.
      • inPlaneCoord

        java.lang.String[] inPlaneCoord()
        Get the in-plane components of the coordinate vector, that is, the coordinate names for the geometry's dimension.
        Returns:
        Coordinate vector.
      • isGeometryFrame

        boolean isGeometryFrame()
        Checks if the frame is the geometry frame.
        Returns:
        true if geometry frame.
      • isMaterialFrame

        boolean isMaterialFrame()
        Checks if the frame is the material frame.
        Returns:
        true if material frame.
      • isMeshFrame

        boolean isMeshFrame()
        Checks if the frame is the mesh frame.
        Returns:
        true if mesh frame.
      • isSpatialFrame

        boolean isSpatialFrame()
        Checks if the frame is the spatial frame.
        Returns:
        true if spatial frame.
      • ismaterialframe

        @Deprecated
        boolean ismaterialframe()
        Deprecated.
        Use isMaterialFrame() instead.
      • ismeshframe

        @Deprecated
        boolean ismeshframe()
        Deprecated.
        Use isGeometryFrame() instead.
      • isspatialframe

        @Deprecated
        boolean isspatialframe()
        Deprecated.
        Use isSpatialFrame() instead.
      • materialFrame

        Frame materialFrame()
        Sets the frame to be the material frame.
        Returns:
        Frame.
      • meshFrame

        Frame meshFrame()
        Sets the frame to be the mesh frame.
        Returns:
        Frame.
      • sorder

        int sorder()
        Returns the geometry shape order.
        Returns:
        Geometry shape order.
      • spatialFrame

        Frame spatialFrame()
        Sets the frame to be the spatial frame.
        Returns:
        Frame.
      • sshape

        FrameFeatureList sshape()
        Returns all frame features.
        Returns:
        List of frame features.
      • sshape

        FrameFeature sshape​(java.lang.String tag)
        Returns a frame feature.
        Parameters:
        tag - Frame feature tag.
        Returns:
        Frame feature.
      • varNameSuffix

        java.lang.String varNameSuffix()
        Returns the variable name suffix of the frame.
        Returns:
        Variable name suffix.