Top Level Dialog node. More...
#include <DialogViz/dialog/SoTopLevelDialog.h>
Public Types | |
enum | ScrollVisibility { NEVER , ALWAYS , AUTO } |
Public Types inherited from SoDialogViz | |
enum | LabelAlignment { LEFT , CENTER , RIGHT } |
Public Types inherited from SoDragger | |
enum | TrackerDirectMode { NONE , MOVE , ROTATE , FREE , DEFAULT } |
Tracker direct mode. More... | |
Public Types inherited from SoInteractionKit | |
enum | CacheEnabled { OFF , ON , AUTO } |
Possible values for caching. More... | |
Public Member Functions | |
SoTopLevelDialog () | |
Constructor. | |
void | buildDialog (SoWidget parent, SbBool buildInsideParent=FALSE) |
Builds the dialog window. | |
void | close () |
Destroys the dialog window. | |
virtual void | show () |
Shows the tolLevelDialog widget. | |
virtual void | hide () |
Hides the topLevelDialog widget. | |
void | addAuditor (SoDialogAuditor *auditor) |
Adds a dialogAuditor to the current topLevelDialog component. | |
void | removeAuditor (SoDialogAuditor *auditor) |
Removes the defined DialogAuditor from the auditor list. | |
void | applyAuditors () |
Applies all DialogAuditors in the auditor list. | |
SoDialogViz * | searchForAuditorId (SbString id) |
Retrieves the DialogViz object from the specified auditorID field in an SoTopLevelDialog structure. | |
virtual void | addChild (SoTopComponent *child) |
Adds a child as last one in group. | |
virtual void | insertChild (SoTopComponent *child, int newChildIndex) |
Adds a child so that it becomes the one with the given index. | |
virtual SoNode * | getChild (int index) const |
Returns pointer to child node with the given index. | |
virtual int | getNumChildren () const |
Returns number of children. | |
virtual int | findChild (const SoTopComponent *child) const |
Finds index of given child within group. | |
virtual void | removeChild (int index) |
Removes child with given index from group. | |
virtual void | removeChild (SoTopComponent *child) |
Removes first instance of given child from group. | |
virtual void | removeAllChildren () |
Removes all children from group. | |
virtual void | replaceChild (int index, SoTopComponent *newChild) |
Replaces child with given index with new child. | |
virtual void | replaceChild (SoTopComponent *oldChild, SoTopComponent *newChild) |
Replaces first instance of given child with new child. | |
Public Member Functions inherited from SoDragger | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
virtual const SoNodekitCatalog * | getNodekitCatalog () const |
Returns the SoNodekitCatalog for this instance. | |
void | addStartCallback (SoDraggerCB *f, void *userData=NULL) |
Adds start callback. | |
void | removeStartCallback (SoDraggerCB *f, void *userData=NULL) |
Removes start callback. | |
void | addMotionCallback (SoDraggerCB *f, void *userData=NULL) |
Adds motion callback. | |
void | removeMotionCallback (SoDraggerCB *f, void *userData=NULL) |
Removes motion callback. | |
void | addFinishCallback (SoDraggerCB *f, void *userData=NULL) |
Adds finish callback. | |
void | removeFinishCallback (SoDraggerCB *f, void *userData=NULL) |
Removes finish callback. | |
void | addValueChangedCallback (SoDraggerCB *f, void *userData=NULL) |
Adds value-changed callback. | |
void | removeValueChangedCallback (SoDraggerCB *f, void *userData=NULL) |
Removes value-changed callback. | |
void | setMinGesture (int pixels) |
Sets the number of pixels of movement required to initiate a constraint gesture. | |
void | setMinGesture (float pixels) |
Float version of setMinGesture. | |
int | getMinGesture () const |
Gets the number of pixels of movement required to initiate a constraint gesture. | |
float | getMinGestureFloat () const |
Float version of getMinGesture. | |
SbBool | enableValueChangedCallbacks (SbBool newVal) |
You can temporarily disable a dragger's valueChangedCallbacks. | |
void | setTrackerDirectMode (TrackerDirectMode mode=DEFAULT) |
Sets the tracker direct mode for this dragger (see description above). | |
TrackerDirectMode | getTrackerDirectMode () const |
Get the current tracker direct mode for this dragger. | |
void | setMotionMatrix (const SbMatrix &newMatrix) |
Set the motion matrix. | |
const SbMatrix & | getMotionMatrix () |
Get the motion matrix. | |
Public Member Functions inherited from SoInteractionKit | |
virtual SbBool | setPartAsPath (const SbName &partName, SoPath *surrogatePath) |
Sets any public part in the interaction kit as a "surrogate" path instead. | |
virtual SbBool | affectsState () const |
Returns TRUE if a node has an effect on the state during traversal. | |
Public Member Functions inherited from SoBaseKit | |
SoBaseKit () | |
Constructor. | |
virtual SoNode * | getPart (const SbName &partName, SbBool makeIfNeeded) |
Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. | |
template<typename PartType > | |
PartType * | getPart (const SbName &partName) |
Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE. | |
template<typename PartType > | |
PartType * | checkPart (const SbName &partName) |
Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE. | |
SbString | getPartString (const SoBase *part) |
Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part. | |
virtual SoNodeKitPath * | createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL) |
Returns a path that begins at this nodekit and ends at partName. | |
virtual SbBool | setPart (const SbName &partName, SoNode *newPart) |
Inserts the given node (not a copy) as the new part specified by partName. | |
SoNONUNICODE SbBool | set (char *nameValuePairListString) |
This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
SbBool | set (const SbString &nameValuePairListString) |
This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
SoNONUNICODE SbBool | set (const char *partNameString, const char *parameterString) |
This function allows field values of parts (nodes) to be set. | |
SbBool | set (const SbString &partNameString, const SbString ¶meterString) |
This function allows field values of parts (nodes) to be set. | |
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. | |
Public Member Functions inherited from SoGetView | |
SoGetView () | |
Default constructor. | |
virtual | ~SoGetView () |
virtual SbBool | getViewportIsEnabled () const |
Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise. | |
virtual const SbVec2f | getViewportOrigin () const |
Returns SbViewportRegion origin. | |
virtual const SbVec2f | getViewportSize () const |
Returns SbViewportRegion size. | |
Public Attributes | |
SoSFInt32 | width |
Preferred width of the top component. | |
SoSFInt32 | height |
Preferred height of the top component. | |
SoSFVec2i32 | position |
Window screen coordinates. | |
SoSFVec3f | position3D |
Window world coordinate position when rendering in 3D. | |
SoSFVec3f | minimized3DPosition |
Window world coordinate position when rendering in 3D and minimized. | |
SoSFBool | resizable |
Indicates if the top component can be resized or not, Default is TRUE. | |
SoSFBool | minimized |
Controls and indicates whether the dialog is minimized or not. | |
SoSFBool | independentMinimizedPosition |
Indicates whether minimized and full size dialog have independant 3D position or not. | |
SoSFInt32 | minWidth |
Minimum top component width. | |
SoSFInt32 | maxWidth |
Maximum top component width. | |
SoSFInt32 | minHeight |
Minimum top component height. | |
SoSFInt32 | maxHeight |
Maximum top component height. | |
SoSFInt32 | margin |
Margin width. | |
SoSFInt32 | rowSpacing |
Space between each child. | |
SoSFEnum | vScrollVisibility |
Controls how vertical scrollbar appears. | |
SoSFEnum | hScrollVisibility |
Controls how horizontal scrollbar appears. | |
SoSFBool | windowResizedByChildren |
Controls the window sizing when a child is added or removed. | |
SoSFBool | modalFrame |
Sets window property. | |
SoSFBool | hideChildren |
When rendering DialogViz as a scene, children can be hidden while the SoTopLevelDialog frame is moving by setting this field to TRUE. | |
Public Attributes inherited from SoDialogViz | |
SoSFBool | enable |
Enables component. | |
SoSFString | label |
Label string of the element. | |
SoSFEnum | labelAlignment |
Specifies the label alignment. | |
SoSFString | auditorID |
Specifies the auditor ID of the node. | |
Public Attributes inherited from SoDragger | |
SoSFBool | isActive |
TRUE when mouse is down and dragging, else FALSE. | |
SoSFBool | enableCallbacks |
If set to FALSE, motion, start and finish callbacks are disabled. | |
Public Attributes inherited from SoInteractionKit | |
SoSFEnum | boundingBoxCaching |
Set bounding box caching mode. | |
SoSFEnum | renderCulling |
Set render culling mode. | |
SoSFEnum | pickCulling |
Set pick caching mode. | |
SoDEPRECATED SoSFEnum | renderCaching |
Set render caching mode. | |
Public Attributes inherited from SoBaseKit | |
SoSFBool | boundingBoxIgnoring |
Whether to ignore this node during bounding box traversal. | |
Additional Inherited Members | |
Static Public Member Functions inherited from SoDialogViz | |
static void | init () |
Initalizes the DialogViz classes. | |
static void | finish () |
Shuts down the DialogViz module, which includes freeing any internal static memory that it allocated. | |
static bool | isInitialized () |
Returns TRUE if module is currently initialized. | |
static const char * | getProductName () |
Returns a character string identifying the name of the extension. | |
static SoDialogViz * | loadFromFile (SbString filename, SbString auditorID="") |
Loads a DialogViz node from an Inventor file. | |
static void | setSkin (SbString skinName) |
Sets the directory for 3D DialogViz component skins. | |
static void | setSkinsDirectories (SbString directories) |
Sets a list of directories where to search for skins. | |
static SbString | getSkinsDirectories () |
Returns the skins directory. | |
static void | setFont (DG_FONT font) |
Sets the DialogViz font. | |
static SoDEPRECATED const char * | getVersion () |
Returns a character string identifying the version of the extension. | |
Static Public Member Functions inherited from SoDragger | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static const SoNodekitCatalog * | getClassNodekitCatalog () |
Returns the SoNodekitCatalog for this class. | |
static void | setMinScale (float newMinScale) |
Sets the smallest scale that any dragger will write. | |
static float | getMinScale () |
Gets the smallest scale that any dragger will write. | |
static void | setInitialTrackerDirectMode (TrackerDirectMode mode=DEFAULT) |
Set the initial tracker direct mode for draggers not yet created. | |
static TrackerDirectMode | getInitialTrackerDirectMode () |
Get the initial tracker direct mode. | |
Static Public Member Functions inherited from SoInteractionKit | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static const SoNodekitCatalog * | getClassNodekitCatalog () |
Returns the SoNodekitCatalog for this class. | |
Static Public Member Functions inherited from SoBaseKit | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static const SoNodekitCatalog * | getClassNodekitCatalog () |
Returns the SoNodekitCatalog for the class SoBaseKit. | |
static void | setSearchingChildren (SbBool newVal) |
Sets if nodekit children are searched during SoSearchAction traversal. | |
static SbBool | isSearchingChildren () |
Returns TRUE if nodekit children are searched during SoSearchAction traversal. | |
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. | |
The SoTopLevelDialog class manages a list of SoTopComponent children. Typically, a top level component is composed of at most one SoMenuBar and a set of SoDialogComponents. You can add, insert, and remove top components (SoTopComponent) by using the addChild(), insertChild(), and removeChild() methods.
The SoTopLevelDialog components has numerous sizing constraints. In fact, the user can define the width and height of the dialog window, and can also add size limits to it using the fields minWidth, minHeight, maxWidth, and maxHeight. The limits will be considered when the resizable field is set to TRUE. Otherwise, the size of the window is static and the minimize and maximize title bar buttons are removed on Windows systems.
Note: While 2D rendering, when triggering the window close button, the window is only hidden. If this dialog is the main window of an application (i.e., buildInsideParent parameter has been defined as TRUE), the dialog window is destroyed and the application is ended. Otherwise, the dialog window is not destroyed until closeDialog() is called.
You can change the parts in any instance of this top level component using setPart(). The default part geometries are defined as resources for this SoTopLevelDialog class. They are detailed below in the Catalog Parts section of the online reference page for this class. You can make your program use different default resources for the parts by copying the file $OIVHOME/data/DialogViz/Skins/default/TopLevelDialog.iv into your own directory, editing the file, and then setting the environment variable DIALOGVIZ_SKINS_DIR to be a path to that directory, or by using the setSkinDirectory() method in your application.
width | 0 |
height | 0 |
position | 0 0 |
position3D | 0 0 0 |
resizable | TRUE |
minWidth | 0 |
maxWidth | 0 |
minHeight | 0 |
maxHeight | 0 |
margin | 0 |
rowSpacing | 0 |
verticalScrollBar | TRUE |
horizontalScrollBar | TRUE |
scrollPolicy | AUTO |
windowResizedByChildren | FALSE |
modalFrame | FALSE |
hideChildren | FALSE |
// fields from SoDialogViz | |
enable | TRUE |
label | "" |
labelAlignment | RIGHT |
auditorID | "" |
SoTopLevelDialog {
Group frame
Define the geometry of the main frame of the SoTopLevelDialog component. When TopLevelDialog is minimized, default size is set to (x, 20, z).
Group labelProp
Specifies properties to apply to the text node that represents the label field.
Switch minSwtch {
Defines the geometry of the minimize button.
Group minReleased
Defines the released geometry.
Group minPressed
Defines the pressed geometry.
}
}
Extra information for parts from above structure
Part Name Resource Skin file frame TopLevelDialogFrame TopLevelDialog.iv labelProp DialogTextProperties TextProperties.iv minReleased TopLevelDialogMinReleased TopLevelDialog.iv minSelected TopLevelDialogMinPressed TopLevelDialog.iv
SoTopComponent, SoMenuBar, SoDialogComponent
Definition at line 110 of file SoTopLevelDialog.h.
Enumerator | |
---|---|
NEVER | Scroll bar never displayed. |
ALWAYS | Scroll bar always visible. |
AUTO | Automatic scroll bar: displayed when needed (default). |
Definition at line 197 of file SoTopLevelDialog.h.
SoTopLevelDialog::SoTopLevelDialog | ( | ) |
Constructor.
void SoTopLevelDialog::addAuditor | ( | SoDialogAuditor * | auditor | ) |
Adds a dialogAuditor to the current topLevelDialog component.
|
virtual |
Adds a child as last one in group.
void SoTopLevelDialog::applyAuditors | ( | ) |
Applies all DialogAuditors in the auditor list.
Builds the dialog window.
If buildInsideParent is set to FALSE, a window is created; its title is the field label of SoDialogViz. If buildInsideParent is set to TRUE, the dialog is created inside the parent window.
void SoTopLevelDialog::close | ( | ) |
Destroys the dialog window.
|
virtual |
Finds index of given child within group.
Returns -1 if not found.
|
virtual |
Returns pointer to child node with the given index.
|
virtual |
Returns number of children.
|
virtual |
Hides the topLevelDialog widget.
|
virtual |
Adds a child so that it becomes the one with the given index.
|
virtual |
Removes all children from group.
void SoTopLevelDialog::removeAuditor | ( | SoDialogAuditor * | auditor | ) |
Removes the defined DialogAuditor from the auditor list.
|
virtual |
Removes child with given index from group.
|
virtual |
Removes first instance of given child from group.
|
virtual |
Replaces child with given index with new child.
|
virtual |
Replaces first instance of given child with new child.
SoDialogViz * SoTopLevelDialog::searchForAuditorId | ( | SbString | id | ) |
Retrieves the DialogViz object from the specified auditorID field in an SoTopLevelDialog structure.
NULL is returned if auditorID string is not found.
|
virtual |
Shows the tolLevelDialog widget.
SoSFInt32 SoTopLevelDialog::height |
Preferred height of the top component.
Default is zero. The default value zero indicates that the height of the top component will be computed automatically according to its content.
Definition at line 128 of file SoTopLevelDialog.h.
SoSFBool SoTopLevelDialog::hideChildren |
When rendering DialogViz as a scene, children can be hidden while the SoTopLevelDialog frame is moving by setting this field to TRUE.
(Default is FALSE). Hiding children during moves is recommended in order to preserve the frame rate while moving. This is all the more useful when the 3D DialogViz window is complex. Note: This field is not used in 2D mode.
Definition at line 235 of file SoTopLevelDialog.h.
SoSFEnum SoTopLevelDialog::hScrollVisibility |
Controls how horizontal scrollbar appears.
Default value is AUTO.
Definition at line 214 of file SoTopLevelDialog.h.
SoSFBool SoTopLevelDialog::independentMinimizedPosition |
Indicates whether minimized and full size dialog have independant 3D position or not.
Default is TRUE. NOTE: field available since Open Inventor 8.1
Definition at line 161 of file SoTopLevelDialog.h.
SoSFInt32 SoTopLevelDialog::margin |
SoSFInt32 SoTopLevelDialog::maxHeight |
Maximum top component height.
Default is zero. The default value zero indicates no minimum value is specified.
Definition at line 185 of file SoTopLevelDialog.h.
SoSFInt32 SoTopLevelDialog::maxWidth |
Maximum top component width.
Default is zero. The default value zero indicates no minimum value is specified.
Definition at line 173 of file SoTopLevelDialog.h.
SoSFInt32 SoTopLevelDialog::minHeight |
Minimum top component height.
Default is zero. The default value zero indicates no minimum value is specified.
Definition at line 179 of file SoTopLevelDialog.h.
SoSFBool SoTopLevelDialog::minimized |
Controls and indicates whether the dialog is minimized or not.
Default is FALSE. NOTE: field available since Open Inventor 8.1
Definition at line 155 of file SoTopLevelDialog.h.
SoSFVec3f SoTopLevelDialog::minimized3DPosition |
Window world coordinate position when rendering in 3D and minimized.
Definition at line 144 of file SoTopLevelDialog.h.
SoSFInt32 SoTopLevelDialog::minWidth |
Minimum top component width.
Default is zero. The default value zero indicates no minimum value is specified.
Definition at line 167 of file SoTopLevelDialog.h.
SoSFBool SoTopLevelDialog::modalFrame |
Sets window property.
If TRUE, the window will have a border and title bar but will not be resizeable. Default is FALSE.
Definition at line 226 of file SoTopLevelDialog.h.
SoSFVec2i32 SoTopLevelDialog::position |
Window screen coordinates.
Default position is (0,0).
Definition at line 134 of file SoTopLevelDialog.h.
SoSFVec3f SoTopLevelDialog::position3D |
Window world coordinate position when rendering in 3D.
Default is (0,0,0).
Definition at line 139 of file SoTopLevelDialog.h.
SoSFBool SoTopLevelDialog::resizable |
Indicates if the top component can be resized or not, Default is TRUE.
Definition at line 149 of file SoTopLevelDialog.h.
SoSFInt32 SoTopLevelDialog::rowSpacing |
SoSFEnum SoTopLevelDialog::vScrollVisibility |
Controls how vertical scrollbar appears.
Default value is AUTO.
Definition at line 209 of file SoTopLevelDialog.h.
SoSFInt32 SoTopLevelDialog::width |
Preferred width of the top component.
Default is zero. The default value zero indicates that the width of the top component will be computed automatically according to its content.
Definition at line 121 of file SoTopLevelDialog.h.
SoSFBool SoTopLevelDialog::windowResizedByChildren |
Controls the window sizing when a child is added or removed.
If FALSE, the window is not resized; scrollbars appear if needed. Default is FALSE.
Definition at line 220 of file SoTopLevelDialog.h.