Open Inventor Release 2024.1.2
 
Loading...
Searching...
No Matches
SoInteractiveComplexity Class Reference

Field interactive complexity node. More...

#include <Inventor/nodes/SoInteractiveComplexity.h>

+ Inheritance diagram for SoInteractiveComplexity:

Public Types

enum  InteractiveMode {
  AUTO ,
  FORCE_INTERACTION ,
  FORCE_STILL ,
  DISABLED
}
 Interactive mode. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoInteractiveComplexity ()
 
- 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 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 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.
 

Static Public Member Functions

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 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.
 

Public Attributes

SoMFString fieldSettings
 Each string in this field specifies the interactionValue and stillValue for a specific field of a specific node class.
 
SoSFFloat refinementDelay
 Time in seconds after interaction stops before field values start to be increased.
 
SoSFEnum interactiveMode
 Interactive mode.
 

Detailed Description

Field interactive complexity node.

This node allows the application to define different parameter values for certain fields of specific node classes, depending on whether a user interaction, for example moving the camera, is occurring. This means that while the camera is moving these fields will use a specified "interaction" parameter value, but when interactive manipulation is stopped these fields will automatically change to a specified "still" parameter value. Optionally, for scalar fields, the transition from interaction value to still value can be automatically animated using a specified increment.

Note: The values specified in SoInteractiveComplexity override the values in the fields of the specified nodes during rendering. But calling getValue() on the fields still returns the value set directly into the field (or the default value if none was set).

This is a powerful technique for maintaining an interactive framerate when interacting with GPU intensive datasets or rendering effects, while still getting a final image with very high quality and giving the user a "progressive refinement" effect while transitioning from interaction back to "still".

These settings are applied to all instances of the node class containing the specified field and are declared with a specially formatted string set in the fieldSettings field. For scalar fields like SoSFInt, the string looks like this:
"ClassName FieldName InteractionValue StillValue [IncrementPerSecond]"

If IncrementPerSecond is omitted, StillValue is applied as soon as interaction stops. Else the transition from InteractionValue to StillValue is automatically animated. Because incrementing is actually done at each redraw, and redraw happens many times per second, IncrementPerSecond is allowed to be greater than StillValue.

In the following code, the field named value belonging to the class SoComplexity will be set to 0.1 during an interaction. When the interaction stops, value will be increased by 2 every second until it reaches 0.5. Effectively this means that the StillValue (0.5) will be reached in (0.5 - 0.1) / 2 = 0.2 seconds.

icplx->fieldSettings.set1Value( 0, "SoComplexity value 0.1 0.5 2" );
root->addChild(icplx);
Field interactive complexity node.
SoMFString fieldSettings
Each string in this field specifies the interactionValue and stillValue for a specific field of a spe...
void set1Value(int index, const SbString &newValue)
Sets the index'th value in the array to newValue.

A time delay before changing the value, or starting the animation, can be set using the refinementDelay field.

The field interactiveMode allows to force the use of the InteractionValue or the StillValue.

Only a limited number of fields are supported by this node:

FILE FORMAT/DEFAULT

    InteractiveComplexity {
    fieldSettings []
    refinementDelay 0.5
    interactiveMode AUTO
    }

SEE ALSO

SoComplexity

Definition at line 152 of file SoInteractiveComplexity.h.

Member Enumeration Documentation

◆ InteractiveMode

Interactive mode.

Enumerator
AUTO 

Automatically detect when a user interaction is occurring (default)

FORCE_INTERACTION 

Behave like a user interaction is occurring (always use InteractionValue)

FORCE_STILL 

Behave like there isn't any interaction (always use StillValue)

DISABLED 

Behave like there isn't any SoInteractiveComplexity node.

Definition at line 160 of file SoInteractiveComplexity.h.

Constructor & Destructor Documentation

◆ SoInteractiveComplexity()

SoInteractiveComplexity::SoInteractiveComplexity ( )

Member Function Documentation

◆ getClassTypeId()

static SoType SoInteractiveComplexity::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoInteractiveComplexity::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

◆ fieldSettings

SoMFString SoInteractiveComplexity::fieldSettings

Each string in this field specifies the interactionValue and stillValue for a specific field of a specific node class.

The format is:

For scalar fields (SoSFInt32, SoSFFloat...) ClassName FieldName InteractionValue StillValue [IncrementPerSecond]
For SoSFBool fields (NumberOfSeconds = delay before switching state) ClassName FieldName InteractionValue [StillValue] [NumberOfSeconds]
For SoSFEnum fields ClassName FieldName InteractionValue StillValue

The following example defines values for a SoSFFloat, a SoSFBool and a SoSFEnum:

icplx->fieldSettings.set1Value(0, "SoComplexity value 0.1 0.5 2" );
// isActive will switch to TRUE 2 seconds after stopping interaction
icplx->fieldSettings.set1Value(1, "SoShadowGroup isActive FALSE 2" );
icplx->fieldSettings.set1Value(2, "SoVolumeRenderingQuality gradientQuality LOW HIGH");

Definition at line 220 of file SoInteractiveComplexity.h.

◆ interactiveMode

SoSFEnum SoInteractiveComplexity::interactiveMode

Interactive mode.

Use enum InteractiveMode. Default is AUTO.

NOTE: field available since Open Inventor 8.6

Definition at line 233 of file SoInteractiveComplexity.h.

◆ refinementDelay

SoSFFloat SoInteractiveComplexity::refinementDelay

Time in seconds after interaction stops before field values start to be increased.

Default is 0.0.

Definition at line 225 of file SoInteractiveComplexity.h.


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