Package gov.nih.mipav.view.renderer.WildMagic.flythroughview

Class FlyPathAnnotateList_WM

java.lang.Object

gov.nih.mipav.view.renderer.WildMagic.flythroughview.FlyPathAnnotateList_WM

public class FlyPathAnnotateList_WM
extends java.lang.Object

Container which stores annotations which include the following: - point position and normal - camera location, view up and view direction, branch and location along branch when point annotated - geometry and appearance - description.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FlyPathAnnotateList_WM.Item	Single annotation item.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_iNextItemKey	Annotation item number.
protected java.util.ArrayList<FlyPathAnnotateList_WM.Item>	m_kList	Annotation list

Constructor Summary

Constructors

Constructor	Description
FlyPathAnnotateList_WM()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addItem(int iBranch, float fNormalizedPathDist, boolean bPathMoveForward, WildMagic.LibFoundation.Mathematics.Vector3f kPointPosition, WildMagic.LibFoundation.Mathematics.Vector3f kPointNormal, WildMagic.LibFoundation.Mathematics.Vector3f kCLoc, WildMagic.LibFoundation.Mathematics.Vector3f kCDir, WildMagic.LibFoundation.Mathematics.Vector3f kCUp, WildMagic.LibFoundation.Mathematics.Vector3f kCRight)	Create a new annotation item with the specified information and add the item to the end of the list.
void	addItem(FlyPathAnnotateList_WM.Item kNewItem)	Add the specified annotation item to the end of the list.
FlyPathAnnotateList_WM.Item	getItem(int iItem)	Return the specified annotation item.
int	getNumItems()	Return the number of annotation items stored.
void	removeItem(int iItem)	Remove the specified annotation item from the list.

Methods inherited from class java.lang.Object

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

Field Detail

m_iNextItemKey

protected int m_iNextItemKey

Annotation item number.

m_kList

protected java.util.ArrayList<FlyPathAnnotateList_WM.Item> m_kList

Annotation list

Constructor Detail

FlyPathAnnotateList_WM

public FlyPathAnnotateList_WM()

Constructor. Initially an empty list.

Method Detail

addItem

public void addItem(int iBranch,
                    float fNormalizedPathDist,
                    boolean bPathMoveForward,
                    WildMagic.LibFoundation.Mathematics.Vector3f kPointPosition,
                    WildMagic.LibFoundation.Mathematics.Vector3f kPointNormal,
                    WildMagic.LibFoundation.Mathematics.Vector3f kCLoc,
                    WildMagic.LibFoundation.Mathematics.Vector3f kCDir,
                    WildMagic.LibFoundation.Mathematics.Vector3f kCUp,
                    WildMagic.LibFoundation.Mathematics.Vector3f kCRight)

Create a new annotation item with the specified information and add the item to the end of the list. Set the item's appearance and geometry based on the defaults. Generate a description for the item based on the number of items inserted already.

Parameters:

iBranch - int Index of branch from which the item was seen and annotated.

fNormalizedPathDist - float Relative distance along the branch (in the [0,1] range) from which the item was seen and annotated.

bPathMoveForward - boolean Flag set if the moving forward, as opposed to in reverse, down the path.

kPointPosition - Point3f Coordinates of the annotated point.

kPointNormal - Vector3f Normal vector associated with the annotated point.

kCLoc - Camera location.

kCDir - Camera view direction.

kCUp - Camera up vector.

kCRight - Camera right vector.

addItem

public void addItem(FlyPathAnnotateList_WM.Item kNewItem)

Add the specified annotation item to the end of the list.

Parameters:

kNewItem - Item Information about the annotation item to be added.

getItem

public FlyPathAnnotateList_WM.Item getItem(int iItem)

Return the specified annotation item.

Parameters:

iItem - Index of the specified item.

Returns:

Item Information about the annotation item.

getNumItems

public int getNumItems()

Return the number of annotation items stored.

Returns:

int Number of annotation items.

removeItem

public void removeItem(int iItem)

Remove the specified annotation item from the list.

Parameters:

iItem - Index of the annotation item in the list to be removed.