Fence slice shape node. More...
#include <VolumeViz/nodes/SoFenceSlice.h>
Public Types | |
enum | Axis { X , Y , Z } |
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 Member Functions | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
SoFenceSlice () | |
Constructor. | |
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 SoNode * | copy (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 SoField * | getField (const SbName &fieldName) const |
Returns a the field of this object whose name is fieldName. | |
virtual SoField * | getEventIn (const SbName &fieldName) const |
Returns a the eventIn with the given name. | |
virtual SoField * | getEventOut (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 SbBool | isSupported (SoState *state=NULL) |
Returns true if graphic card can render an SoFenceSlice. | |
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 SoNode * | getByName (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 | |
SoSFInt32 | dataSetId |
Specifies the SoVolumeData node to use. | |
SoMFVec2f | points |
Set of points defining a lineset. | |
SoSFEnum | axis |
Extrusion axis: X, Y, or Z. | |
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. | |
This node renders a strip (connected series) of slices. The strip is defined by a set of 2D vertices that form a polyline. Each segment of the polyline is extruded along the axis specified in the axis field to form (in effect) an oblique slice. The default axis is Z, so the 2D points are treated as (X,Y) values. The points may be outside the 3D extent of the volume, but only the portion of the slice inside the volume will be drawn (subject to region of interest and other clipping nodes).
The SoVolumeData node on which this shape is applied can be specified with dataSetId. When this field is set to 0, the last SoVolumeData node on state is used.
A similar effect could be obtained using volume geometry (e.g. SoVolumeFaceSet), but SoFenceSlice is more convenient and is optimized for this specific case.
The 2D coordinates are interpreted according to the following table. See the code example below.
Fence axis | Coordinate axes |
X | Y , Z |
Y | Z , X |
Z | X , Y |
For a non-RGBA (scalar valued) volume, each voxel's RGBA value is determined by the current SoDataRange and SoTransferFunction. The current diffuse color and transparency (set, for example, with an SoMaterial node) modify the appearance of the slice. This means that, for example, the current transparency can be used as a global alpha value to modulate the overall opacity of the slice. For an RGBA volume each voxel's RGBA value comes directly from the volume data.
The interpolation field controls how the texture is interpolated.
The alphaUse field (SoSlice) controls how the voxel's alpha component is used when drawing the fence slice.
Optionally a bump mapping effect may be applied. Normal vectors are automatically computed from the data value gradient. The enableBumpMapping and bumpScale fields (SoSlice) control whether bump mapping is active and the intensity of the effect.
Notes:
Fence slice on Y axis (Colt example data set): |
|
Fence slice on X axis (Colt example data set): |
|
Fence slice on Z axis (Colt example data set): |
|
dataSetId | 0 |
points | [ ] |
axis | Z |
interpolation | LINEAR |
alphaUse | ALPHA_BINARY |
useRGBA | FALSE |
alternateRep | NULL |
enableBumpMapping | FALSE |
bumpScale | 1.0 |
SoGetBoundingBoxAction
Computes the bounding box that encloses the fence slice.
SoVolumeData, SoDataRange, SoTransferFunction, SoROI, SoSlice SoObliqueSlice, SoOrthoSlice, SoFenceSliceDetail
Definition at line 272 of file SoFenceSlice.h.
enum SoFenceSlice::Axis |
Enumerator | |
---|---|
X | |
Y | |
Z | (Default) |
Definition at line 306 of file SoFenceSlice.h.
SoFenceSlice::SoFenceSlice | ( | ) |
Constructor.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoSlice.
Returns true if graphic card can render an SoFenceSlice.
GPU must support GLSL. When using a debug build of Open Inventor, some "no context available" warning messages may be generated. You can ignore them or see SoGLExtension for an example of using SoGLContext to avoid them.
SoSFEnum SoFenceSlice::axis |
Extrusion axis: X, Y, or Z.
Use enum Axis. Default is Z.
Definition at line 317 of file SoFenceSlice.h.
SoSFInt32 SoFenceSlice::dataSetId |
Specifies the SoVolumeData node to use.
This is useful when datasets of different dimensions are present in the scene graph. Please see SoMultiDataSeparator for more details.
When set to 0, the last SoVolumeData node on state is used. Default is 0.
NOTE: field available since Open Inventor 10.11.0
Definition at line 293 of file SoFenceSlice.h.
SoMFVec2f SoFenceSlice::points |
Set of points defining a lineset.
If axis is:
All points should be inside the 3D extent of the volume.
Definition at line 304 of file SoFenceSlice.h.