Click or drag to resize
DicomInfo Class

Text node to display DICOM information on sceen.

Preview Feature: 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.

Inheritance Hierarchy

Namespace: OIV.Medical.Nodes
Assembly: OIV.Medical (in OIV.Medical.dll) Version: 2024.2.2.Release.77a61d1a523234b418592ccd07676e84f6c1d90b
Syntax
public class DicomInfo : TextBox

The DicomInfo type exposes the following members.

Constructors
  NameDescription
Public methodDicomInfo
Constructor
Top
Methods
  NameDescription
Public methodAddChild

Adds a child as last one in group.

(Inherited from SoGroup.)
Public methodAddLine
Add a line of text at the bottom of the box.
(Inherited from TextBox.)
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoSeparator.)
Public methodCallback
(Inherited from SoSeparator.)
Public methodClearCacheList
(Inherited from SoSeparator.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDeleteAll
Delete all lines of text
(Inherited from TextBox.)
Public methodDeleteLines
Delete one or more lines of text. Default is to delete one line. -1 means delete all lines starting with 'startline'
(Inherited from TextBox.)
Public methodDisplayDicomInfo(String, String)
Add a line to the DICOM annotation.
Public methodDisplayDicomInfo(String, UInt16, UInt16)
Add a line to the DICOM annotation.
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoSeparator.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodFindChild

Finds index of given child within group.

(Inherited from SoGroup.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoSeparator.)
Public methodGetChild

Returns pointer the child node with the given index.

(Inherited from SoGroup.)
Public methodGetDicomInfo
Returns the string representing the specified DICOM tag (empty if not present)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetFontNode
Get the internal font node (allows to modify font parameters directly)
(Inherited from TextBox.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetLine
Get the contents of the specified line of text.
(Inherited from TextBox.)
Public methodGetMatrix
(Inherited from SoSeparator.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNumChildren

Returns number of children.

(Inherited from SoGroup.)
Public methodGetNumLines
Get number of lines of text currently in the box
(Inherited from TextBox.)
Public methodGetPrimitiveCount
(Inherited from SoSeparator.)
Public methodGetRenderEngineMode
This override is mandatory to specify the custom node's render engine mode. If not overridden, a warning message will be displayed.
(Overrides TextBoxGetRenderEngineMode.)
Public methodGetRenderUnitID
(Inherited from SoAnnotation.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetTextNode
Get internal text node (allows to modify the spacing directly)
(Inherited from TextBox.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
(Inherited from SoAnnotation.)
Public methodGLRenderBelowPath
(Inherited from SoAnnotation.)
Public methodGLRenderInPath
(Inherited from SoAnnotation.)
Public methodGLRenderOffPath
(Inherited from SoAnnotation.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoSeparator.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodInsertChild

Adds a child so that it becomes the one with the given index.

(Inherited from SoGroup.)
Public methodIsBoundingBoxIgnoring

Used by BoundingBoxAction to known if bounding box computation should be ignored or not.

(Inherited from SoGroup.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoGroup.)
Public methodRayPick
(Inherited from SoSeparator.)
Public methodRemoveAllChildren

Removes all children from group.

(Inherited from SoGroup.)
Public methodRemoveChild(Int32)

Removes child with given index from group.

(Inherited from SoGroup.)
Public methodRemoveChild(SoNode)

Removes first instance of given child from group.

(Inherited from SoGroup.)
Public methodReplaceChild(Int32, SoNode)

Replaces child with given index with new child.

(Inherited from SoGroup.)
Public methodReplaceChild(SoNode, SoNode)

Replaces first instance of given child with new child.

(Inherited from SoGroup.)
Public methodSearch
(Inherited from SoSeparator.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetLine
Set the contents of the specified line of text (convenience method).
(Inherited from TextBox.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoGroup.)
Top
Fields
  NameDescription
Public fieldalignmentH
Horizontal alignment of the text box (default is LEFT).
(Inherited from TextBox.)
Public fieldalignmentV
Vertical alignment of the text box (default is TOP).
(Inherited from TextBox.)
Public fieldborder
Enable drawing a border around the text box (default is FALSE).
(Inherited from TextBox.)
Public fieldborderColor
Border color (default is 1,1,1).
(Inherited from TextBox.)
Public fieldfileName
Path to the DICOM file used to extract DICOM info. Default is empty.
Public fieldfontName
Specify the font name (default is "Arial:Bold"). See SoFont.name for details
(Inherited from TextBox.)
Public fieldfontSize
Specify the font size in pixels (default is 15).
(Inherited from TextBox.)
Public fieldposition
Position of the text box in normalized screen coordinates (-1 to 1). Default is 0,0,0.
(Inherited from TextBox.)
Public fieldtextAlignH
Horizontal alignment of the text inside the box (default is LEFT).
(Inherited from TextBox.)
Top
Properties
  NameDescription
Public propertyboundingBoxCaching
(Inherited from SoSeparator.)
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoGroup.)
Public propertyfastEditing

Specifies the fast edit mode of the separator node.

(Inherited from SoSeparator.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertypickCulling

Whether to cull during picking traversal.

(Inherited from SoSeparator.)
Public propertyrenderCaching Obsolete.

Whether to cache during rendering traversal.

(Inherited from SoSeparator.)
Public propertyrenderCulling

Whether to cull during rendering traversal.

(Inherited from SoSeparator.)
Public propertyrenderUnitId

Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.

(Inherited from SoSeparator.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This node is a convenience class derived from TextBox for displaying DICOM annotation text on screen.

This node displays a text box at a fixed location in the viewer window. The position is specified in normalized device coordinates -1 to 1. The DICOM file is specified using the 'fileName' field.

Alignment options allow the box to be positioned, for example, in a corner of the window. For example position -0.98, -0.98, 0 with default alignment is the upper left corner of the window. The text box automatically expands or shrinks when lines of text are added to or deleted from the box. Positioning a text box in the lower left corner creates a sort of 'console' output overlaying the scene. Note that the alignment options control the positioning of the text box. The text inside the box is currently always left justified.

In order to have convenient default values for font size, the font settings are not inherited from the scene graph. By default the text is rendered using an SoText2 node with font name 'Arial', font size 16 and line spacing 1.1. The application can modify these values using the GetFontNode() and GetTextNode() methods. Lighting and picking are disabled. Text will be rendered on top of whatever is rendered in the main scene graph. The application can modify the text strings directly, but this class also provides some convenience methods that are very useful. For example, the AddLine() method appends a new string to the end of the list.

FILE FORMAT/DEFAULT

DicomInfo {
fileName ""
position 0 0 0
alignmentH LEFT
alignmentV TOP
textAlignH LEFT
fontName Arial:Bold
fontSize 15
border FALSE
borderColor 1 1 1
}

See Also