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

VSG extension (Preview feature) [Medical] Shape node to display slice orientation markers in window coordinates. More...

#include <Medical/nodes/SliceOrientationMarkers.h>

+ Inheritance diagram for SliceOrientationMarkers:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SliceOrientationMarkers ()
 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 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

SoSFEnum axis
 Axis (default is AXIAL).
 
SoSFFloat offset
 Distance from edge of window to letter.
 
SoSFString fontName
 Specify the font name (default is "Arial:Bold").
 
SoSFFloat fontSize
 Specify the font size in pixels (default is 17).
 
- 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 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] Shape node to display slice orientation markers in window coordinates.

This node displays slice orientation markers at a fixed location in the viewer window. Slice orientation markers are useful when viewing images in a "2D" mode. The orientation markers are a set of four letters. Each letter is displayed at the mid-point of one edge of the window and offset inward by the value specified in the offset field. The letters displayed depend on the value of the axis field and correspond to the DICOM radiological viewing convention. This node is intended to be used with SoOrthoSlice and a "plane" viewer.

The application can connect the axis field from the 'axis' field of the SoOrthoSlice node and the correct orientation markers will be displayed automatically if the slice axis is changed.

For:

  • AXIAL display
    • Left/Right: R(ight) / L(eft)
    • Top/Bottom: A(nterior) / P(osterior)
  • CORONAL display
    • Left/Right: R(ight) / L(eft)
    • Top/Bottom: S(uperior) / I(nferior)
  • SAGITTAL display
    • Left/Right: A(nterior) / P(osterior)
    • Top/Bottom: S(uperior) / I(nferior)

FILE FORMAT/DEFAULT

SEE ALSO

InventorMedical, DicomInfo, Gnomon, Magnifier, Ruler, SliceScaleBar, TextBox

Definition at line 83 of file SliceOrientationMarkers.h.

Constructor & Destructor Documentation

◆ SliceOrientationMarkers()

SliceOrientationMarkers::SliceOrientationMarkers ( )

Constructor.

Member Function Documentation

◆ exitClass()

static void SliceOrientationMarkers::exitClass ( )
static

Finish using the class.

◆ getClassTypeId()

static SoType SliceOrientationMarkers::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SliceOrientationMarkers::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoAnnotation.

◆ initClass()

static void SliceOrientationMarkers::initClass ( )
static

Initialize the class.

Member Data Documentation

◆ axis

SoSFEnum SliceOrientationMarkers::axis

Axis (default is AXIAL).

Use enum MedicalHelper::Axis.

Definition at line 90 of file SliceOrientationMarkers.h.

◆ fontName

SoSFString SliceOrientationMarkers::fontName

Specify the font name (default is "Arial:Bold").

See SoFont::name for details.

Definition at line 98 of file SliceOrientationMarkers.h.

◆ fontSize

SoSFFloat SliceOrientationMarkers::fontSize

Specify the font size in pixels (default is 17).

Definition at line 101 of file SliceOrientationMarkers.h.

◆ offset

SoSFFloat SliceOrientationMarkers::offset

Distance from edge of window to letter.

Specified in normalized screen coordinates (-1 to 1). Default is 0.05.

Definition at line 94 of file SliceOrientationMarkers.h.


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