com.openinventor.medical.nodes

Class Ruler

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.medical.nodes.Ruler

All Implemented Interfaces:

SafeDisposable

public class Ruler
extends SoNode

(Preview Feature) Interactive distance measuring tool for SoOrthoSlice.

Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.

This node displays an interactive distance measuring tool on top of an SoOrthoSlice. The user can click and drag to display a line and the physical distance between the clicked point and the current cursor position.

This node is only intended to be used in a "2D" viewing environment using an SoOrthographicCamera, for example viewing a single slice of a medical volume.

This node requires that the application handle mouse press, release and move events. Mouse move events must be forwarded to the node using the manageMouseMove method.

File format/default:

Ruler {

globalFactor	1
label	mm

}

See Also:

DicomInfo, Magnifier, Gnomon

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFFloat	globalFactor Specifies a scale factor applied to the size of the arrowheads on the line.
SoSFString	label Specifies a label string appended to the measurement value.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
Ruler() Constructor

Method Summary

Modifier and Type	Method and Description
void	doAction(SoAction action) Override doAction function
void	getBoundingBox(SoGetBoundingBoxAction action) Override getBoundingBox function
SoFont	getFont() Access the font property
void	GLRender(SoGLRenderAction action) Override GLRender function
void	manageMouseMove(boolean firstClick, SoOrthoSliceDetail detail) The application should call this method with 'true' on the mouse down event that begins a measure operation, then call this method with 'false' on each mouse move event during the measure operation.

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, getAlternateRep, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

globalFactor

public SoSFFloat globalFactor

Specifies a scale factor applied to the size of the arrowheads on the line. Default is 1.

label

public SoSFString label

Specifies a label string appended to the measurement value. Default is "mm".

Constructor Detail

Ruler

public Ruler()

Constructor

Method Detail

doAction

public void doAction(SoAction action)

Override doAction function

Overrides:

doAction in class SoNode

Parameters:

action - Generic Inventor action

GLRender

public void GLRender(SoGLRenderAction action)

Override GLRender function

Overrides:

GLRender in class SoNode

Parameters:

action - GL Render action

getBoundingBox

public void getBoundingBox(SoGetBoundingBoxAction action)

Override getBoundingBox function

Overrides:

getBoundingBox in class SoNode

Parameters:

action - GetBoundingBox action

manageMouseMove

public void manageMouseMove(boolean firstClick,
                            SoOrthoSliceDetail detail)

The application should call this method with 'true' on the mouse down event that begins a measure operation, then call this method with 'false' on each mouse move event during the measure operation. See the medicalRuler example program for more details.

getFont

public SoFont getFont()

Access the font property