Interface HumanFace

All Superinterfaces:
Serializable
All Known Implementing Classes:
HumanFaceImpl

public interface HumanFace extends Serializable
A single human face consisting of a mesh, feature points, space partitioning structures, and other data structures. The object contains only data about the face, the object can be stored in the database as a part of FaceWithDataEntity or in memory. This class does not include any metadata or additional information
  • Field Details

  • Method Details

    • isAverageFace

      boolean isAverageFace()
      Returns:
      is average face
    • getMeshModel

      MeshModel getMeshModel()
      Returns the triangular mesh model of the human face.
      Returns:
      the triangular mesh model of the human face
    • setSymmetryPlane

      void setSymmetryPlane(Plane plane)
      Sets the symmetry plane. If the input argument is null, then removes the plane.
      Parameters:
      plane - The new symmetry plane
    • getSymmetryPlane

      Plane getSymmetryPlane()
      Returns:
      The face's symmetry plane
    • hasSymmetryPlane

      boolean hasSymmetryPlane()
      Returns true if the face has the symmetry plane computed.
      Returns:
      true if the face has the symmetry plane computed.
    • getLandmarks

      Landmarks getLandmarks()
      Returns landmarks of the face.
      Returns:
      Landmarks of the face
    • getShortName

      String getShortName()
      Returns short name of the face without its path in the name. May not be unique.
      Returns:
      short name of the face without its path in the name
    • getOctree

      Octree getOctree()
      Returns already computed octree of the triangular mesh or null.
      Returns:
      Already computed octree of the triangular mesh or null
    • hasOctree

      boolean hasOctree()
      Checks if HumanFace has octree calculated
      Returns:
      true if yes and false if not
    • setOctree

      void setOctree(Octree octree)
      Sets the octree
      Parameters:
      octree - New octree. Can be null
    • getKdTree

      KdTree getKdTree()
      Returns already computed k-d tree of the triangular mesh or null.
      Returns:
      Already computed k-d tree of the triangular mesh or null
    • setKdTree

      void setKdTree(KdTree kdTree)
      Sets the k-d tree
      Parameters:
      kdTree - New k-d tree. Can be null
    • hasKdTree

      boolean hasKdTree()
      Checks if HumanFace has KdTree calculated
      Returns:
      true if yes and false if not
    • getLeftBalancedKdTree

      LeftBalancedKdTree getLeftBalancedKdTree()
      Returns already computed left-balanced k-d tree of the triangular mesh or null.
      Returns:
      Already computed left-balanced k-d tree of the triangular mesh or null
    • setLeftBalancedKdTree

      void setLeftBalancedKdTree(LeftBalancedKdTree kdTree)
      Sets the k-d tree left-balanced k-d tree.
      Parameters:
      kdTree - New left-balanced k-d tree. Can be null.
    • hasLeftBalancedKdTree

      boolean hasLeftBalancedKdTree()
      Checks if HumanFace has LeftBalancedKdTree calculated
      Returns:
      true if yes and false if not
    • getSurfaceMask

      SurfaceMask getSurfaceMask()
      Returns Interactive mask. The mask can be empty;
      Returns:
      the interactive mask
    • getState

      HumanFaceState getState()
      Returns a deep copy of current state.
      Returns:
      a deep copy of current state.
    • setState

      void setState(HumanFaceState state)
      Falls back to given state. No event is triggered - it up to the caller.
      Parameters:
      state - Old state. Must not be null
    • getGlyphs

      List<Glyph> getGlyphs()
      Gets the glyphs of the face or empty list
      Returns:
      list of glyphs or empty list
    • setGlyphs

      void setGlyphs(List<Glyph> glyphs)
      Sets the glyphs.
      Parameters:
      glyphs - Glyphs. Can be null
    • hasGlyphs

      boolean hasGlyphs()
      Checks if the human face has assigned glyphs
      Returns:
      true, if the glyphs exist
    • getBoundingBox

      Box getBoundingBox()
      Returns bounding box or null
      Returns:
      bounding box or null
    • setBoundingBox

      void setBoundingBox(Box boundingBox)
      Set a bounding box.
      Parameters:
      boundingBox - Bounding box or null
    • hasBoundingBox

      boolean hasBoundingBox()
      Checks if the human face has assigned a bounding box
      Returns:
      true, if the bounding box exists
    • setSurfaceMask

      void setSurfaceMask(SurfaceMask surfaceMask)
      Set a surface mask.
      Parameters:
      surfaceMask - surfaceMask or null
    • getFaceFrontalDirection

      Ray getFaceFrontalDirection()
      Gets face frontal direction.
      Returns:
      face frontal direction
    • setFaceFrontalDirection

      void setFaceFrontalDirection(Ray faceFrontalDirection)
      Set face frontal direction.
      Parameters:
      faceFrontalDirection - new face frontal direction
    • hasFaceFrontalDirection

      boolean hasFaceFrontalDirection()
      Checks face frontal direction is computed.
      Returns:
      true if face frontal direction exists