PolylineMesh (Artisynth API documentation)

java.lang.Object
- maspack.geometry.MeshBase
- - maspack.geometry.PolylineMesh

All Implemented Interfaces:

java.lang.Cloneable, HasRenderProps, IsRenderable, IsSelectable, Renderable
```
public class PolylineMesh
extends MeshBase
```
Implements a mesh consisting of a set of polylines.

Field Summary
- Fields inherited from class maspack.geometry.MeshBase
  XMeshToWorld
- Fields inherited from interface maspack.render.IsRenderable
  TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors
Constructor and Description
`PolylineMesh()` Creates an empty polyline mesh.
`PolylineMesh(java.io.File file)` Creates a polygonal mesh and initializes it from an file in Alias Wavefront obj format, as decribed for the method `write(PrintWriter,NumberFormat,boolean)`.
`PolylineMesh(PolylineMesh old)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Polyline`	`addLine(int[] indices)` Adds a line to this mesh.
`Polyline`	`addLine(Polyline line)` Adds a line to this mesh.
`Polyline`	`addLine(Vertex3d[] vertices)` Adds a line to this mesh.
`void`	`addMesh(PolylineMesh mesh)`
`void`	`addMesh(PolylineMesh mesh, boolean respectTransforms)` Adds copies of the vertices and lines of another mesh to this mesh.
`void`	`clear()` Clears this mesh (makes it empty).
`void`	`clearBoundingInfo()` Invalidates bounding box information.
`PolylineMesh`	`clone()` Creates a clone of this mesh.
`PolylineMesh`	`copy()` Creates a copy of this mesh.
`RenderProps`	`createRenderProps(HasProperties host)` Creates an appropriate RenderProps for this Mesh.
`int[]`	`createVertexIndices()` Creates and returns the vertex indices associated with each geometric feature in this mesh.
`boolean`	`epsilonEquals(MeshBase base, double eps)` Tests to see if a mesh equals this one.
`AABBTree`	`getBVTree()`
`Polyline`	`getLine(int i)`
`java.util.ArrayList<Polyline>`	`getLines()` Returns this mesh's lines.
`int`	`getRenderSkip()`
`boolean`	`getWriteNormals()` Returns `true` if this mesh's normals should be written to a file.
`boolean`	`hasAutoNormalCreation()` Returns `true` if this mesh automatically creates a default set of normals if `MeshBase.getNormals()` is called and no normals have been explicitly set using `MeshBase.setNormals(java.util.List<maspack.matrix.Vector3d>, int[])`.
`void`	`invalidateBoundingInfo()` Invalidates bounding box information.
`int`	`numFeatures()` Returns the number of features in this mesh.
`int`	`numLines()` Returns the number of lines in this mesh.
`void`	`prerender(RenderProps props)`
`void`	`read(ReaderTokenizer rtok, boolean zeroIndexed)` Reads the contents of this mesh from a ReaderTokenizer.
`boolean`	`removeLine(Polyline line)` Removes a line from this mesh.
`void`	`render(Renderer renderer, RenderProps props, int flags)`
`void`	`replaceVertices(java.util.List<? extends Vertex3d> vtxs)`
`void`	`set(Point3d[] pnts, int[][] lineIndices)` Sets the vertex points and line associated with this mesh.
`void`	`setRenderSkip(int skip)` Number of lines to skip while rendering
`void`	`write(java.io.PrintWriter pw, NumberFormat fmt, boolean zeroIndexed)` Writes this mesh to a PrintWriter, using an Alias Wavefront "obj" file format.
`void`	`write(java.io.PrintWriter pw, java.lang.String fmtStr)` Writes this mesh to a PrintWriter, using an Alias Wavefront "obj" file as described for `write(PrintWriter,NumberFormat,boolean)`.

Methods inherited from class maspack.geometry.MeshBase
addVertex, addVertex, addVertex, addVertex, checksum, clearColors, clearNormals, clearTextureCoords, computeAverageRadius, computeCentroid, computeOBB, computeOBB, computeRadius, containsVertex, createFeatureIndices, createRenderProps, getColor, getColorIndices, getColorInterpolation, getColors, getFeatureColor, getFeatureColoringEnabled, getFeatureIndexOffsets, getFeatureNormal, getFeatureTextureCoords, getLocalBounds, getMeshToWorld, getMeshToWorld, getName, getNormal, getNormalIndices, getNormals, getRadius, getRenderHints, getRenderNormal, getRenderProps, getSelection, getTextureCoords, getTextureCoords, getTextureIndices, getVersion, getVertex, getVertexColoringEnabled, getVertexColorMixing, getVertices, getWorldBounds, getXMeshToWorldRender, hasColors, hasExplicitColors, hasExplicitNormals, hasNormals, hasTextureCoords, inverseTransform, inverseTransform, isColorsFixed, isEmpty, isFixed, isRenderBuffered, isSelectable, isTextureCoordsFixed, meshToWorldIsIdentity, notifyVertexPositionsModified, numColors, numNormals, numSelectionQueriesNeeded, numTextureCoords, numVertices, prerender, read, read, removeVertex, removeVertexFast, removeVertices, render, saveRenderInfo, scale, scale, setColor, setColor, setColor, setColor, setColorInterpolation, setColors, setColorsFixed, setFeatureColoringEnabled, setFixed, setMeshToWorld, setName, setNormal, setNormals, setRenderBuffered, setRenderProps, setTextureCoords, setTextureCoords, setTextureCoordsFixed, setVertexColoringEnabled, setVertexColorMixing, size, transform, transform, transformToLocal, transformToLocal, transformToOBB, transformToOBB, transformToWorld, transformToWorld, translate, translateToCentroid, updateBounds

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

- Constructor Detail
  - PolylineMesh
```
public PolylineMesh()
```
    Creates an empty polyline mesh.
  - PolylineMesh
```
public PolylineMesh(java.io.File file)
             throws java.io.IOException
```
    Creates a polygonal mesh and initializes it from an file in Alias Wavefront obj format, as decribed for the method write(PrintWriter,NumberFormat,boolean).
    
    Parameters:
    
    file - file containing the mesh description
    
    Throws:
    
    java.io.IOException
  - PolylineMesh
```
public PolylineMesh(PolylineMesh old)
```
- Method Detail
  - invalidateBoundingInfo
```
public void invalidateBoundingInfo()
```
    Description copied from class: MeshBase
    
    Invalidates bounding box information. Can also be overriden to mark any bounding volume hierarchies as invalid and in need of updating.
  - clearBoundingInfo
```
public void clearBoundingInfo()
```
    Description copied from class: MeshBase
    
    Invalidates bounding box information. Can also be overriden to clear any bounding volume hierarchies so that they need to be rebuilt.
  - createRenderProps
```
public RenderProps createRenderProps(HasProperties host)
```
    Creates an appropriate RenderProps for this Mesh. If the supplied host is non-null, then it is used to initialize any inherited properties. The property name associated with the host is assumed to be "renderProps".
    
    Specified by:
    
    createRenderProps in class MeshBase
    
    Parameters:
    
    host - if non-null, is used to initialize inherited values
    
    Returns:
    
    render properties appropriate for this mesh
  - getLines
```
public java.util.ArrayList<Polyline> getLines()
```
    Returns this mesh's lines. The line are contained within an ArrayList, each element of which is an array giving the vertex indices for the line.
    
    Returns:
    
    list of this mesh's lines.
  - numLines
```
public int numLines()
```
    Returns the number of lines in this mesh.
    
    Returns:
    
    number of lines in this mesh
  - read
```
public void read(ReaderTokenizer rtok,
                 boolean zeroIndexed)
          throws java.io.IOException
```
    Reads the contents of this mesh from a ReaderTokenizer. The input is assumed to be supplied in Alias Wavefront obj format, as described for the method write(PrintWriter,NumberFormat,boolean).
    
    Specified by:
    
    read in class MeshBase
    
    Parameters:
    
    rtok - tokenizer supplying the input description of the mesh
    
    zeroIndexed - if true, the index numbering for mesh vertices starts at 0. Otherwise, numbering starts at 1.
    
    Throws:
    
    java.io.IOException
  - set
```
public void set(Point3d[] pnts,
                int[][] lineIndices)
```
    Sets the vertex points and line associated with this mesh.
    
    Parameters:
    
    pnts - points from which the vertices are formed
    
    lineIndices - integer arrays giving the indices of each line. Each index should correspond to a particular point in pnts.
    
    Throws:
    
    java.lang.IllegalArgumentException - if a vertex index is out of bounds
  - addLine
```
public Polyline addLine(int[] indices)
```
    Adds a line to this mesh. A line is described by indices which specify its vertices.
    
    Parameters:
    
    indices - integer array giving the vertex indices of the line. Each index should correspond to a vertex presently associated with this mesh.
    
    Returns:
    
    the created line object
    
    Throws:
    
    java.lang.IllegalArgumentException - if a vertex index is out of bounds
  - addLine
```
public Polyline addLine(Vertex3d[] vertices)
```
    Adds a line to this mesh. A face is described by an array of vertices which comprise the line.
    
    Parameters:
    
    vertices - vertices comprising this line. Each vertex should be presently contained in this mesh.
    
    Returns:
    
    the created line object
    
    Throws:
    
    java.lang.IllegalArgumentException - if any vertices are not contained within this mesh
  - addLine
```
public Polyline addLine(Polyline line)
```
    Adds a line to this mesh.
    
    Parameters:
    
    line - Polyline to add to the mesh
    
    Returns:
    
    the created line object
  - removeLine
```
public boolean removeLine(Polyline line)
```
    Removes a line from this mesh.
    
    Parameters:
    
    line - line to remove
    
    Returns:
    
    false if the line does not belong to this mesh.
  - getLine
```
public Polyline getLine(int i)
```
  - write
```
public void write(java.io.PrintWriter pw,
                  java.lang.String fmtStr)
           throws java.io.IOException
```
    Writes this mesh to a PrintWriter, using an Alias Wavefront "obj" file as described for write(PrintWriter,NumberFormat,boolean). Index numbering starts at one, and the format used to print vertex coordinates is specified by a C printf style format string contained in the parameter fmtStr. For a description of the format string syntax, see NumberFormat. Good default choices for fmtStr are either "%g" (full precision), or "%.Ng", where N is the number of desired significant figures.
    
    Overrides:
    
    write in class MeshBase
    
    Parameters:
    
    pw - PrintWriter to write this mesh to
    
    fmtStr - string specifying format for writing the vertex coordinates
    
    Throws:
    
    java.io.IOException
  - write
```
public void write(java.io.PrintWriter pw,
                  NumberFormat fmt,
                  boolean zeroIndexed)
           throws java.io.IOException
```
    Writes this mesh to a PrintWriter, using an Alias Wavefront "obj" file format. Vertices are printed first, each starting with the letter "v" and followed by x, y, and z coordinates. Lines are printed next, starting with the letter "f" and followed by a list of integers which gives the indices of that line's vertices. An example of a simple three point line is:
```
    v 1.0 0.0 0.0
    v 0.0 1.0 0.0
    v 0.0 0.0 1.0
    l 0 1 2
 
```
    The format used to print vertex coordinates is specified by a NumberFormat.
    Specified by:
    
    write in class MeshBase
    
    Parameters:
    
    pw - PrintWriter to write this mesh to
    
    fmt - format for writing the vertex coordinates. If null, a format of "%.8g" is assumed.
    
    zeroIndexed - if true, index numbering for mesh vertices starts at 0. Otherwise, numbering starts at 1.
    
    Throws:
    
    java.io.IOException
  - clear
```
public void clear()
```
    Clears this mesh (makes it empty).
    
    Overrides:
    
    clear in class MeshBase
  - prerender
```
public void prerender(RenderProps props)
```
    Overrides:
    
    prerender in class MeshBase
  - render
```
public void render(Renderer renderer,
                   RenderProps props,
                   int flags)
```
    Specified by:
    
    render in class MeshBase
  - copy
```
public PolylineMesh copy()
```
    Creates a copy of this mesh.
    
    Overrides:
    
    copy in class MeshBase
  - clone
```
public PolylineMesh clone()
```
    Description copied from class: MeshBase
    
    Creates a clone of this mesh.
    
    Overrides:
    
    clone in class MeshBase
  - replaceVertices
```
public void replaceVertices(java.util.List<? extends Vertex3d> vtxs)
```
    Overrides:
    
    replaceVertices in class MeshBase
  - addMesh
```
public void addMesh(PolylineMesh mesh)
```
  - addMesh
```
public void addMesh(PolylineMesh mesh,
                    boolean respectTransforms)
```
    Adds copies of the vertices and lines of another mesh to this mesh.
    
    Parameters:
    
    mesh - Mesh to be added to this mesh
  - getBVTree
```
public AABBTree getBVTree()
```
  - setRenderSkip
```
public void setRenderSkip(int skip)
```
    Number of lines to skip while rendering
  - getRenderSkip
```
public int getRenderSkip()
```
  - epsilonEquals
```
public boolean epsilonEquals(MeshBase base,
                             double eps)
```
    Tests to see if a mesh equals this one. The meshes are equal if they are both PolylineMeshes, and their transforms, vertices, and lines are equal (within eps).
    
    Overrides:
    
    epsilonEquals in class MeshBase
  - createVertexIndices
```
public int[] createVertexIndices()
```
    Description copied from class: MeshBase
    Creates and returns the vertex indices associated with each geometric feature in this mesh.
    The indices are zero-based and specify the vertex indices for each mesh feature. The number of indices and their structure hence depends on the mesh subclass: for PolygonalMesh meshes, this gives the vertices for each face; for PolylineMesh, the vertices for each polyline, and for PointMesh, the vertices for each point. For example, assume that we have a PolygonalMesh with four vertices and four triangles arranged to form a tetrahedron, so that the vertex indices for each triangular face are given by (0, 2, 1), (0, 3, 2), (0, 1, 3), and (1, 2, 3). Then the returned vertex indices will be
```
   0 2 1  0 3 2  0 1 3  1 2 3
 
```
    Specified by:
    
    createVertexIndices in class MeshBase
    
    Returns:
    
    vertex indices for this mesh. Should not be modified.
  - numFeatures
```
public int numFeatures()
```
    Description copied from class: MeshBase
    
    Returns the number of features in this mesh. What a feature is depends on the mesh type: faces for PolygonalMesh, lines for PolylineMesh, points (which map to vertices) for PointMesh.
    
    Specified by:
    
    numFeatures in class MeshBase
    
    Returns:
    
    number of features in this mesh
  - hasAutoNormalCreation
```
public boolean hasAutoNormalCreation()
```
    Description copied from class: MeshBase
    
    Returns true if this mesh automatically creates a default set of normals if MeshBase.getNormals() is called and no normals have been explicitly set using MeshBase.setNormals(java.util.List<maspack.matrix.Vector3d>, int[]).
    
    Specified by:
    
    hasAutoNormalCreation in class MeshBase
    
    Returns:
    
    true if this mesh automatically creates normals.
  - getWriteNormals
```
public boolean getWriteNormals()
```
    Returns true if this mesh's normals should be written to a file. This will be the case if the normals were explicitly set, or if they were automatically created using information (such as hard edges) that cannot be easily reconstructed from the information written to standard file formats.
    
    Specified by:
    
    getWriteNormals in class MeshBase
    
    Returns:
    
    true if the normals should be written to a file

Class PolylineMesh

Field Summary

Fields inherited from class maspack.geometry.MeshBase

Fields inherited from interface maspack.render.IsRenderable

Constructor Summary

Method Summary

Methods inherited from class maspack.geometry.MeshBase

Methods inherited from class java.lang.Object

Constructor Detail

PolylineMesh

PolylineMesh

PolylineMesh

Method Detail

invalidateBoundingInfo

clearBoundingInfo

createRenderProps

getLines

numLines

read

set

addLine

addLine

addLine

removeLine

getLine

write

write

clear

prerender

render

copy

clone

replaceVertices

addMesh

addMesh

getBVTree

setRenderSkip

getRenderSkip

epsilonEquals

createVertexIndices

numFeatures

hasAutoNormalCreation

getWriteNormals