MeshComponent (Artisynth API documentation)

java.lang.Object
- artisynth.core.modelbase.ModelComponentBase
- - artisynth.core.modelbase.RenderableComponentBase
  - - artisynth.core.mechmodels.MeshComponent

All Implemented Interfaces:

ModelComponent, RenderableComponent, TransformableGeometry, ScalableUnits, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

Direct Known Subclasses:

EditableMeshComp, FixedMeshBody, RigidMeshComp, SkinMeshBase
```
public class MeshComponent
extends RenderableComponentBase
implements TransformableGeometry, ScalableUnits
```
Contains information about a mesh, including the mesh itself, and it's possible file name and transformation with respect to the original file definition.

Nested Class Summary
- Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent
  ModelComponent.NavpanelVisibility

Field Summary

Fields
Modifier and Type	Field and Description
`static Renderer.ColorInterpolation`	`DEFAULT_COLOR_INTERPOLATION`
`static Renderer.ColorMixing`	`DEFAULT_VERTEX_COLOR_MIXING`
`static PropertyList`	`myProps`

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

Fields inherited from interface artisynth.core.modelbase.TransformableGeometry
TG_ARTICULATED, TG_DRAGGER, TG_PRESERVE_ORIENTATION, TG_SIMULATING

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

Constructor Summary

Constructors
Constructor and Description
`MeshComponent()`
`MeshComponent(MeshBase mesh, java.lang.String fileName, AffineTransform3dBase X)`
`MeshComponent(java.lang.String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTransformableDependencies(TransformGeometryContext context, int flags)` Adds to `context` any transformable components which should be transformed as the same time as this component.
`MeshComponent`	`copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap)`
`RenderProps`	`createRenderProps()` Factory method to create render properties appropriate to this object.
`static PolygonalMesh[]`	`createSurfaceMeshArray(PolygonalMesh mesh)`
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`Renderer.ColorInterpolation`	`getColorInterpolation()`
`AffineTransform3d`	`getFileTransform()`
`MeshBase`	`getMesh()`
`RigidTransform3d`	`getMeshToWorld()`
`static PolygonalMesh[]`	`getSurfaceMeshes(MeshComponentList<?> list)`
`Vertex3d`	`getVertex(int idx)`
`Renderer.ColorMixing`	`getVertexColorMixing()`
`boolean`	`isFileTransformRigid()`
`boolean`	`isMeshModfied()`
`static int`	`numSurfaceMeshes(MeshComponentList<?> list)`
`int`	`numVertices()`
`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).
`void`	`render(Renderer renderer, int flags)` Render this object using the functionality of the supplied `Renderer`.
`void`	`render(Renderer renderer, RenderProps props, int flags)`
`void`	`scaleDistance(double s)` Scales all distance coordinates.
`void`	`scaleMass(double s)` Scales all mass units.
`void`	`setColorInterpolation(Renderer.ColorInterpolation interp)`
`void`	`setDefaultValues()` Sets the attributes of this component to their default values.
`void`	`setMesh(MeshBase mesh)`
`void`	`setMesh(MeshBase mesh, java.lang.String fileName)`
`void`	`setMesh(MeshBase mesh, java.lang.String fileName, AffineTransform3dBase X)`
`void`	`setMeshToWorld(RigidTransform3d TMW)`
`void`	`setVertexColorMixing(Renderer.ColorMixing cmix)`
`void`	`transformGeometry(AffineTransform3dBase X)` Applies an affine transformation to the geometry of this component.
`void`	`transformGeometry(GeometryTransformer gtr, TransformGeometryContext context, int flags)` Transforms the geometry of this component, using the geometry transformer `gtr` to transform its individual attributes.
`void`	`updateBounds(Vector3d pmin, Vector3d pmax)` Update the minimum and maximum points for this object.
`void`	`updatePosition(int flags)`
`void`	`updateSlavePos()`

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

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, postscan, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, updateReferences

Methods inherited from interface maspack.properties.HasProperties
getProperty

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

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

- Field Detail
  - myProps
```
public static PropertyList myProps
```
  - DEFAULT_COLOR_INTERPOLATION
```
public static final Renderer.ColorInterpolation DEFAULT_COLOR_INTERPOLATION
```
  - DEFAULT_VERTEX_COLOR_MIXING
```
public static final Renderer.ColorMixing DEFAULT_VERTEX_COLOR_MIXING
```
- Constructor Detail
  - MeshComponent
```
public MeshComponent(java.lang.String name)
```
  - MeshComponent
```
public MeshComponent()
```
  - MeshComponent
```
public MeshComponent(MeshBase mesh,
                     java.lang.String fileName,
                     AffineTransform3dBase X)
```
- 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
  - setMesh
```
public void setMesh(MeshBase mesh,
                    java.lang.String fileName,
                    AffineTransform3dBase X)
```
  - setMesh
```
public void setMesh(MeshBase mesh,
                    java.lang.String fileName)
```
  - setMesh
```
public void setMesh(MeshBase mesh)
```
  - getColorInterpolation
```
public Renderer.ColorInterpolation getColorInterpolation()
```
  - setColorInterpolation
```
public void setColorInterpolation(Renderer.ColorInterpolation interp)
```
  - getVertexColorMixing
```
public Renderer.ColorMixing getVertexColorMixing()
```
  - setVertexColorMixing
```
public void setVertexColorMixing(Renderer.ColorMixing cmix)
```
  - getVertex
```
public Vertex3d getVertex(int idx)
```
  - numVertices
```
public int numVertices()
```
  - getMesh
```
public MeshBase getMesh()
```
  - getMeshToWorld
```
public RigidTransform3d getMeshToWorld()
```
  - setMeshToWorld
```
public void setMeshToWorld(RigidTransform3d TMW)
```
  - getFileTransform
```
public AffineTransform3d getFileTransform()
```
  - isFileTransformRigid
```
public boolean isFileTransformRigid()
```
  - isMeshModfied
```
public boolean isMeshModfied()
```
  - 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 RenderableComponentBase
    
    Returns:
    
    new render properties for this object
  - setDefaultValues
```
public void setDefaultValues()
```
    Description copied from class: ModelComponentBase
    
    Sets the attributes of this component to their default values.
  - 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 RenderableComponentBase
    
    Parameters:
    
    list - list of objects to be rendered
  - render
```
public void render(Renderer renderer,
                   RenderProps props,
                   int flags)
```
  - 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 RenderableComponentBase
    
    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 RenderableComponentBase
    
    Parameters:
    
    pmin - minimum point
    
    pmax - maximum point
  - updatePosition
```
public void updatePosition(int flags)
```
  - scaleDistance
```
public void scaleDistance(double s)
```
    Description copied from interface: ScalableUnits
    
    Scales all distance coordinates.
    
    Specified by:
    
    scaleDistance in interface ScalableUnits
    
    Parameters:
    
    s - scaling factor
  - scaleMass
```
public void scaleMass(double s)
```
    Description copied from interface: ScalableUnits
    
    Scales all mass units.
    
    Specified by:
    
    scaleMass in interface ScalableUnits
    
    Parameters:
    
    s - scaling factor
  - transformGeometry
```
public void transformGeometry(AffineTransform3dBase X)
```
    Description copied from interface: TransformableGeometry
    Applies an affine transformation to the geometry of this component. This method should be equivalent to
```
 TransformGeometryContext.transform (this, X, 0);
 
```
    Specified by:
    
    transformGeometry in interface TransformableGeometry
    
    Parameters:
    
    X - affine transformation to apply to the component
  - transformGeometry
```
public void transformGeometry(GeometryTransformer gtr,
                              TransformGeometryContext context,
                              int flags)
```
    Description copied from interface: TransformableGeometry
    
    Transforms the geometry of this component, using the geometry transformer gtr to transform its individual attributes. The context argument supplies information about what other components are currently being transformed, and also allows the requesting of update actions to be performed after all transform called have completed. The context is also the usual entity that calls this method, from within its TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method. The argument flags provides flags to specify various conditions associated with the the transformation. At present, the available flags are TransformableGeometry.TG_SIMULATING and TransformableGeometry.TG_ARTICULATED.
    This method is not usually called directly by applications. Instead, it is typically called from within the TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method of the context, which takes care of the various operations needed for a complete transform operation, including calling TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int) to collect other components that should be transformed, calling TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) for each component, notifying component parents that the geometry has changed, and calling any requested TransformGeometryActions. More details are given in the documentation for TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int).
    TransformGeometryContext provides a number of static convenience transform methods which take care of building the context and calling apply() for a specified set of components.
    This method should not generally call transformGeometry() for its descendant components. Instead, descendants needing transformation should be specified by adding them to the context in the method TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int).
    
    Specified by:
    
    transformGeometry in interface TransformableGeometry
    
    Parameters:
    
    gtr - transformer implementing the transform
    
    context - context information, including what other components are being transformed
    
    flags - specifies conditions associated with the transformation
  - addTransformableDependencies
```
public void addTransformableDependencies(TransformGeometryContext context,
                                         int flags)
```
    Description copied from interface: TransformableGeometry
    
    Adds to context any transformable components which should be transformed as the same time as this component. This will generally include descendant components, and may also include other components to which this component is connected in some way.
    This method is generally called from with the TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method of a TransformGeometryContext.
    
    Specified by:
    
    addTransformableDependencies in interface TransformableGeometry
    
    Parameters:
    
    context - context information, to which the dependent components are added.
    
    flags - specifies conditions associated with the transformation
  - updateSlavePos
```
public void updateSlavePos()
```
  - createSurfaceMeshArray
```
public static PolygonalMesh[] createSurfaceMeshArray(PolygonalMesh mesh)
```
  - numSurfaceMeshes
```
public static int numSurfaceMeshes(MeshComponentList<?> list)
```
  - getSurfaceMeshes
```
public static PolygonalMesh[] getSurfaceMeshes(MeshComponentList<?> list)
```
  - copy
```
public MeshComponent copy(int flags,
                          java.util.Map<ModelComponent,ModelComponent> copyMap)
```
    Overrides:
    
    copy in class RenderableComponentBase

Class MeshComponent

Nested Class Summary

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

Field Summary

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

Fields inherited from interface artisynth.core.modelbase.TransformableGeometry

Fields inherited from interface maspack.render.IsRenderable

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

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 maspack.util.Scannable

Field Detail

myProps

DEFAULT_COLOR_INTERPOLATION

DEFAULT_VERTEX_COLOR_MIXING

Constructor Detail

MeshComponent

MeshComponent

MeshComponent

Method Detail

getAllPropertyInfo

setMesh

setMesh

setMesh

getColorInterpolation

setColorInterpolation

getVertexColorMixing

setVertexColorMixing

getVertex

numVertices

getMesh

getMeshToWorld

setMeshToWorld

getFileTransform

isFileTransformRigid

isMeshModfied

createRenderProps

setDefaultValues

prerender

render

render

updateBounds

updatePosition

scaleDistance

scaleMass

transformGeometry

transformGeometry

addTransformableDependencies

updateSlavePos

createSurfaceMeshArray

numSurfaceMeshes

getSurfaceMeshes

copy