Variable Preset Functions

This group of functions can be used to add, remove, and modify Variable Presets through the API.

AddVarPresetGroup(group_name)	Add a Variable Preset Group
AddVarPresetSetting(group_id, setting_name)	Add a Setting to the Variable Preset Group
AddVarPresetParm(group_id, parm_id)	Add a Parm to the Variable Preset Group
DeleteAllVarPresetGroups()	Delete Variable Preset Group (and all contained settings)
DeleteVarPresetGroup(group_id)	Delete a variable preset group and every setting in it.
DeleteAllVarPresetSettings(group_id)	Delete Variable Preset Setting
DeleteVarPresetSetting(group_id, setting_id)	Delete one setting from a variable preset group, leaving the group.
DeleteVarPresetParm(group_id, parm_id)	Delete Parm from Variable Preset Group
SetVarPresetParmVal(group_id, setting_id, ...)	Set value for Parm in Var Preset Setting
GetVarPresetParmVal(group_id, setting_id, ...)	Get value for Parm in Var Preset Setting
GetGroupName(group_id)	Get Variable Preset group name
GetSettingName(setting_id)	Get Variable Preset Setting name
SetGroupName(group_id, group_name)	Set Variable Preset group name
SetSettingName(setting_id, setting_name)	Set Variable Preset Setting name
GetVarPresetGroups()	Get group_ids for Variable Preset Groups
GetVarPresetSettings(group_id)	Get Setting IDs for Variable Preset Group
GetVarPresetParmIDs(group_id)	Get ParmIDs for Variable Preset Group
GetVarPresetParmVals(setting_id)	Get Parm values for Variable Preset Setting
SetVarPresetParmVals(setting_id, parm_vals)	Set Parm values for Variable Preset Setting
SaveVarPresetParmVals(group_id, setting_id)	Save current Parm values to Variable Preset Setting
ApplyVarPresetSetting(group_id, setting_id)	Apply Parm values for Var Preset Setting

Details

openvsp.AddVarPresetGroup(group_name)

Add a Variable Preset Group

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

Parameters:

[in] – group_name string Name for Var Preset Group

Return type:

string

Returns:

string Var Preset Group ID

openvsp.AddVarPresetSetting(group_id, setting_name)

Add a Setting to the Variable Preset Group

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

Parameters:

• [in] – group_id string Var Preset Group ID

• [in] – setting_name string Var Preset Setting Name

Return type:

string

Returns:

string Var Preset Setting ID

openvsp.AddVarPresetParm(group_id, parm_id)

Add a Parm to the Variable Preset Group

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

# The Parm has to show up in the group's list, and only once.
parm_ids = GetVarPresetParmIDs( gid )

assert len( parm_ids ) == 1, "AddVarPresetParm did not add the Parm to the group"
assert parm_ids[0] == p1, "AddVarPresetParm added the wrong Parm"

# Adding it again has to be rejected rather than duplicating it.  The error
# queue is reached through the error manager singleton in Python.
err_mgr = ErrorMgrSingleton.getInstance()

AddVarPresetParm( gid, p1 )

assert err_mgr.GetNumTotalErrors() > 0, "AddVarPresetParm accepted the same Parm twice"
assert len( GetVarPresetParmIDs( gid ) ) == 1, "AddVarPresetParm added the same Parm twice"

# That error was raised deliberately, so take it back off the queue.
while err_mgr.GetNumTotalErrors() > 0 :
    err = err_mgr.PopLastError()

Parameters:

• [in] – group_id string Var Preset Group ID

• [in] – parm_id string Parm ID

openvsp.DeleteAllVarPresetGroups()

Delete Variable Preset Group (and all contained settings)

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

num_before_del = len( GetVarPresetGroups() )
DeleteVarPresetGroup( gid )
assert len( GetVarPresetGroups() ) < num_before_del, "DeleteVarPresetGroup removed nothing"

Parameters:

[in] – group_id string Var Preset Group ID

Delete every Variable Preset Group, along with all the settings they contain

gid1 = AddVarPresetGroup( "Tess" )
gid2 = AddVarPresetGroup( "Design" )

assert len( GetVarPresetGroups() ) == 2, "the two groups were not both added"

DeleteAllVarPresetGroups()

assert len( GetVarPresetGroups() ) == 0, "DeleteAllVarPresetGroups left groups behind"

See also: AddVarPresetGroup, DeleteVarPresetGroup, GetVarPresetGroups

openvsp.DeleteVarPresetGroup(group_id)

Delete a variable preset group and every setting in it.

gid = AddVarPresetGroup( "TestGroup" )

DeleteVarPresetGroup( gid )

assert len( GetVarPresetGroups() ) == 0, "DeleteVarPresetGroup did not delete the group"

See also: AddVarPresetGroup, GetVarPresetGroups :param [in]: group_id string Variable preset group ID

openvsp.DeleteAllVarPresetSettings(group_id)

Delete Variable Preset Setting

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

num_before_del = len( GetVarPresetSettings( gid ) )
DeleteVarPresetSetting( gid, sid )
assert len( GetVarPresetSettings( gid ) ) < num_before_del, "DeleteVarPresetSetting removed nothing"

Parameters:

• [in] – group_id string Var Preset Group ID

• [in] – setting_id string Var Preset Setting ID

Delete every setting in a Variable Preset Group, leaving the group itself in place

gid = AddVarPresetGroup( "Tess" )

AddVarPresetSetting( gid, "Coarse" )
AddVarPresetSetting( gid, "Fine" )

gid2 = AddVarPresetGroup( "Design" )
AddVarPresetSetting( gid2, "Normal" )

DeleteAllVarPresetSettings( gid )

# The group stays; its settings go.  The other group is left alone.
assert len( GetVarPresetSettings( gid ) ) == 0, "DeleteAllVarPresetSettings left settings behind"
assert len( GetVarPresetGroups() ) == 2, "DeleteAllVarPresetSettings removed the group"
assert len( GetVarPresetSettings( gid2 ) ) == 1, "DeleteAllVarPresetSettings reached another group"

See also: AddVarPresetSetting, DeleteVarPresetSetting, GetVarPresetSettings :param [in]: group_id string Var Preset Group ID

openvsp.DeleteVarPresetSetting(group_id, setting_id)

Delete one setting from a variable preset group, leaving the group.

gid = AddVarPresetGroup( "TestGroup" )

sid = AddVarPresetSetting( gid, "TestSetting" )

DeleteVarPresetSetting( gid, sid )

assert len( GetVarPresetSettings( gid ) ) == 0, "DeleteVarPresetSetting did not delete the setting"

See also: AddVarPresetSetting, GetVarPresetSettings :param [in]: group_id string Variable preset group ID :param [in]: setting_id string Setting ID within that group

openvsp.DeleteVarPresetParm(group_id, parm_id)

Delete Parm from Variable Preset Group

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

num_before_del = len( GetVarPresetParmIDs( gid ) )
DeleteVarPresetParm( gid, p1 )
assert len( GetVarPresetParmIDs( gid ) ) < num_before_del, "DeleteVarPresetParm removed nothing"

Parameters:

• [in] – group_id string Var Preset Group ID

• [in] – parm_id string Var Parm ID

openvsp.SetVarPresetParmVal(group_id, setting_id, parm_id, parm_val)

Set value for Parm in Var Preset Setting

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

SetVarPresetParmVal( gid, sid, p1, 51 )
assert abs( GetVarPresetParmVal( gid, sid, p1 ) - 51 ) < 1e-9, "SetVarPresetParmVal did not take"

Parameters:

• [in] – group_id string Var Preset Group ID

• [in] – setting_id string Var Preset Setting ID

• [in] – parm_id string Var Parm ID

• [in] – parm_val double Parm value

openvsp.GetVarPresetParmVal(group_id, setting_id, parm_id)

Get value for Parm in Var Preset Setting

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

val = GetVarPresetParmVal( gid, sid, p1 )

# A Parm joins the group at its current value.
assert abs( val - GetParmVal( p1 ) ) < 1e-9, "GetVarPresetParmVal does not match the Parm"

# Storing a different value has to be what comes back, without disturbing the
# Parm itself.
SetVarPresetParmVal( gid, sid, p1, val + 3.0 )

assert abs( GetVarPresetParmVal( gid, sid, p1 ) - ( val + 3.0 ) ) < 1e-9, "GetVarPresetParmVal did not follow SetVarPresetParmVal"
assert abs( GetParmVal( p1 ) - val ) < 1e-9, "storing a preset value changed the Parm"

Parameters:

• [in] – group_id string Var Preset Group ID

• [in] – setting_id string Var Preset Setting ID

• [in] – parm_id string Var Parm ID

Return type:

float

Returns:

double Var Preset Parm value

openvsp.GetGroupName(group_id)

Get Variable Preset group name

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

name = GetGroupName( gid )
assert len( name ) > 0, "GetGroupName returned nothing"

Parameters:

[in] – group_id string Var Preset Group ID

Return type:

string

Returns:

string Var Preset Group name

openvsp.GetSettingName(setting_id)

Get Variable Preset Setting name

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

name = GetSettingName( sid )
assert len( name ) > 0, "GetSettingName returned nothing"

Parameters:

[in] – setting_id string Var Preset Setting ID

Return type:

string

Returns:

string Var Preset Setting name

openvsp.SetGroupName(group_id, group_name)

Set Variable Preset group name

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

SetGroupName( gid, "Resolution" )
assert GetGroupName( gid ) == "Resolution", "SetGroupName did not take"

Parameters:

• [in] – group_id string Var Preset Group ID

• [in] – group_name string New Var Preset Group name

openvsp.SetSettingName(setting_id, setting_name)

Set Variable Preset Setting name

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

SetSettingName( sid, "Low" )
assert GetSettingName( sid ) == "Low", "SetSettingName did not take"

Parameters:

• [in] – setting_id string Var Preset Setting ID

• [in] – setting_name string New Var Preset Setting name

openvsp.GetVarPresetGroups()

Get group_ids for Variable Preset Groups

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

group_ids = GetVarPresetGroups()
assert len( group_ids ) > 0, "GetVarPresetGroups returned nothing"

Return type:

std::vector< std::string,std::allocator< std::string > >

Returns:

array<string> Array of Variable Preset Group IDs

openvsp.GetVarPresetSettings(group_id)

Get Setting IDs for Variable Preset Group

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

settingds = GetVarPresetSettings( gid )
assert len( settingds ) > 0, "GetVarPresetSettings returned nothing"

Parameters:

[in] – group_id string Var Preset Group ID

Return type:

std::vector< std::string,std::allocator< std::string > >

Returns:

array<string> Array of Variable Preset Group ParmIDs

openvsp.GetVarPresetParmIDs(group_id)

Get ParmIDs for Variable Preset Group

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

parmids = GetVarPresetParmIDs( gid )
assert len( parmids ) > 0, "GetVarPresetParmIDs returned nothing"

Parameters:

[in] – group_id string Var Preset Group ID

Return type:

std::vector< std::string,std::allocator< std::string > >

Returns:

array<string> Array of Variable Preset Group ParmIDs

openvsp.GetVarPresetParmVals(setting_id)

Get Parm values for Variable Preset Setting

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

parmval_vec = GetVarPresetParmVals( sid )
assert len( parmval_vec ) > 0, "GetVarPresetParmVals returned nothing"

Parameters:

[in] – setting_id string Var Preset Setting ID

Return type:

std::vector< double,std::allocator< double > >

Returns:

array<double> Var Preset Parm values for Setting

openvsp.SetVarPresetParmVals(setting_id, parm_vals)

Set Parm values for Variable Preset Setting

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

vals = [ 45 ]

SetVarPresetParmVals( sid, vals )

assert list( GetVarPresetParmVals( sid ) ) == list( vals ), "SetVarPresetParmVals did not take"

Parameters:

• [in] – setting_id string Var Preset Setting ID

• [in] – parm_vals array<double> Array of Variable Preset Group Parm values

openvsp.SaveVarPresetParmVals(group_id, setting_id)

Save current Parm values to Variable Preset Setting

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

# Move the Parm away from whatever the setting holds, then save.
SetParmVal( p1, GetParmVal( p1 ) + 4.0 )

Update()

SaveVarPresetParmVals( gid, sid )

# The setting now holds the Parm's current value.
assert abs( GetVarPresetParmVal( gid, sid, p1 ) - GetParmVal( p1 ) ) < 1e-9, "SaveVarPresetParmVals did not capture the current value"

Parameters:

• [in] – group_id string Var Preset Group ID

• [in] – setting_id string Var Preset Setting ID

openvsp.ApplyVarPresetSetting(group_id, setting_id)

Apply Parm values for Var Preset Setting

# Add Pod Geom
pod1 = AddGeom( "POD", "" )

gid = AddVarPresetGroup( "Tess" )

sid = AddVarPresetSetting( gid, "Coarse" )

p1 = FindParm( pod1, "Tess_U", "Shape" )

AddVarPresetParm( gid, p1 )

# Store a value in the setting, move the Parm somewhere else, then apply.
target = GetParmVal( p1 ) + 5.0

SetVarPresetParmVal( gid, sid, p1, target )

SetParmVal( p1, GetParmVal( p1 ) - 2.0 )

Update()

ApplyVarPresetSetting( gid, sid )

Update()

# Applying the setting drives the Parm to the stored value.
assert abs( GetParmVal( p1 ) - target ) < 1e-9, "ApplyVarPresetSetting did not apply the stored value"

Parameters:

• [in] – group_id string Var Preset Group ID

• [in] – setting_id string Var Preset Setting ID