Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
OrthoSliceBorder Class Reference

VSG extension (Preview feature) [Medical] Ortho slice shape node with border. More...

#include <Medical/nodes/OrthoSliceBorder.h>

+ Inheritance diagram for OrthoSliceBorder:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 OrthoSliceBorder ()
 Constructor.
 
- Public Member Functions inherited from SoOrthoSlice
 SoOrthoSlice ()
 Constructor.
 
virtual SbBool affectsState () const
 Overrides default method on SoShape.
 
virtual void setRenderProgress (SoProgressIndicator *ps) override
 Set an application defined SoProgressIndicator object which will raise an event before and after the rendering task, before and after each subtask (in this case: Texture creation and Geometry creation) and after each step in the subtasks which represents in most cases individual tiles of data.
 
- Public Member Functions inherited from SoShape
ShapeType getShapeType ()
 Gets the current shape Full Scene Antialiasing type.
 
- 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 class (called automatically by InventorMedical::init()).
 
static void exitClass ()
 Finish using class (called automatically by InventorMedical::finish()).
 
- Static Public Member Functions inherited from SoOrthoSlice
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoSlice
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoVolumeShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoLdmShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SbBool isPrimitiveRestartAvailable (SoState *state=NULL)
 Returns TRUE if the primitive restart feature is available.
 
- 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.
 

Additional Inherited Members

- Public Types inherited from SoOrthoSlice
enum  Axis {
  X ,
  Y ,
  Z
}
 Slice Axis (see discussion of medical data axes in the class description) More...
 
enum  ClippingSide {
  FRONT ,
  BACK
}
 Clipping Side mode. More...
 
- Public Types inherited from SoSlice
enum  AlphaUse {
  ALPHA_AS_IS ,
  ALPHA_OPAQUE ,
  ALPHA_BINARY
}
 Alpha component usage mode Used in the alphaUse field. More...
 
- Public Types inherited from SoVolumeShape
enum  Interpolation {
  NEAREST ,
  LINEAR ,
  TRILINEAR ,
  MULTISAMPLE_12 ,
  CUBIC
}
 Interpolation mode. More...
 
enum  Composition {
  MAX_INTENSITY = 0 ,
  MIN_INTENSITY ,
  SUM_INTENSITY ,
  ALPHA_BLENDING ,
  COMPOSITION_LAST
}
 Composition mode. More...
 
- Public Types inherited from SoShape
enum  ShapeType {
  POINTS ,
  LINES ,
  POLYGONS ,
  TEXT
}
 Basic type for antialiased rendering for this shape (Do not consider the SoDrawStyle property currently in the state). More...
 
- Public Attributes inherited from SoOrthoSlice
SoSFInt32 dataSetId
 Specifies the SoVolumeData node to use.
 
SoSFUInt32 sliceNumber
 Slice number.
 
SoSFEnum axis
 Slice axis (X, Y, or Z).
 
SoSFEnum clippingSide
 Specifies the clipping side.
 
SoSFBool clipping
 Activate/deactivate a clipping plane on a per-slice basis.
 
SoSFBool enableBorder
 Enables drawing the border.
 
SoSFColor borderColor
 Border color.
 
SoSFFloat borderWidth
 Border width in pixels.
 
SoSFBool enableImage
 Enables drawing the slice image.
 
- Public Attributes inherited from SoSlice
SoSFBool enableBumpMapping
 Specifies if a bump mapping effect will be applied to the slice.
 
SoSFFloat bumpScale
 Specifies the intensity of the bump mapping effect.
 
SoSFNode alternateRep
 This field optionally holds a subgraph containing only core Open Inventor nodes that can be used for rendering when VolumeViz is not available.
 
SoSFEnum alphaUse
 Specifies how to use the alpha component of each voxel's RGBA value.
 
SoSFBool useRGBA
 Specifies whether to create RGBA textures.
 
SoSFBool largeSliceSupport
 Activate/deactivate direct loading of full resolution slice data.
 
- Public Attributes inherited from SoVolumeShape
SoSFEnum interpolation
 Interpolation mode.
 
SoDEPRECATED SoSFEnum composition
 Specifies color composition mode.
 
- Public Attributes inherited from SoShape
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

VSG extension (Preview feature) [Medical] Ortho slice shape node with border.

This node is a subclass of SoOrthoSlice. It defines an ortho (axis aligned) slice along the X, Y, or Z axis of a volume defined by an SoVolumeData node.

See SoOrthoSlice for important details about slice rendering. Note that the SoOrthoSlice clipping feature does not affect rendering of the border.

The border color can be used, for example, to help the user see at a glance which axis each slice corresponds to. Another use is to change the border color when a slice is selected.

Create an SoOrthoSlice node in the 2D view. Then create an OrthoSliceBorder node in the 3D view, set its renderSlice field to false and connect its sliceNumber field to the sliceNumber field of the SoOrthoSlice node to keep the slices in sync.

FILE FORMAT/DEFAULT

    OrthoSliceBorder {
    dataSetId 0
    sliceNumber 0
    axis Z
    interpolation LINEAR
    alphaUse ALPHA_BINARY
    useRGBA FALSE
    clipping FALSE
    clippingSide BACK
    alternateRep NULL
    enableBumpMapping FALSE
    bumpScale 1.0
    enableBorder FALSE
    borderColor 0.84 0.43 0.02
    borderWidth 2.0
    enableImage TRUE
    }

SEE ALSO

InventorMedical, SoOrthoSlice, SoObliqueSlice, ObliqueSliceBorder

Definition at line 76 of file OrthoSliceBorder.h.

Constructor & Destructor Documentation

◆ OrthoSliceBorder()

OrthoSliceBorder::OrthoSliceBorder ( )

Constructor.

Member Function Documentation

◆ exitClass()

static void OrthoSliceBorder::exitClass ( )
static

Finish using class (called automatically by InventorMedical::finish()).

◆ getClassTypeId()

static SoType OrthoSliceBorder::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType OrthoSliceBorder::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoOrthoSlice.

◆ initClass()

static void OrthoSliceBorder::initClass ( )
static

Initialize class (called automatically by InventorMedical::init()).


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