Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
DicomInfo Class Reference

VSG extension (Preview feature) [Medical] Text node to display DICOM information on sceen. More...

#include <Medical/nodes/DicomInfo.h>

+ Inheritance diagram for DicomInfo:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
int displayDicomInfo (SbString title, unsigned short group, unsigned short element)
 Add a line to the DICOM annotation.
 
int displayDicomInfo (SbString title, SbString infoString)
 Add a line to the DICOM annotation.
 
SbString getDicomInfo (unsigned short group, unsigned short element)
 Returns the string representing the specified DICOM tag (empty if not present).
 
 DicomInfo ()
 Constructor.
 
- Public Member Functions inherited from TextBox
void setLine (const SbString &text, int line=0)
 Set the contents of the specified line of text (convenience method).
 
const SbStringgetLine (int line)
 Get the contents of the specified line of text.
 
void addLine (const SbString &text)
 Add a line of text at the bottom of the box.
 
void deleteLines (int startLine, int numToDelete=1)
 Delete one or more lines of text.
 
void deleteAll ()
 Delete all lines of text.
 
int getNumLines () const
 Get number of lines of text currently in the box.
 
SoFontgetFontNode ()
 Get the internal font node (allows to modify font parameters directly).
 
SoText2getTextNode ()
 Get the internal text node (allows to modify line spacing directly).
 
 TextBox ()
 Constructor.
 
- Public Member Functions inherited from SoAnnotation
 SoAnnotation ()
 Creates an annotation node with default settings.
 
- Public Member Functions inherited from SoSeparator
 SoSeparator ()
 Creates a separator node with default settings.
 
 SoSeparator (int nChildren)
 Constructor that takes approximate number of children.
 
- Public Member Functions inherited from SoGroup
 SoGroup ()
 Creates an empty group node.
 
 SoGroup (int nChildren)
 Constructor that takes approximate number of children.
 
virtual void addChild (SoNode *child)
 Adds a child as last one in group.
 
virtual void insertChild (SoNode *child, int newChildIndex)
 Adds a child so that it becomes the one with the given index.
 
virtual SoNodegetChild (int index) const
 Returns pointer the child node with the given index.
 
virtual int findChild (const SoNode *child) const
 Finds index of given child within group.
 
virtual int getNumChildren () const
 Returns number of children.
 
virtual void removeChild (int index)
 Removes child with given index from group.
 
virtual void removeChild (SoNode *child)
 Removes first instance of given child from group.
 
virtual void removeAllChildren ()
 Removes all children from group.
 
virtual void replaceChild (int index, SoNode *newChild)
 Replaces child with given index with new child.
 
virtual void replaceChild (SoNode *oldChild, SoNode *newChild)
 Replaces first instance of given child with new child.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 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.
 
SbBool set (const SbString &fieldDataString)
 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.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static void initClass ()
 Initialize the class.
 
static void exitClass ()
 Finish using the class.
 
- Static Public Member Functions inherited from TextBox
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static void initClass ()
 Initialize the class.
 
static void exitClass ()
 Finish using the class.
 
- Static Public Member Functions inherited from SoAnnotation
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoSeparator
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoGroup
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFFilePathString fileName
 Path to the DICOM file used to extract DICOM info.
 
- Public Attributes inherited from TextBox
SoSFVec3f position
 Position of the text box in normalized screen coordinates (-1 to 1).
 
SoSFEnum alignmentH
 Horizontal alignment of the text box (default is LEFT).
 
SoSFEnum alignmentV
 Vertical alignment of the text box (default is TOP).
 
SoSFEnum textAlignH
 Horizontal alignment of the text inside the box (default is LEFT).
 
SoSFString fontName
 Specify the font name (default is "Arial:Bold").
 
SoSFFloat fontSize
 Specify the font size in pixels (default is 15).
 
SoSFBool border
 Enable drawing a border around the text box (default is FALSE).
 
SoSFColor borderColor
 Border color (default is 1,1,1).
 
- Public Attributes inherited from SoSeparator
SoSFEnum boundingBoxCaching
 Whether to cache during bounding box traversal.
 
SoSFEnum renderCulling
 Whether to cull during rendering traversal.
 
SoSFEnum pickCulling
 Whether to cull during picking traversal.
 
SoSFEnum fastEditing
 Specifies the fast edit mode of the separator node.
 
SoSFInt32 renderUnitId
 Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.
 
SoDEPRECATED SoSFEnum renderCaching
 Whether to cache during rendering traversal.
 
- Public Attributes inherited from SoGroup
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Additional Inherited Members

- Public Types inherited from TextBox
enum  AlignmentH {
  LEFT = SoTextProperty::LEFT ,
  CENTER = SoTextProperty::CENTER ,
  RIGHT = SoTextProperty::RIGHT
}
 Horizontal alignment values. More...
 
enum  AlignmentV {
  TOP = SoTextProperty::TOP ,
  MIDDLE = SoTextProperty::HALF ,
  BOTTOM = SoTextProperty::BOTTOM
}
 Vertical alignment values. More...
 
- Public Types inherited from SoSeparator
enum  CacheEnabled {
  OFF ,
  ON ,
  AUTO
}
 Possible values for caching. More...
 
enum  FastEditing {
  DISABLE = 0x01 ,
  KEEP_ZBUFFER = 0x02 ,
  CLEAR_ZBUFFER = 0x03
}
 Fast editing policy enumeration values. More...
 

Detailed Description

VSG extension (Preview feature) [Medical] Text node to display DICOM information on sceen.

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

InventorMedical, TextBox, Gnomon, Magnifier, Ruler

Definition at line 80 of file DicomInfo.h.

Constructor & Destructor Documentation

◆ DicomInfo()

DicomInfo::DicomInfo ( )

Constructor.

Member Function Documentation

◆ displayDicomInfo() [1/2]

int DicomInfo::displayDicomInfo ( SbString  title,
SbString  infoString 
)

Add a line to the DICOM annotation.

  • title: a string to prefix the DICOM info
  • infoString : a string to define miscellaneous info

Returns : index of the next insertion

◆ displayDicomInfo() [2/2]

int DicomInfo::displayDicomInfo ( SbString  title,
unsigned short  group,
unsigned short  element 
)

Add a line to the DICOM annotation.

  • title: a string to prefix the DICOM info
  • group / element : tag of requested DICOM info

Returns : index of the next insertion

◆ exitClass()

static void DicomInfo::exitClass ( )
static

Finish using the class.

◆ getClassTypeId()

static SoType DicomInfo::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getDicomInfo()

SbString DicomInfo::getDicomInfo ( unsigned short  group,
unsigned short  element 
)

Returns the string representing the specified DICOM tag (empty if not present).

◆ getTypeId()

virtual SoType DicomInfo::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from TextBox.

◆ initClass()

static void DicomInfo::initClass ( )
static

Initialize the class.

Member Data Documentation

◆ fileName

SoSFFilePathString DicomInfo::fileName

Path to the DICOM file used to extract DICOM info.

Default is empty.

Definition at line 89 of file DicomInfo.h.


The documentation for this class was generated from the following file: