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

VSG extension (Preview feature) [Medical] Shape node to display a dynamic scale bar in window coordinates. More...

#include <Medical/nodes/SliceScaleBar.h>

+ Inheritance diagram for SliceScaleBar:

Public Types

enum  Orientation {
  HORIZONTAL = 0 ,
  VERTICAL = 1
}
 Scale bar orientation. More...
 
enum  Alignment {
  LEFT = 0 ,
  BOTTOM = 0 ,
  CENTER = 1 ,
  RIGHT = 2 ,
  TOP = 2
}
 Scale bar alignment. 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...
 

Public Member Functions

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

SoSFVec2f position
 Position in normalized screen coordinates (-1 to 1).
 
SoSFFloat length
 Length in normalized screen coordinates (-1 to 1) if not tracking, else length in 3D world coordinates.
 
SoSFInt32 numTickIntervals
 Number of tick intervals (default is 0).
 
SoSFNode trackedCamera
 Tracked camera (default is null).
 
SoSFEnum orientation
 Scale bar orientation (default is HORIZONTAL).
 
SoSFEnum alignment
 Scale bar alignment (default is CENTER).
 
SoSFString label
 Label (default is empty string).
 
- 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

Detailed Description

VSG extension (Preview feature) [Medical] Shape node to display a dynamic scale bar in window coordinates.

This class displays a 2D scale bar. The position of the scale bar is specified in normalized screen coordinates (-1 to 1). By default, the length of the scale bar is a fixed distance in normalized screen coordinates. However if the trackedCamera field is set, then length is a distance in 3D world coordinates and the the size of the scale bar on screen is computed based on that distance. For example, if the application is viewing DICOM data measured in millimeters (mm), then setting length to 100 displays a scale bar that shows the distance 10 cm on screen. The scale bar size will change if the camera is zoomed in or out (camera height field changes).

The distance computation is based on "horizontal" or "vertical" relative to the camera, so the scale bar adjusts automatically if the camera is rotated to view a different volume axis, e.g. Coronal vs Axial.

This class is not intended to replace the MeshViz axis classes for general 2D data plotting. This class has only been tested with SoOrthoSlice and an SoOrthographicCamera (the usual case for medical image viewing).

FILE FORMAT/DEFAULT

    SliceScaleBar {
    position 0 0 0
    length 1
    numTickIntervals 0
    trackedCamera null
    orientation HORIZONTAL
    alignment CENTER
    label ""
    }

SEE ALSO

InventorMedical, DicomInfo, Gnomon, Magnifier, Ruler, SliceOrientationMarkers

Definition at line 89 of file SliceScaleBar.h.

Member Enumeration Documentation

◆ Alignment

Scale bar alignment.

Enumerator
LEFT 

Left (for horizontal orientation).

BOTTOM 

Bottom (for vertical orientation).

CENTER 

Center (for either orientation).

RIGHT 

Right (for horizontal orientation).

TOP 

Top (for vertical orientation).

Definition at line 139 of file SliceScaleBar.h.

◆ Orientation

Scale bar orientation.

Enumerator
HORIZONTAL 

Horizontal.

VERTICAL 

Vertical.

Definition at line 131 of file SliceScaleBar.h.

Constructor & Destructor Documentation

◆ SliceScaleBar()

SliceScaleBar::SliceScaleBar ( )

Constructor.

Member Function Documentation

◆ exitClass()

static void SliceScaleBar::exitClass ( )
static

Finish using the class.

◆ getClassTypeId()

static SoType SliceScaleBar::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SliceScaleBar::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoAnnotation.

◆ initClass()

static void SliceScaleBar::initClass ( )
static

Initialize the class.

Member Data Documentation

◆ alignment

SoSFEnum SliceScaleBar::alignment

Scale bar alignment (default is CENTER).

Definition at line 125 of file SliceScaleBar.h.

◆ label

SoSFString SliceScaleBar::label

Label (default is empty string).

Definition at line 128 of file SliceScaleBar.h.

◆ length

SoSFFloat SliceScaleBar::length

Length in normalized screen coordinates (-1 to 1) if not tracking, else length in 3D world coordinates.

Default is 1.

For example, if the application is viewing DICOM data measured in millimeters (mm), then setting length to 100 displays a 10 cm scale bar on screen.

Definition at line 105 of file SliceScaleBar.h.

◆ numTickIntervals

SoSFInt32 SliceScaleBar::numTickIntervals

Number of tick intervals (default is 0).

If numTickIntervals is 0, no tick marks are drawn. For example, if the length is set to 100 mm, then set numTickIntervals to 10 to get a tick mark every 10 mm (1 cm).

Definition at line 112 of file SliceScaleBar.h.

◆ orientation

SoSFEnum SliceScaleBar::orientation

Scale bar orientation (default is HORIZONTAL).

Definition at line 122 of file SliceScaleBar.h.

◆ position

SoSFVec2f SliceScaleBar::position

Position in normalized screen coordinates (-1 to 1).

Default is (0,0,0).

Definition at line 96 of file SliceScaleBar.h.

◆ trackedCamera

SoSFNode SliceScaleBar::trackedCamera

Tracked camera (default is null).

This should be the camera that is viewing the tracked scene. It will be used to determine the length of the axis in NDC based on the specified length in 3D world coordinates.

Definition at line 119 of file SliceScaleBar.h.


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