Open Inventor Release 2024.2.0
 
Loading...
Searching...
No Matches
IvtProfileSetting Class Reference

VSG extension IvTune extension preferences More...

#include <IvTune/IvTuneExtender/IvtProfileSetting.h>

Public Member Functions

SbString getParameter (const SbString &name) const
 Returns the value of the parameter from its name.
 
const std::map< SbString, SbString > & getParameters () const
 Returns the list of parameters and associated values for this preference.
 
void setParameter (const SbString &name, const SbString &value)
 Set the specified parameter in this preference.
 
void addControlledExtension (IvtExtension *ext, IvtProfileSetting *setting)
 Add a controlled extension to the current extension (active or controlled).
 
const std::map< IvtExtension *, IvtProfileSetting * > & getControlledExtensions () const
 Returns the list of controlled extensions and associated settings for the current profile.
 
void setControlledBy (IvtExtension *controlledBy)
 Set an extension which is embedded and controlled by current extension.
 
IvtExtensiongetControlledBy () const
 Returns null if it is an active extension (top level), otherwise the extension which is embedded and controlled by the current active extension.
 
 IvtProfileSetting ()
 Constructor.
 
virtual ~IvtProfileSetting ()
 Destructor.
 

Detailed Description

VSG extension IvTune extension preferences

This class handles settings associated with an IvTune extension in the context of a profile. An active extension is an extension activated with a profile. A controlled extension is an extension activated by an active or another controlled extension.

Since Open Inventor 9.0

SEE ALSO

IvtProfile, IvtExtension

Definition at line 66 of file IvtProfileSetting.h.

Constructor & Destructor Documentation

◆ IvtProfileSetting()

IvtProfileSetting::IvtProfileSetting ( )

Constructor.

◆ ~IvtProfileSetting()

virtual IvtProfileSetting::~IvtProfileSetting ( )
virtual

Destructor.

Member Function Documentation

◆ addControlledExtension()

void IvtProfileSetting::addControlledExtension ( IvtExtension ext,
IvtProfileSetting setting 
)

Add a controlled extension to the current extension (active or controlled).

Parameters
extthe extension to add.
settingthe setting associated to the extension.

◆ getControlledBy()

IvtExtension * IvtProfileSetting::getControlledBy ( ) const

Returns null if it is an active extension (top level), otherwise the extension which is embedded and controlled by the current active extension.

◆ getControlledExtensions()

const std::map< IvtExtension *, IvtProfileSetting * > & IvtProfileSetting::getControlledExtensions ( ) const

Returns the list of controlled extensions and associated settings for the current profile.

◆ getParameter()

SbString IvtProfileSetting::getParameter ( const SbString name) const

Returns the value of the parameter from its name.

Parameters
namethe name of the parameter.

◆ getParameters()

const std::map< SbString, SbString > & IvtProfileSetting::getParameters ( ) const

Returns the list of parameters and associated values for this preference.

◆ setControlledBy()

void IvtProfileSetting::setControlledBy ( IvtExtension controlledBy)

Set an extension which is embedded and controlled by current extension.

Parameters
controlledBythe extension to be controlled.

◆ setParameter()

void IvtProfileSetting::setParameter ( const SbString name,
const SbString value 
)

Set the specified parameter in this preference.

Parameters
namethe name of the parameter.
valuethe value of the parameter.

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