Base class for detail information about picking in a data volume. More...
#include <VolumeViz/details/SoVolumeDetail.h>
Public Member Functions | |
virtual SoType | getTypeId () const |
SoVolumeDetail () | |
virtual | ~SoVolumeDetail () |
void | getProfileObjectPos (SbVec3f profile[2]) const |
int | getProfileDataPos (SbVec3i32 profile[2]) const |
int64_t | getProfileValue (int index, SbVec3i32 &pos, SbVec3f *objPos=0, SbBool realValue=FALSE) const |
double | getProfileValueD (int index, SbVec3i32 &pos, SbVec3f *objPos, SbBool realValue=FALSE) const |
virtual SbBool | getFirstNonTransparentValue (int64_t &value, SbVec3i32 &pos, SbVec3f *objPos=0, SbBool realValue=FALSE) const |
virtual SbBool | getFirstNonTransparentValue (double &value, SbVec3i32 &pos, SbVec3f *objPos=0, SbBool realValue=FALSE) const |
virtual SoDetail * | copy () const |
Static Public Member Functions | |
static SoType | getClassTypeId () |
Deprecated | |
| |
SoDEPRECATED int | getProfileDataPos (SbVec3s profile[2]=0) const |
SoDEPRECATED int64_t | getProfileValue (int index, SbVec3s *pos=0, SbVec3f *objPos=0, SbBool realValue=FALSE) const |
virtual SoDEPRECATED SbBool | getFirstNonTransparentValue (unsigned int *value, SbVec3s *pos=0, SbVec3f *objPos=0, SbBool flag=FALSE) const |
A successful pick operation returns an SoPickedPoint object. If the picked geometry is an SoVolumeSkin or SoVolumeRender, use the getDetail method and cast the result to the appropriate class (SoVolumeSkinDetail or SoVolumeRenderDetail) to get extra information about the location of the pick.
SoVolumeDetail 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 XYZ position, IJK location, and data value. For the profile defined by all the intersected voxels, it returns:
This class returns information about the data values in the picked voxels. SoVolumeRenderDetail also returns information about the mapped RGBA colors of the picked voxels.
GPU picking vs. CPU picking
Limitations:
SoDetail, SoFenceSliceDetail, SoVolumeRenderDetail, SoVolumeSkinDetail, SoVolumeRender, SoVolumeSkin
SoVolumeDetail::SoVolumeDetail | ( | ) |
Constructor.
virtual SoVolumeDetail::~SoVolumeDetail | ( | ) | [virtual] |
Destructor.
virtual SoDetail* SoVolumeDetail::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.
Implements SoDetail.
Reimplemented in SoFenceSliceDetail, SoVolumeRenderDetail, and SoVolumeSkinDetail.
static SoType SoVolumeDetail::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoDetail.
Reimplemented in SoFenceSliceDetail, SoVolumeRenderDetail, and SoVolumeSkinDetail.
virtual SoDEPRECATED SbBool SoVolumeDetail::getFirstNonTransparentValue | ( | unsigned int * | value, | |
SbVec3s * | pos = 0 , |
|||
SbVec3f * | objPos = 0 , |
|||
SbBool | flag = FALSE | |||
) | const [inline, virtual] |
virtual SbBool SoVolumeDetail::getFirstNonTransparentValue | ( | double & | value, | |
SbVec3i32 & | pos, | |||
SbVec3f * | objPos = 0 , |
|||
SbBool | realValue = FALSE | |||
) | const [virtual] |
Returns the floating point value of the first non-transparent voxel along the pick ray (if any) and its position in object and data space.
Returns FALSE if not found.
If the realValue parameter is TRUE, VolumeViz will return the actual voxel value from the full resolution data. Note that this may require a read from disk if full resolution data is not currently in memory. If FALSE, VolumeViz will return the voxel value from the (possibly subsampled) data currently in memory.
virtual SbBool SoVolumeDetail::getFirstNonTransparentValue | ( | int64_t & | value, | |
SbVec3i32 & | pos, | |||
SbVec3f * | objPos = 0 , |
|||
SbBool | realValue = FALSE | |||
) | const [virtual] |
Returns the integer value of the first non-transparent voxel along the pick ray (if any) and its position in object and data space.
Returns FALSE if not found.
If the realValue parameter is TRUE, VolumeViz will return the actual voxel value from the full resolution data. Note that this may require a read from disk if full resolution data is not currently in memory. If FALSE, VolumeViz will return the voxel value from the (possibly subsampled) data currently in memory.
SoDEPRECATED int SoVolumeDetail::getProfileDataPos | ( | SbVec3s | profile[2] = 0 |
) | const [inline] |
int SoVolumeDetail::getProfileDataPos | ( | SbVec3i32 | profile[2] | ) | const |
Returns the number of values along the profile and the profile position in data space (voxel coordinates).
Specifically the profile parameter contains the IJK coordinates of the first and last points on the profile. The number of values is the number of of voxels intersected by the pick ray.
void SoVolumeDetail::getProfileObjectPos | ( | SbVec3f | profile[2] | ) | const |
Returns the profile position in object space (world coordinates).
Specifically the profile parameter contains the XYZ coordinates of the first and last points on the profile.
SoDEPRECATED int64_t SoVolumeDetail::getProfileValue | ( | int | index, | |
SbVec3s * | pos = 0 , |
|||
SbVec3f * | objPos = 0 , |
|||
SbBool | realValue = FALSE | |||
) | const [inline] |
int64_t SoVolumeDetail::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.
The number of values along the profile can be queried using the getProfileDataPos() method. However index is automatically clamped to the valid range of values.
If realValue is TRUE, VolumeViz will return the actual voxel value from the full resolution data. Note that this may require a read from disk if full resolution data is not currently in memory. If FALSE, VolumeViz will return the voxel value from the (possibly subsampled) data currently in memory.
double SoVolumeDetail::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.
The number of values along the profile can be queried using the getProfileDataPos() method. However index is automatically clamped to the valid range of values.
If realValue is TRUE, VolumeViz will return the actual voxel value from the full resolution data. Note that this may require a read from disk if full resolution data is not currently in memory. If FALSE, VolumeViz will return the voxel value from the (possibly subsampled) data currently in memory.
virtual SoType SoVolumeDetail::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoTypedObject.
Reimplemented in SoFenceSliceDetail, SoVolumeRenderDetail, and SoVolumeSkinDetail.