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

VolumeViz Abstract base class for slice shape nodes. More...

#include <VolumeViz/nodes/SoSlice.h>

+ Inheritance diagram for SoSlice:

Public Types

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 Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
- Public Member Functions inherited from SoVolumeShape
virtual void setRenderProgress (SoProgressIndicator *ps)
 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
virtual SbBool affectsState () const
 Overrides default method on SoNode.
 
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 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.
 

Public Attributes

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

VolumeViz Abstract base class for slice shape nodes.

This class defines common properties for the SoOrthoSlice, SoObliqueSlice, SoFenceSlice, SoVolumeSkin and SoHeightFieldRender nodes.

The alphaUse field controls how the voxel's alpha component is used when drawing the slice.

The enableBumpMapping and bumpScale fields control a rendering effect called bump mapping that simulates displacement of the slice surface using the gradient vectors (computed on the GPU) as normal vectors.

The largeSliceSupport field enables direct loading of full resolution slice data from the volume reader, without (necessarily) loading complete tiles.

SEE ALSO

SoObliqueSlice, SoOrthoSlice, SoFenceSlice, SoVolumeSkin

Definition at line 62 of file SoSlice.h.

Member Enumeration Documentation

◆ AlphaUse

Alpha component usage mode Used in the alphaUse field.

Enumerator
ALPHA_AS_IS 

Use alpha values as is.

ALPHA_OPAQUE 

Ignore alpha values (slice is opaque)

ALPHA_BINARY 

Use Alpha in binary mode.

Definition at line 109 of file SoSlice.h.

Member Function Documentation

◆ getClassTypeId()

static SoType SoSlice::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoSlice::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoVolumeShape.

Reimplemented in ObliqueSliceBorder, OrthoSliceBorder, SoFenceSlice, SoHeightFieldRender, SoObliqueSlice, SoOrthoSlice, and SoVolumeSkin.

Member Data Documentation

◆ alphaUse

SoSFEnum SoSlice::alphaUse

Specifies how to use the alpha component of each voxel's RGBA value.

Use enum AlphaUse. Default is ALPHA_OPAQUE.

Compatibility Note: The default value changed with the release of Open Inventor version 10. In previous versions the default value was ALPHA_BINARY.

The alpha component will typically come from the transfer function, but (since Open Inventor 8.5) could come from direct rendering of an RGBA volume. The alpha values used for rendering the slice will vary depending on the value of this field.

The following table shows how the alpha value is computed according to this field and the incoming voxel alpha values:

When alphaUse field is: ALPHA_BINARY ALPHA_OPAQUE ALPHA_AS_IS
Incoming Alpha value Alpha Value Actually Used
= 0 0 (Invisible) 1 (Opaque) 0 (Invisible)
> 0 1 (Opaque) 1 (Opaque) same as incoming

Note that this field only affects alpha values coming from the transfer function or an RGBA volume. Global transparency assigned by an SoMaterial node is not affected.

Definition at line 143 of file SoSlice.h.

◆ alternateRep

SoSFNode SoSlice::alternateRep

This field optionally holds a subgraph containing only core Open Inventor nodes that can be used for rendering when VolumeViz is not available.

For example, the alternate representation for an SoOrthoSlice could be a small scene graph containing an SoTexture2 and an SoIndexedFaceSet. Such a scene graph could be converted and exported as a PDF3D file. Default is NULL. But an alternateRep scene graph is automatically created during a write action if SoVolumeRendering::setWriteAlternateRep(TRUE) was called.

NOTE: field available since Open Inventor 4.0

Definition at line 104 of file SoSlice.h.

◆ bumpScale

SoSFFloat SoSlice::bumpScale

Specifies the intensity of the bump mapping effect.

Default value is 1.0. Valid values range from 0 (no bump mapping) to no upper limit. (50 is a fairly large value.)

NOTE: field available since Open Inventor 6.0

Definition at line 91 of file SoSlice.h.

◆ enableBumpMapping

SoSFBool SoSlice::enableBumpMapping

Specifies if a bump mapping effect will be applied to the slice.

Default is FALSE. Bump mapping is a rendering effect that simulates displacement of the slice surface using the gradient vectors (computed on the GPU) as normal vectors. Normally lighting should be enabled to maximize the visual effect of bump mapping.

This mode requires a graphics card supporting the OpenGL GLSL shading language. If your graphics card does not have the necessary support, the slice will be rendered without bump mapping.

Bump mapping is not available for the SoHeightFieldRender node.

NOTE: field available since Open Inventor 6.0

Definition at line 82 of file SoSlice.h.

◆ largeSliceSupport

SoSFBool SoSlice::largeSliceSupport

Activate/deactivate direct loading of full resolution slice data.

Default is FALSE. When TRUE, if all the required full resolution tiles have already been loaded, then the slice data is taken from LDM system memory cache as usual. But if some required tiles are not currently in memory, the required slice data will be loaded directly from the volume reader without loading the complete tiles. This reduces disk I/O and reduces the amount of system memory required to display the slice at full resolution, so larger (or more) slices can be displayed. The required tiles are then scheduled to be loaded asynchronously in case adjacent slices are displayed later. For example, loading a 1024x1024 SoOrthoSlice from an 8-bit dataset with 128x128x128 tiles would normally require loading 1024x1024x128 bytes of data (as complete tiles). With largeSliceSupport enabled, only 1024x1024 bytes (maximum) of data need to be loaded (in the worst case where no high resolution data is currently in memory).

NOTE: field available since Open Inventor 8.0

Limitations :

Definition at line 182 of file SoSlice.h.

◆ useRGBA

SoSFBool SoSlice::useRGBA

Specifies whether to create RGBA textures.

Default is FALSE. If useRGBA is FALSE, indexed textures will be used if the graphics board supports them. If useRGBA is TRUE, RGBA textures will be used instead of indexed textures. RGBA textures allow higher precision but are slower to load and use more texture memory.

NOTE: If the dataSet is RGBA then this field is ignored and RGBA textures are used.

NOTE: field available since Open Inventor 5.0

Definition at line 158 of file SoSlice.h.


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