Annotation3D (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- sc.fiji.snt.viewer.Annotation3D

```
public class Annotation3D
extends Object
```
An Annotation3D is a triangulated surface or a cloud of points (scatter) rendered in Viewer3D that can be used to highlight nodes in a Tree or locations in a mesh.

Author:

Tiago Ferreira

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`MERGE`
`protected static int`	`Q_TIP`
`protected static int`	`SCATTER`
`protected static int`	`STRIP`
`protected static int`	`SURFACE`
`protected static int`	`SURFACE_AND_VOLUME`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Annotation3D(Mesh mesh, ColorRGB color, String label)`
	`Annotation3D(Mesh mesh, String label)`
`protected`	`Annotation3D(Viewer3D viewer, Collection<? extends SNTPoint> points, int type)`
`protected`	`Annotation3D(Viewer3D viewer, Collection<Annotation3D> annotations)`
`protected`	`Annotation3D(Viewer3D viewer, SNTPoint point)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SNTPoint`	`getBarycentre()` Returns the center of this annotation bounding box.
`org.jzy3d.plot3d.primitives.AbstractDrawable`	`getDrawable()` Returns the `AbstractDrawable` associated with this annotation.
`String`	`getLabel()` Gets the annotation label
`String`	`getType()` Gets the type of this annotation.
`double`	`getVolume()`
`static org.jzy3d.plot3d.primitives.AbstractDrawable`	`meshToDrawable(Mesh mesh)`
`void`	`setBoundingBoxColor(ColorRGB boundingBoxColor)` Determines whether the mesh bounding box should be displayed.
`void`	`setColor(ColorRGB color, double transparencyPercent)` Assigns a color to the annotation.
`void`	`setColor(String color)` Script friendly method to assign a color to the annotation.
`void`	`setColor(String color, double transparencyPercent)` Script friendly method to assign a color to the annotation.
`protected void`	`setLabel(String label)`
`void`	`setSize(float size)` Sets the annotation width.

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

- Field Detail
  - SCATTER
```
protected static final int SCATTER
```
    See Also:
    
    Constant Field Values
  - SURFACE
```
protected static final int SURFACE
```
    See Also:
    
    Constant Field Values
  - STRIP
```
protected static final int STRIP
```
    See Also:
    
    Constant Field Values
  - Q_TIP
```
protected static final int Q_TIP
```
    See Also:
    
    Constant Field Values
  - MERGE
```
protected static final int MERGE
```
    See Also:
    
    Constant Field Values
  - SURFACE_AND_VOLUME
```
protected static final int SURFACE_AND_VOLUME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Annotation3D
```
protected Annotation3D(Viewer3D viewer,
                       Collection<Annotation3D> annotations)
```
  - Annotation3D
```
protected Annotation3D(Viewer3D viewer,
                       Collection<? extends SNTPoint> points,
                       int type)
```
  - Annotation3D
```
public Annotation3D(Mesh mesh,
                    ColorRGB color,
                    String label)
```
  - Annotation3D
```
public Annotation3D(Mesh mesh,
                    String label)
```
  - Annotation3D
```
protected Annotation3D(Viewer3D viewer,
                       SNTPoint point)
```
- Method Detail
  - meshToDrawable
```
public static org.jzy3d.plot3d.primitives.AbstractDrawable meshToDrawable(Mesh mesh)
```
  - setSize
```
public void setSize(float size)
```
    Sets the annotation width.
    
    Parameters:
    
    size - the new width. A negative value will set width to Viewer3D's default.
  - setColor
```
public void setColor(ColorRGB color,
                     double transparencyPercent)
```
    Assigns a color to the annotation.
    
    Parameters:
    
    color - the color to render the annotation. (If the annotation contains a wireframe, the wireframe is rendered using a "contrast" color computed from this one.
    
    transparencyPercent - the color transparency (in percentage)
  - setColor
```
public void setColor(String color,
                     double transparencyPercent)
```
    Script friendly method to assign a color to the annotation.
    
    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(String color)
```
    Script friendly method to assign a color to the annotation.
    
    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]
  - setBoundingBoxColor
```
public void setBoundingBoxColor(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
  - getLabel
```
public String getLabel()
```
    Gets the annotation label
    
    Returns:
    
    the label, as listed in Reconstruction Viewer's list.
  - getType
```
public String getType()
```
    Gets the type of this annotation.
    
    Returns:
    
    the annotation type. Either cloud (point cloud), surface, line, or mixed (composite shape).
  - setLabel
```
protected void setLabel(String label)
```
  - getBarycentre
```
public SNTPoint getBarycentre()
```
    Returns the center of this annotation bounding box.
    
    Returns:
    
    the barycentre of this annotation. All coordinates are set to Double.NaN if the bounding box is not available.
  - getVolume
```
public double getVolume()
```
  - getDrawable
```
public org.jzy3d.plot3d.primitives.AbstractDrawable getDrawable()
```
    Returns the AbstractDrawable associated with this annotation.
    
    Returns:
    
    the AbstractDrawable

Class Annotation3D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCATTER

SURFACE

STRIP

Q_TIP

MERGE

SURFACE_AND_VOLUME

Constructor Detail

Annotation3D

Annotation3D

Annotation3D

Annotation3D

Annotation3D

Method Detail

meshToDrawable

setSize

setColor

setColor

setColor

setBoundingBoxColor

getLabel

getType

setLabel

getBarycentre

getVolume

getDrawable