MeshCurve (Artisynth API documentation)

java.lang.Object
- artisynth.core.modelbase.ModelComponentBase
- - artisynth.core.modelbase.CompositeComponentBase
  - - artisynth.core.modelbase.RenderableCompositeBase
    - - artisynth.core.renderables.MeshCurve

All Implemented Interfaces:

ComponentChangeListener, CompositeComponent, IndexedComponentList, ModelComponent, PostScannable, RenderableComponent, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable
```
public class MeshCurve
extends RenderableCompositeBase
```
Component for representing a curve on the surface of a mesh.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MeshCurve.Interpolation
- Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent
  ModelComponent.NavpanelVisibility
- Nested classes/interfaces inherited from interface artisynth.core.modelbase.CompositeComponent
  CompositeComponent.NavpanelDisplay

Nested Classes
Modifier and Type	Class and Description
`static class`	`MeshCurve.Interpolation`

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_CLOSED`
`static MeshCurve.Interpolation`	`DEFAULT_INTERPOLATION`
`static double`	`DEFAULT_NORMAL_LENGTH`
`static boolean`	`DEFAULT_PROJECT_TO_MESH`
`static int`	`DEFAULT_RESOLUTION`
`static double`	`INF`
`static PropertyList`	`myProps`

Fields inherited from class artisynth.core.modelbase.ModelComponentBase
enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface maspack.render.IsRenderable
TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors
Constructor and Description

MeshCurve()

MeshCurve(MeshComponent mcomp)

Constructors
Constructor and Description
`MeshCurve()`
`MeshCurve(MeshComponent mcomp)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MeshMarker`	`addMarker(Point3d pos)`
`void`	`clearMarkers()`
`void`	`componentChanged(ComponentChangeEvent e)` Notifies this composite component that a change has occured within one or more of its descendants.
`MeshCurve`	`copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap)`
`RenderProps`	`createRenderProps()` Factory method to create render properties appropriate to this object.
`double`	`findNearestPoint(Point3d pr, Point3d p0, double r0)` Finds the nearest point on this curve to a prescribed point `p0`.
`double`	`findPointAtDistance(Point3d pr, Point3d p0, double dist, double r0)` Finds the point on this curve that is a specified distance `dist` from a prescribed point `p0`, within machine precision.
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`MeshCurve.Interpolation`	`getInterpolation()`
`PointList<MeshMarker>`	`getMarkers()`
`PolygonalMesh`	`getMesh()`
`MeshComponent`	`getMeshComp()`
`Vector3d`	`getNormal(int idx)` Returns the `idx`-th normal on this curve, where `idx` should be in the range 0 to `numPoints()`-1;
`double`	`getNormalComputeRadius()` Queries the radius around the marker used to collect vertices for estimating its surface normal.
`PropertyMode`	`getNormalComputeRadiusMode()`
`double`	`getNormalLength()`
`java.util.List<Vector3d>`	`getNormals()` Returns a list of all the normals on this curve.
`Vector3d`	`getPoint(int idx)` Returns the `idx`-th point on this curve, where `idx` should be in the range 0 to `numPoints()`-1;
`java.util.List<Point3d>`	`getPoints()` Returns a list of all the points on this curve.
`boolean`	`getProjectToMesh()`
`double`	`getResolution()`
`Vector3d`	`getTangent(int idx)` Returns the curve tangent for the `idx`-th point on this curve, where `idx` should be in the range 0 to `numPoints()`-1; The tangent is computed by numerically differencing adjacent points.
`boolean`	`isClosed()`
`int`	`numMarkers()`
`int`	`numPoints()` Returns the number of points (and normals) associated with this MeshCurve.
`void`	`prerender(RenderList list)` Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates).
`boolean`	`removeMarker(MeshMarker mkr)`
`void`	`render(Renderer renderer, int flags)` Render this object using the functionality of the supplied `Renderer`.
`void`	`setClosed(boolean closed)`
`void`	`setInterpolation(MeshCurve.Interpolation interp)`
`void`	`setNormalComputeRadius(double rad)` Sets the radius around the marker used to collect vertices for estimating its surface normal.
`void`	`setNormalComputeRadiusMode(PropertyMode mode)`
`void`	`setNormalLength(double len)`
`void`	`setProjectToMesh(boolean enable)`
`void`	`setResolution(double res)`
`void`	`updateBounds(Vector3d pmin, Vector3d pmax)` Update the minimum and maximum points for this object.
`void`	`updateCurveIfNecessary()`
`void`	`updatePosition()`

Methods inherited from class artisynth.core.modelbase.RenderableCompositeBase
getRenderHints, getRenderProps, getSelection, isSelectable, numSelectionQueriesNeeded, setRenderProps

Methods inherited from class artisynth.core.modelbase.CompositeComponentBase
findComponent, get, get, getByNumber, getChildren, getNavpanelDisplay, getNumberLimit, hasChildren, hasState, hierarchyContainsReferences, indexOf, iterator, numComponents, postscan, scan, setDisplayMode, updateNameMap

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

Methods inherited from interface artisynth.core.modelbase.ModelComponent
connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.properties.HasProperties
getProperty

Methods inherited from interface maspack.properties.HierarchyNode
getChildren, hasChildren

Methods inherited from interface artisynth.core.modelbase.PostScannable
postscan

Methods inherited from interface maspack.util.Scannable
isWritable, write

- Field Detail
  - INF
```
public static final double INF
```
    See Also:
    
    Constant Field Values
  - DEFAULT_RESOLUTION
```
public static int DEFAULT_RESOLUTION
```
  - DEFAULT_CLOSED
```
public static boolean DEFAULT_CLOSED
```
  - DEFAULT_INTERPOLATION
```
public static MeshCurve.Interpolation DEFAULT_INTERPOLATION
```
  - DEFAULT_NORMAL_LENGTH
```
public static double DEFAULT_NORMAL_LENGTH
```
  - DEFAULT_PROJECT_TO_MESH
```
public static boolean DEFAULT_PROJECT_TO_MESH
```
  - myProps
```
public static PropertyList myProps
```
- Constructor Detail
  - MeshCurve
```
public MeshCurve()
```
  - MeshCurve
```
public MeshCurve(MeshComponent mcomp)
```
- Method Detail
  - getAllPropertyInfo
```
public PropertyList getAllPropertyInfo()
```
    Description copied from interface: HasProperties
    
    Returns a list giving static information about all properties exported by this object.
    
    Specified by:
    
    getAllPropertyInfo in interface HasProperties
    
    Overrides:
    
    getAllPropertyInfo in class ModelComponentBase
    
    Returns:
    
    static information for all exported properties
  - getResolution
```
public double getResolution()
```
  - setResolution
```
public void setResolution(double res)
```
  - getInterpolation
```
public MeshCurve.Interpolation getInterpolation()
```
  - isClosed
```
public boolean isClosed()
```
  - setClosed
```
public void setClosed(boolean closed)
```
  - setInterpolation
```
public void setInterpolation(MeshCurve.Interpolation interp)
```
  - getNormalLength
```
public double getNormalLength()
```
  - setNormalLength
```
public void setNormalLength(double len)
```
  - setNormalComputeRadius
```
public void setNormalComputeRadius(double rad)
```
    Sets the radius around the marker used to collect vertices for estimating its surface normal. The surface normal is computed as a weighted average of the normals of these vertices plus the normal of the marker's face. A value of 0 means that only the face normal is used. The weighting is Gaussian, based on the distance of the vertex from the marker, with the radius corresponding to two standard deviations. By default, this value is inherited from an ancestor component, or otherwise set to a default value based on the mesh's size. Specifying a negative value also causes this default value to be computed.
    
    Parameters:
    
    rad - normal compute radius
  - getNormalComputeRadius
```
public double getNormalComputeRadius()
```
    Queries the radius around the marker used to collect vertices for estimating its surface normal. See setNormalComputeRadius(double) for a description of how this is done.
    
    Returns:
    
    normal compute radius
  - getNormalComputeRadiusMode
```
public PropertyMode getNormalComputeRadiusMode()
```
  - setNormalComputeRadiusMode
```
public void setNormalComputeRadiusMode(PropertyMode mode)
```
  - getProjectToMesh
```
public boolean getProjectToMesh()
```
  - setProjectToMesh
```
public void setProjectToMesh(boolean enable)
```
  - getMesh
```
public PolygonalMesh getMesh()
```
  - getMeshComp
```
public MeshComponent getMeshComp()
```
  - addMarker
```
public MeshMarker addMarker(Point3d pos)
```
  - getMarkers
```
public PointList<MeshMarker> getMarkers()
```
  - numMarkers
```
public int numMarkers()
```
  - removeMarker
```
public boolean removeMarker(MeshMarker mkr)
```
  - clearMarkers
```
public void clearMarkers()
```
  - updatePosition
```
public void updatePosition()
```
  - numPoints
```
public int numPoints()
```
    Returns the number of points (and normals) associated with this MeshCurve. This number n is determined by the curve's resolution property, and is computed so that in the case of linear interpolation between the knot points, the distance between each point will be <= resolution.
    
    Returns:
    
    number of curve points and normals
  - getPoints
```
public java.util.List<Point3d> getPoints()
```
    Returns a list of all the points on this curve. The list will have size numPoints.
    
    Returns:
    
    list of all the points
  - getPoint
```
public Vector3d getPoint(int idx)
```
    Returns the idx-th point on this curve, where idx should be in the range 0 to numPoints()-1;
    
    Parameters:
    
    idx - index of the desired point
    
    Returns:
    
    idx-th point
  - getNormals
```
public java.util.List<Vector3d> getNormals()
```
    Returns a list of all the normals on this curve. The list will have size numPoints.
    
    Returns:
    
    list of all the normals
  - getNormal
```
public Vector3d getNormal(int idx)
```
    Returns the idx-th normal on this curve, where idx should be in the range 0 to numPoints()-1;
    
    Parameters:
    
    idx - index of the desired normal
    
    Returns:
    
    idx-th normal
  - getTangent
```
public Vector3d getTangent(int idx)
```
    Returns the curve tangent for the idx-th point on this curve, where idx should be in the range 0 to numPoints()-1; The tangent is computed by numerically differencing adjacent points. If the number of curve points is less than 1, the tangent is set to 0.
    
    Parameters:
    
    idx - index of the point for which the tangent is desired
    
    Returns:
    
    tangent for the idx-th point
  - findPointAtDistance
```
public double findPointAtDistance(Point3d pr,
                                  Point3d p0,
                                  double dist,
                                  double r0)
```
    Finds the point on this curve that is a specified distance dist from a prescribed point p0, within machine precision. Point locations on the curve are described by a non-negative parameter r, which takes the form
```
 r = k + s
 
```
    where k is the index of a curve point (as returned by getPoints()), and s is a scalar parameter in the range [0,1] that specifies the location along the interval between curve points k and k+1. If the curve is open, the search for the distance point begins at a location specified by r0 and locations before r0 are ignored. If the curve is closed, r0 is ignored.
    If found, the method will return the point's location parameter r, as well as the point's value in the optional parameter pr if it is not null. If the point is not found, the method will return -1.
    Parameters:
    
    pr - if not null, returns the distance point, if found
    
    p0 - point with respect to which distance should be determined
    
    dist - desired distance from p0
    
    r0 - for open curves, a non-negative scalar giving the location on the curve where the search should start. This should be a non-negative scalar whose value is less than or equal to the number of curve points (as returned by numPoints()).
    
    Returns:
    
    location of the distance point on the polyline, if found, or -1.
  - findNearestPoint
```
public double findNearestPoint(Point3d pr,
                               Point3d p0,
                               double r0)
```
    Finds the nearest point on this curve to a prescribed point p0. Locations on the curve are described by a non-negative parameter r, which takes the form
```
 r = k + s
 
```
    where k is the index of a curve point (as returned by getPoints()), and s is a scalar parameter in the range [0,1] that specifies the location along the interval between curve points k and k+1. If the curve is open, the search for the nearest point begins at a location specified by r0 and locations before r0 are ignored. If the polyline is closed, r0 is ignored. The nearest point may not be unique.
    The method will return the nearest point's location parameter r, as well as the point's value in the optional parameter pr if it is not null. If the curve is empty, both r and pr at set to 0.
    Parameters:
    
    pr - if not null, returns the nearest point
    
    p0 - point for which the nearest point should be determined
    
    r0 - for open curves, a non-negative scalar giving the location on the curve where the search should start. This should be a non-negative scalar whose value is less than or equal to the number of curve points (as returned by numPoints()).
    
    Returns:
    
    location of the nearest point on the curve
  - updateCurveIfNecessary
```
public void updateCurveIfNecessary()
```
  - componentChanged
```
public void componentChanged(ComponentChangeEvent e)
```
    Description copied from class: CompositeComponentBase
    
    Notifies this composite component that a change has occured within one or more of its descendants. When this occurs, the composite may need to invalidate cached information that depends on the descendants.
    This method should propagate the notification up the component hierarchy by calling notifyParentOfChange.
    
    Specified by:
    
    componentChanged in interface ComponentChangeListener
    
    Specified by:
    
    componentChanged in interface CompositeComponent
    
    Overrides:
    
    componentChanged in class CompositeComponentBase
    
    Parameters:
    
    e - optional argument giving specific information about the change
  - createRenderProps
```
public RenderProps createRenderProps()
```
    Description copied from interface: HasRenderProps
    
    Factory method to create render properties appropriate to this object.
    
    Specified by:
    
    createRenderProps in interface HasRenderProps
    
    Overrides:
    
    createRenderProps in class RenderableCompositeBase
    
    Returns:
    
    new render properties for this object
  - prerender
```
public void prerender(RenderList list)
```
    Description copied from interface: IsRenderable
    
    Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates). The object may add internal objects to the list of objects being rendered, by calling
    list.addIfVisible (obj);
    for each of the objects in question.
    
    Specified by:
    
    prerender in interface IsRenderable
    
    Overrides:
    
    prerender in class RenderableCompositeBase
    
    Parameters:
    
    list - list of objects to be rendered
  - render
```
public void render(Renderer renderer,
                   int flags)
```
    Description copied from interface: IsRenderable
    
    Render this object using the functionality of the supplied Renderer.
    
    Specified by:
    
    render in interface IsRenderable
    
    Specified by:
    
    render in class RenderableCompositeBase
    
    Parameters:
    
    renderer - provides the functionality used to perform the rendering.
    
    flags - flags that may be used to control different aspects of the rendering. Flags are defined in Renderer and currently include Renderer.HIGHLIGHT and Renderer.SORT_FACES.
  - updateBounds
```
public void updateBounds(Vector3d pmin,
                         Vector3d pmax)
```
    Description copied from interface: IsRenderable
    
    Update the minimum and maximum points for this object. In an x-y-z coordinate system with x directed to the right and y directed upwards, the minimum and maximum points can be thought of as defining the left-lower-far and right-upper-near corners of a bounding cube. This method should only reduce the elements of the minimum point and increase the elements of the maximum point, since it may be used as part of an iteration to determine the bounding cube for several different objects.
    
    Specified by:
    
    updateBounds in interface IsRenderable
    
    Overrides:
    
    updateBounds in class RenderableCompositeBase
    
    Parameters:
    
    pmin - minimum point
    
    pmax - maximum point
  - copy
```
public MeshCurve copy(int flags,
                      java.util.Map<ModelComponent,ModelComponent> copyMap)
```
    Overrides:
    
    copy in class RenderableCompositeBase

Class MeshCurve

Nested Class Summary

Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent

Nested classes/interfaces inherited from interface artisynth.core.modelbase.CompositeComponent

Field Summary

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

Fields inherited from interface maspack.render.IsRenderable

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.modelbase.RenderableCompositeBase

Methods inherited from class artisynth.core.modelbase.CompositeComponentBase

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

Methods inherited from class java.lang.Object

Methods inherited from interface artisynth.core.modelbase.ModelComponent

Methods inherited from interface maspack.properties.HasProperties

Methods inherited from interface maspack.properties.HierarchyNode

Methods inherited from interface artisynth.core.modelbase.PostScannable

Methods inherited from interface maspack.util.Scannable

Field Detail

INF

DEFAULT_RESOLUTION

DEFAULT_CLOSED

DEFAULT_INTERPOLATION

DEFAULT_NORMAL_LENGTH

DEFAULT_PROJECT_TO_MESH

myProps

Constructor Detail

MeshCurve

MeshCurve

Method Detail

getAllPropertyInfo

getResolution

setResolution

getInterpolation

isClosed

setClosed

setInterpolation

getNormalLength

setNormalLength

setNormalComputeRadius

getNormalComputeRadius

getNormalComputeRadiusMode

setNormalComputeRadiusMode

getProjectToMesh

setProjectToMesh

getMesh

getMeshComp

addMarker

getMarkers

numMarkers

removeMarker

clearMarkers

updatePosition

numPoints

getPoints

getPoint

getNormals

getNormal

getTangent

findPointAtDistance

findNearestPoint

updateCurveIfNecessary

componentChanged

createRenderProps

prerender

render

updateBounds

copy