SoFenceSliceDetail Class Reference

Stores detail information about a picked voxel or pick ray in a data volume. More...

#include <VolumeViz/details/SoFenceSliceDetail.h>

Inheritance diagram for SoFenceSliceDetail:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoFenceSliceDetail ()
	Constructor.
virtual	~SoFenceSliceDetail ()
	Destructor.
virtual SoDetail *	copy () const
	Returns an instance that is a copy of this instance.
Public Member Functions inherited from SoVolumeDetail
	SoVolumeDetail ()
	Constructor.
virtual	~SoVolumeDetail ()
	Destructor.
void	getProfileObjectPos (SbVec3f profile[2]) const
	Returns the profile position in object space (world coordinates).
int	getProfileDataPos (SbVec3i32 profile[2]) const
	Returns the number of values along the profile and the profile position in data space (voxel coordinates).
int64_t	getProfileValue (int index, SbVec3i32 &pos, SbVec3f *objPos=0, SbBool realValue=FALSE) const
	Returns the index'th value (as an integer) and its position in object and data space.
double	getProfileValueD (int index, SbVec3i32 &pos, SbVec3f *objPos, SbBool realValue=FALSE) const
	Returns the index'th value (as a double) and its position in object and data space.
virtual SbBool	getFirstNonTransparentValue (int64_t &value, SbVec3i32 &pos, SbVec3f *objPos=0, SbBool realValue=FALSE) const
	Retrieves the value and position of the first non-transparent voxel along the pick ray (if any).
virtual SbBool	getFirstNonTransparentValue (double &value, SbVec3i32 &pos, SbVec3f *objPos=0, SbBool realValue=FALSE) const
	Retrieves the value and position of the first non-transparent voxel along the pick ray (if any).
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 SoVolumeDetail
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoDetail
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.

Detailed Description

Stores detail information about a picked voxel or pick ray in a data volume.

A successful pick operation returns an SoPickedPoint object. If the picked geometry is an SoFenceSlice node, use the getDetail method and cast the result to this class to get extra information about the pick.

SoFenceSliceDetail returns information about the first (closest) non-transparent voxel along the pick ray and/or information about all the voxels intersected by the pick ray (called a profile).

For the first non-transparent voxel (if any) on the pick ray, it returns the XYZ position in 3D space, IJK location in voxels and the data value. See method getFirstNonTransparentValue().

For the profile defined by all the intersected voxels, it returns:

• Profile position in object space (two XYZ points).
  See method getProfileObjectPos().
• Profile location in the data volume (two IJK indices).
  See method getProfileDataPos().
• Number of values along the profile.
  See method getProfileDataPos().
• For each value along the profile: the voxel value and its corresponding IJK location.
  See method getProfileValue().

Notes:

• To get information about all voxels intersected by the ray, the application must set the pickAll flag of the SoRayPickAction to TRUE. (This is different than the behavior of SoVolumeRenderDetail.

Limitations:

• If multiple volumes are being combined under an SoMultiDataSeparator, the detail class only returns values for the first volume in the scene graph.

SEE ALSO

SoDetail, SoVolumeDetail, SoFenceSlice

Definition at line 88 of file SoFenceSliceDetail.h.

Constructor & Destructor Documentation

SoFenceSliceDetail()

SoFenceSliceDetail::SoFenceSliceDetail

(

)

Constructor.

~SoFenceSliceDetail()

virtual SoFenceSliceDetail::~SoFenceSliceDetail ( )

virtual

Destructor.

Member Function Documentation

copy()

virtual SoDetail * SoFenceSliceDetail::copy ( ) const

virtual

Returns an instance that is a copy of this instance.

The caller is responsible for deleting the copy when it is no longer needed.

Reimplemented from SoVolumeDetail.

getClassTypeId()

static SoType SoFenceSliceDetail::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoFenceSliceDetail::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoVolumeDetail.

---

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

• VolumeViz/details/SoFenceSliceDetail.h