Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
SoDialogGroup Class Reference

VSG extension Abstract base class for container dialog components. More...

#include <DialogViz/dialog/SoDialogGroup.h>

+ Inheritance diagram for SoDialogGroup:

Public Types

enum  ScrollVisibility {
  NEVER ,
  ALWAYS ,
  AUTO
}
 
- Public Types inherited from SoDialogComponent
enum  EdgeStyle {
  NONE ,
  SHADOW_IN ,
  SHADOW_OUT
}
 
- 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

void addAuditor (SoDialogAuditor *auditor)
 Adds a dialogGroupAuditor to the current column component.
 
void removeAuditor (SoDialogAuditor *auditor)
 Removes the specified DialogGroupAuditor from the auditor list.
 
void applyAuditors ()
 Applies all DialogGroupAuditors in the auditor list.
 
SoDialogVizsearchForAuditorId (SbString id)
 Retrieves the DialogViz object from the specified auditorID field in an SoDialogGroup structure.
 
virtual void addChild (SoDialogComponent *child)
 Adds a child as last one in group.
 
virtual void insertChild (SoDialogComponent *child, int newChildIndex)
 Adds a child so that it becomes the one with the given index.
 
virtual SoNodegetChild (int index) const
 Returns pointer to child node with the given index.
 
virtual int getNumChildren () const
 Returns number of children.
 
virtual int findChild (const SoDialogComponent *child) const
 Finds index of given child within group.
 
virtual void removeChild (int index)
 Removes child with given index from group.
 
virtual void removeChild (SoDialogComponent *child)
 Removes first instance of given child from group.
 
virtual void removeAllChildren ()
 Removes all children from group.
 
virtual void replaceChild (int index, SoDialogComponent *newChild)
 Replaces child with given index with new child.
 
virtual void replaceChild (SoDialogComponent *oldChild, SoDialogComponent *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 SoNodekitCataloggetNodekitCatalog () 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 SbMatrixgetMotionMatrix ()
 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 SoNodegetPart (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 SoNodeKitPathcreatePathToPart (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 &parameterString)
 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 SoNodecopy (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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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

SoSFEnum vScrollVisibility
 Control how vertical scrollbar appears.
 
SoSFEnum hScrollVisibility
 Control how horizontal scrollbar appears.
 
SoSFBool windowResizedByChildren
 Control the window sizing when a child is added or removed.
 
SoSFInt32 margin
 Specifies the margin width.
 
- Public Attributes inherited from SoDialogComponent
SoSFInt32 width
 Preferred width of the element.
 
SoSFInt32 height
 Preferred height of the element.
 
SoSFBool fixedWidth
 When set to FALSE, this allows the component to be resized in the width direction.
 
SoSFBool fixedHeight
 When set to FALSE, this allows the component to be resized in the height direction.
 
SoSFInt32 minWidth
 Sets minimum component width.
 
SoSFInt32 maxWidth
 Sets maximum component width.
 
SoSFInt32 minHeight
 Sets minimum component height.
 
SoSFInt32 maxHeight
 Sets maximum component height.
 
SoSFEnum edgeStyle
 Controls the appearance of the edges of the component.
 
SoSFBool labelVisibility
 Specifies if the label of the component defined in SoDialogViz is visible or not.
 
- 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 SoDialogVizloadFromFile (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 SoNodekitCataloggetClassNodekitCatalog ()
 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 SoNodekitCataloggetClassNodekitCatalog ()
 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 SoNodekitCataloggetClassNodekitCatalog ()
 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 SoNodegetByName (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.
 

Detailed Description

VSG extension Abstract base class for container dialog components.

This class defines the properties of the container dialog components. These containers are SoRowDialog, SoColumnDialog, and SoTabDialog.

SEE ALSO

SoColumnDialog, SoRowDialog, SoTabDialog

Definition at line 46 of file SoDialogGroup.h.

Member Enumeration Documentation

◆ ScrollVisibility

Enumerator
NEVER 

Scroll bar never displayed.

ALWAYS 

Sscroll bar always visible.

AUTO 

Automatic scroll bar : displayed when needed (Default).

Definition at line 52 of file SoDialogGroup.h.

Member Function Documentation

◆ addAuditor()

void SoDialogGroup::addAuditor ( SoDialogAuditor auditor)

Adds a dialogGroupAuditor to the current column component.

◆ addChild()

virtual void SoDialogGroup::addChild ( SoDialogComponent child)
virtual

Adds a child as last one in group.

◆ applyAuditors()

void SoDialogGroup::applyAuditors ( )

Applies all DialogGroupAuditors in the auditor list.

◆ findChild()

virtual int SoDialogGroup::findChild ( const SoDialogComponent child) const
virtual

Finds index of given child within group.

Returns -1 if not found.

◆ getChild()

virtual SoNode * SoDialogGroup::getChild ( int  index) const
virtual

Returns pointer to child node with the given index.

◆ getNumChildren()

virtual int SoDialogGroup::getNumChildren ( ) const
virtual

Returns number of children.

◆ insertChild()

virtual void SoDialogGroup::insertChild ( SoDialogComponent child,
int  newChildIndex 
)
virtual

Adds a child so that it becomes the one with the given index.

◆ removeAllChildren()

virtual void SoDialogGroup::removeAllChildren ( )
virtual

Removes all children from group.

◆ removeAuditor()

void SoDialogGroup::removeAuditor ( SoDialogAuditor auditor)

Removes the specified DialogGroupAuditor from the auditor list.

◆ removeChild() [1/2]

virtual void SoDialogGroup::removeChild ( int  index)
virtual

Removes child with given index from group.

◆ removeChild() [2/2]

virtual void SoDialogGroup::removeChild ( SoDialogComponent child)
virtual

Removes first instance of given child from group.

◆ replaceChild() [1/2]

virtual void SoDialogGroup::replaceChild ( int  index,
SoDialogComponent newChild 
)
virtual

Replaces child with given index with new child.

◆ replaceChild() [2/2]

virtual void SoDialogGroup::replaceChild ( SoDialogComponent oldChild,
SoDialogComponent newChild 
)
virtual

Replaces first instance of given child with new child.

◆ searchForAuditorId()

SoDialogViz * SoDialogGroup::searchForAuditorId ( SbString  id)

Retrieves the DialogViz object from the specified auditorID field in an SoDialogGroup structure.

NULL is returned if auditorID string is not found.

Member Data Documentation

◆ hScrollVisibility

SoSFEnum SoDialogGroup::hScrollVisibility

Control how horizontal scrollbar appears.

Default value is AUTO.

Definition at line 69 of file SoDialogGroup.h.

◆ margin

SoSFInt32 SoDialogGroup::margin

Specifies the margin width.

Default is zero.

Definition at line 79 of file SoDialogGroup.h.

◆ vScrollVisibility

SoSFEnum SoDialogGroup::vScrollVisibility

Control how vertical scrollbar appears.

Default value is AUTO.

Definition at line 64 of file SoDialogGroup.h.

◆ windowResizedByChildren

SoSFBool SoDialogGroup::windowResizedByChildren

Control the window sizing when a child is added or removed.

If FALSE, the window is not resized; scrollbars appear if needed. Default is TRUE.

Definition at line 74 of file SoDialogGroup.h.


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