Package com.openinventor.medical.nodes

Class Gnomon

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoGroup

com.openinventor.inventor.nodes.SoSeparator

com.openinventor.inventor.nodes.SoAnnotation

com.openinventor.medical.nodes.Gnomon

All Implemented Interfaces:

SafeDisposable

public class Gnomon
extends SoAnnotation

(Preview Feature) Shape node to display a medical gnomon (compass) on the screen.

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 a medical specific "gnomon" (compass) on the screen that shows the user the current orientation of the volume in 3D space. Visibility of the gnomon is controlled by the isDisplayed field. Position and size of the gnomon are specified in pixels using the position, width and height fields.

File format/default:

Gnomon {

isDisplayed	TRUE
position	0 0
width	100
height	100

}

See Also:

DicomInfo, Magnifier, Ruler

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoSeparator

SoSeparator.Cachings, SoSeparator.FastEditings, SoSeparator.RenderUnitIds

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoNode

SoNode.RenderModes

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field	Description
SoSFFloat	cameraDistance	Specifies the distance from the camera to the gnomon geometry.
SoSFInt32	height	Specifies the height of the gnomon viewport in pixels (default is 100).
SoSFBool	isDisplayed	Controls whether the gnomon is visible (default is true).
SoSFVec2i32	position	Position of the gnomon viewport in pixels (default is 0,0).
SoSFInt32	width	Specifies the width of the gnomon viewport in pixels (default is 100).

Fields inherited from class com.openinventor.inventor.nodes.SoSeparator

boundingBoxCaching, fastEditing, pickCulling, renderCaching, renderCulling, renderUnitId

Fields inherited from class com.openinventor.inventor.nodes.SoGroup

boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor	Description
Gnomon()	Constructor

Method Summary

Modifier and Type	Method	Description
SoNode.RenderModes	getRenderEngineMode()	Returns the supported Render engine mode.
void	setGeometry(SoNode geometrySceneGraph)	Replace the gnomon geometry (default is basic medical gnomon).
void	setScale(SbVec3f scale)	Scale the size of the gnomon (default is 1,1,1).

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

addChild, findChild, getChild, getNumChildren, insertChild, removeAllChildren, removeChild, removeChild, replaceChild, replaceChild

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

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, 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, getName, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getNativeResourceHandle

Methods inherited from class java.lang.Object

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

Field Detail

isDisplayed

public SoSFBool isDisplayed

Controls whether the gnomon is visible (default is true).

position

public SoSFVec2i32 position

Position of the gnomon viewport in pixels (default is 0,0).

width

public SoSFInt32 width

Specifies the width of the gnomon viewport in pixels (default is 100).

height

public SoSFInt32 height

Specifies the height of the gnomon viewport in pixels (default is 100).

cameraDistance

public SoSFFloat cameraDistance

Specifies the distance from the camera to the gnomon geometry. Default is 3.5. Applications should not need to modify this value.

Constructor Detail

Gnomon

public Gnomon()

Constructor

Method Detail

getRenderEngineMode

public SoNode.RenderModes getRenderEngineMode()

Description copied from class: SoNode

Returns the supported Render engine mode.

For custom node, this method returns by default SoNode.RenderModes.OIV_UNKNOWN_RENDERING_MODE, override this method to specify the Render engine mode supported by your custom node.

Overrides:

getRenderEngineMode in class SoNode

Returns:

the supported Render engine mode for this node.

setScale

public void setScale(SbVec3f scale)

Scale the size of the gnomon (default is 1,1,1).

setGeometry

public void setGeometry(SoNode geometrySceneGraph)

Replace the gnomon geometry (default is basic medical gnomon). Gnomon geometry should have a 3D extent of -1 to 1.