MeshDescription

java.lang.Object
- org.eclipse.eavp.viz.service.mesh.datastructures.MeshDescription

All Implemented Interfaces:

IMeshDescription
```
public class MeshDescription
extends java.lang.Object
implements IMeshDescription
```
This class holds all the information required to represent a mesh from the Mesh Editor in compact form for easy persistence. This class expects its input to be NekPolygonControllers with DetailedEdgeController and VertexController children. No two faces can share the same MeshProperty.ID value, nor can any two vertices. Not all properties are preserved between the tree fed to the MeshDescription as input and the unpacked output. Transformation information is removed except for the translations of the vertices, as is all property information except ID numbers. The ID MeshProperty for edges may also be changed by the process. The XML output from a persisted MeshDescription will be in the following format: FaceID, GroupNumber, MaterialID; EdgeID1, BoundaryConditionType1 BoundaryConditionValues1, BoundaryConditionType2 BoundaryConditionValues2; EdgeID2, BoundaryConditionType... FaceID, GroupNumber, MaterialID; EdgeID1, BoundaryConditionType1 BoundaryConditionValues1, BoundaryConditionType2 BoundaryConditionValues2; EdgeID2, BoundaryConditionType... ... VertexID X Y Z VertexID X Y Z ... The facesBlock will be formatted with each face on its own line. The first segment will have information about the entire face and end with a semicolon. Each other segment, all delimited by semicolons, will have information on a single edge. These segments will start with the EdgeID. An Edge's ID will be set such that Floor(EdgeID / (Highest VertexID + 1)) = The first endpoint's ID EdgeID % (Highest VertexID + 1) = The second endpoint's ID For non-directed meshes, an Edge will have the lower of its two possible IDs. The EdgeID will be followed by segments delimited by commas. These will feature the type of the BoundaryCondition (or empty space to denote the default type of "None") and a list of five floats separated by spaces (or empty space to denote the default value of five zeroes.). The first of the boundary conditions will be the fluid boundary condition, and the second will be the thermal boundary condition. The verticesBlock will be formatted with each vertex on its own line. Each line will have four numbers: the vertexID followed by its x, y, and z coordinates as doubles, all separated by spaces. The intended use for this class is for a hierarchy of objects for a Mesh Editor, collected under a single root node represented by a BasicController, to be persisted in JAXB through the use of a getter function for a virtual field or an XMLAdapter, which will be responsible for creating the MeshDescription from the data hierarchy and for restoring a data hierarchy given a valid MeshDescription from JAXB.

Author:

Robert Smith

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MeshDescription.EdgeLine` A temporary internal representation of a segment of a FaceLine defining an Edge.
`static class`	`MeshDescription.FaceLine` A temporary internal representation of a line of the faces xml block
`static class`	`MeshDescription.VertexLine` A temporary internal representation of a line of the vertices xml block

Constructor Summary

Constructors
Constructor and Description

MeshDescription()
The default constructor.

MeshDescription(IController root)
A constructor that creates a compacted description of a mesh.

Constructors
Constructor and Description
`MeshDescription()` The default constructor.
`MeshDescription(IController root)` A constructor that creates a compacted description of a mesh.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Create a deep copy duplicate of this object.
`void`	`copy(IMeshDescription source)` Copy the source object's data into this, making it into a copy.
`boolean`	`equals(java.lang.Object otherObject)`
`java.util.ArrayList<java.util.HashMap<java.lang.Integer,EdgeProperties>>`	`getEdgeProperties()` Getter method for the edge properties.
`int[]`	`getEdges()` Getter method for the edges.
`int[]`	`getFaces()` Getter method for the faces.
`java.util.ArrayList<MeshDescription.FaceLine>`	`getFacesBlock()` Get the information about the mesh's faces formatted into a list of FaceLines.
`java.util.ArrayList<PolygonProperties>`	`getPolygonProperties()` Getter method for the polygon properties
`double[][]`	`getTransformations()` Getter method for the transformation.
`int[]`	`getVertices()` Getter method for the vertices.
`java.util.ArrayList<MeshDescription.VertexLine>`	`getVerticesBlock()` Get the information about the mesh's vertices formatted into a block of VertexLines.
`int`	`hashCode()`
`void`	`setEdgeProperties(java.util.ArrayList<java.util.HashMap<java.lang.Integer,EdgeProperties>> properties)` Setter method for the edge properties.
`void`	`setEdges(int[] edges)` Setter method for the edges.
`void`	`setFaces(int[] faces)` Setter method for the faces.
`void`	`setFacesBlock(java.util.ArrayList<MeshDescription.FaceLine> block)` Set the information about the mesh's faces formatted into a block of FaceLines.
`void`	`setPolygonProperties(java.util.ArrayList<PolygonProperties> polygonProperties)` Setter method for the polygon properties.
`void`	`setTransformations(double[][] transformations)` Setter method for the transformations.
`void`	`setVertices(int[] vertices)` Setter method for the vertices.
`void`	`setVerticesBlock(java.util.ArrayList<MeshDescription.VertexLine> block)` Set the information about the mesh's vertices formatted into a block of VertexLines.
`IController`	`unpack(IControllerProviderFactory factory)` Unpack the condensed representation into a full set of modeling data objects.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MeshDescription
```
public MeshDescription()
```
    The default constructor.
  - MeshDescription
```
public MeshDescription(IController root)
```
    A constructor that creates a compacted description of a mesh.
    
    Parameters:
    
    root - The root of the mesh that is to be described.
- Method Detail
  - getEdges
```
public int[] getEdges()
```
    Description copied from interface: IMeshDescription
    
    Getter method for the edges.
    
    Specified by:
    
    getEdges in interface IMeshDescription
    
    Returns:
    
    An array of global ids for the edges, along with their endpoints as indices into the vertices array
  - getFaces
```
public int[] getFaces()
```
    Description copied from interface: IMeshDescription
    
    Getter method for the faces.
    
    Specified by:
    
    getFaces in interface IMeshDescription
    
    Returns:
    
    An array of global ids for the faces, along with their constituent edges as indices into the edges array
  - getEdgeProperties
```
public java.util.ArrayList<java.util.HashMap<java.lang.Integer,EdgeProperties>> getEdgeProperties()
```
    Description copied from interface: IMeshDescription
    
    Getter method for the edge properties.
    
    Specified by:
    
    getEdgeProperties in interface IMeshDescription
    
    Returns:
    
    A list of maps between integer ids for edges and their edge properties, one for each face in the faces array
  - getPolygonProperties
```
public java.util.ArrayList<PolygonProperties> getPolygonProperties()
```
    Description copied from interface: IMeshDescription
    
    Getter method for the polygon properties
    
    Specified by:
    
    getPolygonProperties in interface IMeshDescription
    
    Returns:
    
    A list of all the PolygonProperties in the hierarchy in the same order as their corresponding polygons in the faces array
  - getTransformations
```
public double[][] getTransformations()
```
    Description copied from interface: IMeshDescription
    
    Getter method for the transformation.
    
    Specified by:
    
    getTransformations in interface IMeshDescription
    
    Returns:
    
    An array of numbers representing the spatial data for a modeling object. Each object's data begins at location (12 * their global ID) and is stored as three values representing the x, y, and z directions for each of the four attributes (rotation, scale, skew, and translation).
  - getVertices
```
public int[] getVertices()
```
    Description copied from interface: IMeshDescription
    
    Getter method for the vertices.
    
    Specified by:
    
    getVertices in interface IMeshDescription
    
    Returns:
    
    An array of global ids for the vertices
  - setEdges
```
public void setEdges(int[] edges)
```
    Description copied from interface: IMeshDescription
    
    Setter method for the edges.
    
    Specified by:
    
    setEdges in interface IMeshDescription
    
    Parameters:
    
    edges - An array of global ids for the edges, along with their endpoints as indices into the vertices array
  - setFaces
```
public void setFaces(int[] faces)
```
    Description copied from interface: IMeshDescription
    
    Setter method for the faces.
    
    Specified by:
    
    setFaces in interface IMeshDescription
    
    Parameters:
    
    faces - An array of global ids for the faces, along with their constituent edges as indices into the edges array
  - setEdgeProperties
```
public void setEdgeProperties(java.util.ArrayList<java.util.HashMap<java.lang.Integer,EdgeProperties>> properties)
```
    Description copied from interface: IMeshDescription
    
    Setter method for the edge properties.
    
    Specified by:
    
    setEdgeProperties in interface IMeshDescription
    
    Parameters:
    
    properties - A list of maps between integer ids for edges and their edge properties, one for each face in the faces array
  - setPolygonProperties
```
public void setPolygonProperties(java.util.ArrayList<PolygonProperties> polygonProperties)
```
    Description copied from interface: IMeshDescription
    
    Setter method for the polygon properties.
    
    Specified by:
    
    setPolygonProperties in interface IMeshDescription
    
    Parameters:
    
    polygonProperties - A list of the PolygonProperties in the mesh, in the same order as their corresponding polygons are in the faces array.
  - setTransformations
```
public void setTransformations(double[][] transformations)
```
    Description copied from interface: IMeshDescription
    
    Setter method for the transformations.
    
    Specified by:
    
    setTransformations in interface IMeshDescription
    
    Parameters:
    
    transformations - An array of numbers representing the spatial data for a modeling object. Each object's data begins at location (12 * their global ID) and is stored as three values representing the x, y, and z directions for each of the four attributes (rotation, scale, skew, and translation).
  - setVertices
```
public void setVertices(int[] vertices)
```
    Setter method for the vertices.
    
    Parameters:
    
    vertices - An array of global ids for the vertices
  - unpack
```
public IController unpack(IControllerProviderFactory factory)
```
    Description copied from interface: IMeshDescription
    
    Unpack the condensed representation into a full set of modeling data objects.
    
    Specified by:
    
    unpack in interface IMeshDescription
    
    Parameters:
    
    factory - The factory that will create the rendering engine appropriate IControllers for the meshes.
    
    Returns:
    
    The root node of a data structure containing the mesh represented by this object, in the form of a collection of IControllers, IMeshes, and IView
  - getFacesBlock
```
public java.util.ArrayList<MeshDescription.FaceLine> getFacesBlock()
```
    Description copied from interface: IMeshDescription
    
    Get the information about the mesh's faces formatted into a list of FaceLines. This method is used for persistence by JAXB and is not intended to be called.
    
    Specified by:
    
    getFacesBlock in interface IMeshDescription
    
    Returns:
    
    A list of all the lines in an xml block defininf the faces
  - setFacesBlock
```
public void setFacesBlock(java.util.ArrayList<MeshDescription.FaceLine> block)
```
    Description copied from interface: IMeshDescription
    
    Set the information about the mesh's faces formatted into a block of FaceLines. This method is used for persistence with JAXB and is not intended to be called
    
    Specified by:
    
    setFacesBlock in interface IMeshDescription
    
    Parameters:
    
    block - A list of all lines in the xml block defining the faces
  - getVerticesBlock
```
public java.util.ArrayList<MeshDescription.VertexLine> getVerticesBlock()
```
    Description copied from interface: IMeshDescription
    
    Get the information about the mesh's vertices formatted into a block of VertexLines. This method is used for persistence with JAXB and is not intended to be called.
    
    Specified by:
    
    getVerticesBlock in interface IMeshDescription
    
    Returns:
    
    A list of all the lines in the xml block defining the vertices
  - setVerticesBlock
```
public void setVerticesBlock(java.util.ArrayList<MeshDescription.VertexLine> block)
```
    Description copied from interface: IMeshDescription
    
    Set the information about the mesh's vertices formatted into a block of VertexLines. This method is used for persistence with JAXB and is not intended to be called
    
    Specified by:
    
    setVerticesBlock in interface IMeshDescription
    
    Parameters:
    
    block - A list of all lines in the xml block defining the vertices
  - clone
```
public java.lang.Object clone()
```
    Description copied from interface: IMeshDescription
    
    Create a deep copy duplicate of this object.
    
    Specified by:
    
    clone in interface IMeshDescription
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    An IMeshDescription with identical values as this object.
  - copy
```
public void copy(IMeshDescription source)
```
    Description copied from interface: IMeshDescription
    
    Copy the source object's data into this, making it into a copy.
    
    Specified by:
    
    copy in interface IMeshDescription
    
    Parameters:
    
    source - The object of which this should be made into a copy
  - equals
```
public boolean equals(java.lang.Object otherObject)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class MeshDescription

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MeshDescription

MeshDescription

Method Detail

getEdges

getFaces

getEdgeProperties

getPolygonProperties

getTransformations

getVertices

setEdges

setFaces

setEdgeProperties

setPolygonProperties

setTransformations

setVertices

unpack

getFacesBlock

setFacesBlock

getVerticesBlock

setVerticesBlock

clone

copy

equals

hashCode