Manipulator to transform an ROI (Region of Interest). More...
#include <LDM/manips/SoROIManip.h>
Public Member Functions | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
SoROIManip () | |
Constructor. | |
SoDragger * | getDragger () |
Returns the dragger node being employed by this manip. | |
SbBool | replaceNode (SoPath *p) |
Replaces the tail of the path with this manipulator. | |
SbBool | replaceManip (SoPath *p, SoROI *newOne) const |
Replaces the tail of the path, which must be this manipulator, with the given SoROI node. | |
Public Member Functions inherited from SoROI | |
SoROI () | |
Constructor. | |
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 SbBool | affectsState () const |
Returns TRUE if a node has an effect on the state during traversal. | |
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 Public Member Functions inherited from SoROI | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
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 | |
SoSFBool | boxOn |
Chooses between the 'box' (TRUE) or the 'subVolume' (FALSE) field in the SoROI. | |
SoSFBool | constrained |
Constrains the dragger to fit in the data volume. | |
Public Attributes inherited from SoROI | |
SoSFInt32 | dataSetId |
Specifies which SoVolumeData node to use. | |
SoSFBox3i32 | box |
Specifies the bounds of the region of interest. | |
SoSFBitMask | flags |
Specifies how the bounds of the box are used. | |
SoSFBox3i32 | subVolume |
Specifies the bounds of the subvolume that will be rendered. | |
SoSFBool | relative |
Specifies whether the box bounds are relative to the subvolume or the full volume (i.e., are specified in absolute slice coordinates). | |
Additional Inherited Members | |
Public Types inherited from SoROI | |
enum | Flags { ENABLE_X0 = 0x1 , ENABLE_Y0 = 0x2 , ENABLE_Z0 = 0x4 , INVERT_0 = 0x8 , ENABLE_X1 = 0x10 , ENABLE_Y1 = 0x20 , ENABLE_Z1 = 0x40 , INVERT_1 = 0x80 , ENABLE_X2 = 0x100 , ENABLE_Y2 = 0x200 , ENABLE_Z2 = 0x400 , INVERT_2 = 0x800 , OR_SELECT = 0x1000 , INVERT_OUTPUT = 0x2000 , SUB_VOLUME = ENABLE_X0 | ENABLE_Y0 | ENABLE_Z0 , EXCLUSION_BOX = SUB_VOLUME | INVERT_OUTPUT , CROSS = ENABLE_X0 | ENABLE_Y0 | ENABLE_Y1 | ENABLE_Z1 | ENABLE_X2 | ENABLE_Z2 | OR_SELECT , CROSS_INVERT = CROSS | INVERT_OUTPUT , FENCE = ENABLE_X0 | ENABLE_Y1 | ENABLE_Z2 | OR_SELECT , FENCE_INVERT = FENCE | INVERT_OUTPUT } |
Flag value mask. More... | |
Manipulator to transform an ROI (Region of Interest).
This class defines a manipulator to transform an ROI (Region of Interest). The manipulator is a composite of SoROI and an SoTabBoxDragger that allows the user to interactively move and resize the ROI.
To define a simple ROI, set the limits of the ROI in the SoROI::box field (and do not set the SoROI::subVolume field). The same result is obtained by setting the 'box' and 'subVolume' fields to the same value, but this is not necessary. But note that, like SoROI, the default ROI box is not automatically the full volume. You must initialize the ROI box to something, for example the volume dimensions minus one. See SoROI for more details.
Note: The edge color of the embedded dragger is modified, i.e. is not the same as the default edge color in SoTabBoxDragger.
subVolume | 0 0 0 0 0 0 |
box | 0 0 0 1 1 1 |
flags | 7 |
relative | FALSE |
boxOn | TRUE |
constrained | FALSE |
Definition at line 108 of file SoROIManip.h.
SoROIManip::SoROIManip | ( | ) |
Constructor.
|
static |
Returns the type identifier for this class.
SoDragger * SoROIManip::getDragger | ( | ) |
Returns the dragger node being employed by this manip.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoROI.
Replaces the tail of the path, which must be this manipulator, with the given SoROI node.
If the path has a nodekit, this will try to use setPart() to insert the new node. Otherwise, the manipulator requires that the next-to-last node in the path chain be a group.
The field values from the manipulator will be copied to the ROI node, and the manipulator will be replaced.
The manipulator will not call ref() or unref() on the node which is replacing it, nor will it make any changes to field connections. The calling process is thus responsible for keeping track of its own nodes and field connections.
Replaces the tail of the path with this manipulator.
The tail of the path must be an SoROI node (or subclass thereof). If the path has a nodekit, this will try to use setPart() to insert the manipulator. Otherwise, the manipulator requires that the next-to-last node in the path chain be a group.
The field values from the ROI node will be copied to this manipulator, and the ROI node will be replaced.
The manipulator will not call ref() on the node it is replacing. The old node will disappear if it has no references other than from the input path p and its parent, since this manipulator will be replacing it in both of those places. Nor will the manipulator make any changes to field connections of the old node. The calling process is thus responsible for keeping track of its own nodes and field connections.
SoSFBool SoROIManip::boxOn |
Chooses between the 'box' (TRUE) or the 'subVolume' (FALSE) field in the SoROI.
Default value is TRUE.
Definition at line 123 of file SoROIManip.h.
SoSFBool SoROIManip::constrained |
Constrains the dragger to fit in the data volume.
Default value is FALSE.
Definition at line 128 of file SoROIManip.h.