sc.fiji.snt.viewer

Class OBJMesh

java.lang.Object

sc.fiji.snt.viewer.OBJMesh

public class OBJMesh
extends java.lang.Object

An OBJMesh stores information about a Wavefront .obj mesh loaded into Viewer3D, with access points to its OBJFile and DrawableVBO

Author:

Tiago Ferreira

Constructor Summary

Constructors

Constructor and Description
OBJMesh(java.lang.String filePath) Instantiates a new wavefront OBJ mesh from a file path/URL.
OBJMesh(java.net.URL url)

Method Summary

Modifier and Type	Method and Description
SNTPoint	getCentroid(java.lang.String hemihalf) Returns the spatial centroid of the specified (hemi)mesh.
org.jzy3d.plot3d.primitives.vbo.drawable.DrawableVBO	getDrawable() Returns the DrawableVBO associated with this mesh
org.jzy3d.io.obj.OBJFile	getObj() Returns the OBJFile associated with this mesh
java.util.Collection<? extends SNTPoint>	getVertices() Returns the mesh vertices.
java.util.Collection<? extends SNTPoint>	getVertices(java.lang.String hemihalf) Returns the mesh vertices.
void	setBoundingBoxColor(org.scijava.util.ColorRGB boundingBoxColor) Determines whether the mesh bounding box should be displayed.
void	setColor(org.scijava.util.ColorRGB color, double transparencyPercent) Assigns a color to the mesh.
void	setColor(java.lang.String color, double transparencyPercent) Script friendly method to assign a color to the mesh.
void	setLabel(java.lang.String label)
void	translate(SNTPoint offset) Translates the vertices of this mesh by the specified offset.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OBJMesh

public OBJMesh(java.lang.String filePath)

Instantiates a new wavefront OBJ mesh from a file path/URL.

Parameters:

filePath - the absolute path to the .OBJ file to be imported. URL representations accepted

Throws:

java.lang.IllegalArgumentException - if filePath is invalid or file does not contain a compilable mesh

OBJMesh

public OBJMesh(java.net.URL url)

Method Detail

translate

public void translate(SNTPoint offset)

Translates the vertices of this mesh by the specified offset. If mesh is displayed, changes may only occur once scene is rebuilt.

Parameters:

offset - the translation offset

setColor

public void setColor(java.lang.String color,
                     double transparencyPercent)

Script friendly method to assign a color to the mesh.

Parameters:

color - the color to render the imported file, either a 1) HTML color codes starting with hash (#), a color preset ("red", "blue", etc.), or integer triples of the form r,g,b and range [0, 255]

transparencyPercent - the color transparency (in percentage)

setColor

public void setColor(org.scijava.util.ColorRGB color,
                     double transparencyPercent)

Assigns a color to the mesh.

Parameters:

color - the color to render the imported file

transparencyPercent - the color transparency (in percentage)

setBoundingBoxColor

public void setBoundingBoxColor(org.scijava.util.ColorRGB boundingBoxColor)

Determines whether the mesh bounding box should be displayed.

Parameters:

boundingBoxColor - the color of the mesh bounding box. If null, no bounding box is displayed

setLabel

public void setLabel(java.lang.String label)

getVertices

public java.util.Collection<? extends SNTPoint> getVertices()

Returns the mesh vertices.

Returns:

the mesh vertices as SNTPoints

getVertices

public java.util.Collection<? extends SNTPoint> getVertices(java.lang.String hemihalf)

Returns the mesh vertices.

Parameters:

hemihalf - either "left", "l", "right", "r" otherwise centroid is retrieved for both hemi-halves, i.e., the full mesh

Returns:

the mesh vertices as SNTPoints

getCentroid

public SNTPoint getCentroid(java.lang.String hemihalf)

Returns the spatial centroid of the specified (hemi)mesh.

Parameters:

hemihalf - either "left", "l", "right", "r", otherwise centroid is retrieved for both hemi-halves, i.e., the full mesh

Returns:

the SNT point defining the (X,Y,Z) center of the (hemi)mesh.

getObj

public org.jzy3d.io.obj.OBJFile getObj()

Returns the OBJFile associated with this mesh

Returns:

the OBJFile

getDrawable

public org.jzy3d.plot3d.primitives.vbo.drawable.DrawableVBO getDrawable()

Returns the DrawableVBO associated with this mesh

Returns:

the DrawableVBO