PointMesh (Artisynth API documentation)

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

All Implemented Interfaces:

java.lang.Cloneable, HasRenderProps, IsRenderable, IsSelectable, Renderable
```
public class PointMesh
extends MeshBase
```
Implements a mesh consisting of a set of points and possibly normals.

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
`PointMesh()` Creates an empty point mesh.
`PointMesh(java.io.File file)` Creates a point mesh and initializes it from a file, with the file format being inferred from the file name suffix
`PointMesh(java.lang.String fileName)` Creates a point mesh and initializes it from a file, with the file format being inferred from the file name suffix.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMesh(PointMesh mesh)`
`void`	`addMesh(PointMesh mesh, boolean respectTransforms)` Adds copies of the vertices of another mesh to this mesh.
`void`	`addVertex(Vertex3d vtx)` Adds a vertex to the set of vertices associated with this mesh.
`PointMesh`	`clone()` Creates a clone of this mesh.
`PointMesh`	`copy()` Creates a copy of this mesh.
`SpatialInertia`	`createInertia(double mass)` Computes a spatial inertia for this mesh, given a mass which is assumed to be distributed uniformly across its vertices.
`SpatialInertia`	`createInertia(double mass, MassDistribution dist)` Computes a spatial inertia for this mesh, given a mass and a mass distribution.
`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()` Returns a bounding volume tree to be used for proximity queries involving this mesh.
`double`	`getNormalRenderLen()`
`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[])`.
`int`	`numFeatures()` Returns the number of features in this mesh.
`void`	`prerender(RenderProps props)`
`void`	`read(ReaderTokenizer rtok, boolean zeroIndexed)` Reads the contents of this mesh from a ReaderTokenizer.
`void`	`readBinary(java.io.File file)`
`boolean`	`removeVertex(Vertex3d vtx)` Removes a vertex from this mesh.
`boolean`	`removeVertexFast(Vertex3d vtx)` Removes a vertex from this mesh.
`java.util.ArrayList<java.lang.Integer>`	`removeVertices(java.util.Collection<Vertex3d> vertices)` Removes a set of vertices from this mesh, as indicated by a collection.
`void`	`render(Renderer renderer, RenderProps props, int flags)`
`void`	`set(Point3d[] pnts, Vector3d[] nrms)` Sets the vertex points and normals associated with this mesh.
`void`	`setNormalRenderLen(double len)`
`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, checksum, clear, clearColors, clearNormals, clearRenderProps, clearTextureCoords, computeAverageRadius, computeCentroid, computeLocalBounds, computeOBB, computeOBB, computeRadius, computeWorldBounds, 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, isFeatureColored, isFixed, isRenderBuffered, isSelectable, isTextureCoordsFixed, isVertexColored, meshToWorldIsIdentity, notifyVertexPositionsModified, numColors, numNormals, numSelectionQueriesNeeded, numTextureCoords, numVertices, perturb, prerender, read, read, read, read, render, replaceVertices, saveRenderInfo, scale, scale, setColor, setColor, setColor, setColor, setColorInterpolation, setColors, setColorsFixed, setFeatureColoringEnabled, setFixed, setMeshToWorld, setName, setNormal, setNormals, setRenderBuffered, setRenderProps, setTextureCoords, setTextureCoords, setTextureCoordsFixed, setVertexColoringEnabled, setVertexColorMixing, size, supportsMassDistribution, transform, transform, transformToLocal, transformToLocal, transformToOBB, transformToOBB, transformToWorld, transformToWorld, translate, translateToCentroid, updateBounds, write, write, write

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

- Constructor Detail
  - PointMesh
```
public PointMesh()
```
    Creates an empty point mesh.
  - PointMesh
```
public PointMesh(java.lang.String fileName)
          throws java.io.IOException
```
    Creates a point mesh and initializes it from a file, with the file format being inferred from the file name suffix.
    
    Parameters:
    
    fileName - name of the file containing the mesh description
    
    Throws:
    
    java.io.IOException - if an I/O error occurred or if the file format is not compatible with point meshes
  - PointMesh
```
public PointMesh(java.io.File file)
          throws java.io.IOException
```
    Creates a point mesh and initializes it from a file, with the file format being inferred from the file name suffix
    
    Parameters:
    
    file - file containing the mesh description
    
    Throws:
    
    java.io.IOException - if an I/O error occurred or if the file format is not compatible with point meshes
- Method Detail
  - 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
  - getNormalRenderLen
```
public double getNormalRenderLen()
```
  - setNormalRenderLen
```
public void setNormalRenderLen(double len)
```
  - readBinary
```
public void readBinary(java.io.File file)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - 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,
                Vector3d[] nrms)
```
    Sets the vertex points and normals associated with this mesh.
    
    Parameters:
    
    pnts - points from which the vertices are formed
    
    nrms - (optional) if non-null, gives vectors from which the normals are formed.
    
    Throws:
    
    java.lang.IllegalArgumentException - if nrms is non-null and does not have the same size as pnts.
  - 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. Normals, if present, are printed next, starting with the letter "vn" and followed by x, y, and z coordinates.
    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 - (optional) format for writing the vertex and normals 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
  - 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 PointMesh copy()
```
    Creates a copy of this mesh.
    
    Overrides:
    
    copy in class MeshBase
  - clone
```
public PointMesh clone()
```
    Description copied from class: MeshBase
    
    Creates a clone of this mesh.
    
    Overrides:
    
    clone in class MeshBase
  - addMesh
```
public void addMesh(PointMesh mesh)
```
  - addMesh
```
public void addMesh(PointMesh mesh,
                    boolean respectTransforms)
```
    Adds copies of the vertices of another mesh to this mesh. If the other mesh contains normal information, this will be added as well providing this mesh already contains normal information or is empty. Otherwise, normal information for this mesh will be cleared.
    
    Parameters:
    
    mesh - Mesh to be added to this mesh
  - getBVTree
```
public AABBTree getBVTree()
```
    Description copied from class: MeshBase
    
    Returns a bounding volume tree to be used for proximity queries involving this mesh.
    
    Specified by:
    
    getBVTree in class MeshBase
    
    Returns:
    
    bounding volume tree
  - 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 normals 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
  - addVertex
```
public void addVertex(Vertex3d vtx)
```
    Description copied from class: MeshBase
    
    Adds a vertex to the set of vertices associated with this mesh. The pnt field of the vertex should be non-null. The index of the vertex will be set to reflect it's position in the list of vertices.
    
    Overrides:
    
    addVertex in class MeshBase
    
    Parameters:
    
    vtx - vertex to add
    
    See Also:
    
    MeshBase.addVertex(Point3d,boolean), MeshBase.addVertex(Point3d)
  - removeVertex
```
public boolean removeVertex(Vertex3d vtx)
```
    Description copied from class: MeshBase
    
    Removes a vertex from this mesh.
    
    Overrides:
    
    removeVertex in class MeshBase
    
    Parameters:
    
    vtx - vertex to remove
    
    Returns:
    
    true if the vertex was present
  - removeVertexFast
```
public boolean removeVertexFast(Vertex3d vtx)
```
    Description copied from class: MeshBase
    
    Removes a vertex from this mesh.
    
    Overrides:
    
    removeVertexFast in class MeshBase
    
    Parameters:
    
    vtx - vertex to remove
    
    Returns:
    
    true if the vertex was present
  - removeVertices
```
public java.util.ArrayList<java.lang.Integer> removeVertices(java.util.Collection<Vertex3d> vertices)
```
    Description copied from class: MeshBase
    
    Removes a set of vertices from this mesh, as indicated by a collection.
    
    Overrides:
    
    removeVertices in class MeshBase
    
    Parameters:
    
    vertices - Collection of vertices to remove
  - createInertia
```
public SpatialInertia createInertia(double mass)
```
    Computes a spatial inertia for this mesh, given a mass which is assumed to be distributed uniformly across its vertices.
    
    Parameters:
    
    mass - overall mass
  - createInertia
```
public SpatialInertia createInertia(double mass,
                                    MassDistribution dist)
```
    Computes a spatial inertia for this mesh, given a mass and a mass distribution. Only the MassDistribution.POINT distribution is supported.
    
    Overrides:
    
    createInertia in class MeshBase
    
    Parameters:
    
    mass - overall mass
    
    dist - how the mass is distributed across the features
    
    Throws:
    
    java.lang.IllegalArgumentException - if the distribution is not compatible with the available mesh features.

Class PointMesh

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

PointMesh

PointMesh

PointMesh

Method Detail

createRenderProps

getNormalRenderLen

setNormalRenderLen

readBinary

read

set

write

write

prerender

render

copy

clone

addMesh

addMesh

getBVTree

epsilonEquals

createVertexIndices

numFeatures

hasAutoNormalCreation

getWriteNormals

addVertex

removeVertex

removeVertexFast

removeVertices

createInertia

createInertia