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

VSG extension Configuration profile. More...

#include <IvTune/IvTuneExtender/IvtProfile.h>

+ Inheritance diagram for IvtProfile:

Public Member Functions

void activate ()
 Activate this profile and its associated extensions.
 
void addExtension (IvtExtension *extension, IvtProfileSetting *preference)
 Add the given extension and its preferences to this profile.
 
void addIncludeProfile (const SbString &profileName)
 Include the specified profile in this profile.
 
void deactivate ()
 Deactivate this profile and its associated extensions.
 
const std::map< IvtExtension *, IvtProfileSetting * > & getExtensions () const
 Returns a map of the extensions and their associated preferences for this profile.
 
const std::list< SbString > & getIncludeProfile () const
 Returns a list of names of the profiles included by the current profile.
 
SbString getName () const
 Returns the name of this profile.
 
SbBool isActive () const
 Returns true if this profile is active.
 
void removeExtension (IvtExtension *extension)
 Remove the given extension.
 
 IvtProfile (const SbString &name)
 Constructor.
 
virtual ~IvtProfile ()
 Destructor.
 

Detailed Description

VSG extension Configuration profile.

This class handles IvTune extensions activated by a profile.

Since Open Inventor 9.0

SEE ALSO

IvtPluginsManager

Definition at line 68 of file IvtProfile.h.

Constructor & Destructor Documentation

◆ IvtProfile()

IvtProfile::IvtProfile ( const SbString name)

Constructor.

Parameters
namethe name of this profile.

◆ ~IvtProfile()

virtual IvtProfile::~IvtProfile ( )
virtual

Destructor.

Member Function Documentation

◆ activate()

void IvtProfile::activate ( )

Activate this profile and its associated extensions.

It also sets the preferences associated with the extensions.

◆ addExtension()

void IvtProfile::addExtension ( IvtExtension extension,
IvtProfileSetting preference 
)

Add the given extension and its preferences to this profile.

Parameters
extensionthe extension to add.
preferencethe preference associated to the extension.

◆ addIncludeProfile()

void IvtProfile::addIncludeProfile ( const SbString profileName)

Include the specified profile in this profile.

Parameters
profileNamethe name of the profile to include.

◆ deactivate()

void IvtProfile::deactivate ( )

Deactivate this profile and its associated extensions.

◆ getExtensions()

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

Returns a map of the extensions and their associated preferences for this profile.

◆ getIncludeProfile()

const std::list< SbString > & IvtProfile::getIncludeProfile ( ) const

Returns a list of names of the profiles included by the current profile.

◆ getName()

SbString IvtProfile::getName ( ) const

Returns the name of this profile.

◆ isActive()

SbBool IvtProfile::isActive ( ) const

Returns true if this profile is active.

◆ removeExtension()

void IvtProfile::removeExtension ( IvtExtension extension)

Remove the given extension.

Parameters
extensionthe extension to remove.

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