OpenVSPAPI  3.20.0
Functions
Variable Preset Functions

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

Click here to return to the main page. More...

Functions

void AddVarPresetGroup (const string &in group_name)
 
void AddVarPresetSetting (const string &in setting_name)
 
void AddVarPresetParm (const string &in parm_ID)
 
void AddVarPresetParm (const string &in parm_ID, const string &in group_name)
 
void EditVarPresetParm (const string &in parm_ID, double parm_val)
 
void EditVarPresetParm (const string &in parm_ID, double parm_val, const string &in group_name, const string &in setting_name)
 
void DeleteVarPresetParm (const string &in parm_ID)
 
void DeleteVarPresetParm (const string &in parm_ID, const string &in group_name)
 
void SwitchVarPreset (const string &in group_name, const string &in setting_name)
 
bool DeleteVarPresetSet (const string &in group_name, const string &in setting_name)
 
string GetCurrentGroupName ()
 
string GetCurrentSettingName ()
 
string[] GetVarPresetGroupNames ()
 
string[] GetVarPresetSettingNamesWName (const string &in group_name)
 
string[] GetVarPresetSettingNamesWIndex (int group_index)
 
double[] GetVarPresetParmVals ()
 
double[] GetVarPresetParmValsWNames (const string &in group_name, const string &in setting_name)
 
string[] GetVarPresetParmIDs ()
 
string[] GetVarPresetParmIDsWName (const string &in group_name)
 

Detailed Description

Function Documentation

◆ AddVarPresetGroup()

void AddVarPresetGroup ( const string &in  group_name)

Add a Variable Presets group

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
if ( GetVarPresetGroupNames().size() != 1 ) { Print( "---> Error: API AddVarPresetGroup" ); }
Parameters
[in]group_nameVariable Presets group name

◆ AddVarPresetParm() [1/2]

void AddVarPresetParm ( const string &in  parm_ID)

Add a Parm to the currently active Variable Preset

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
string p1 = FindParm( pod1, "Shape", "Tess_U" );
Parameters
[in]parm_IDParm ID

◆ AddVarPresetParm() [2/2]

void AddVarPresetParm ( const string &in  parm_ID,
const string &in  group_name 
)

Add a Parm to the specified Variable Preset group

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
string p1 = FindParm( pod1, "Shape", "Tess_U" );
AddVarPresetParm( p1, "Tess" );
Parameters
[in]parm_IDParm ID
[in]group_nameVariable Presets group name

◆ AddVarPresetSetting()

void AddVarPresetSetting ( const string &in  setting_name)

Add a setting to the currently active Variable Preset

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
if ( GetVarPresetSettingNamesWName( "Tess" ).size() != 1 ) { Print( "---> Error: API AddVarPresetSetting" ); }
Parameters
[in]setting_nameVariable Presets setting name

◆ DeleteVarPresetParm() [1/2]

void DeleteVarPresetParm ( const string &in  parm_ID)

Remove a Parm from the currently active Variable Preset group

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
string p1 = FindParm( pod1, "Shape", "Tess_U" );
Parameters
[in]parm_IDParm ID

◆ DeleteVarPresetParm() [2/2]

void DeleteVarPresetParm ( const string &in  parm_ID,
const string &in  group_name 
)

Remove a Parm from a Variable Preset group

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
string p1 = FindParm( pod1, "Shape", "Tess_U" );
AddVarPresetGroup( "New_Group" );
DeleteVarPresetParm( p1, "Tess" );
Parameters
[in]parm_IDParm ID
[in]group_nameVariable Presets group name

◆ DeleteVarPresetSet()

bool DeleteVarPresetSet ( const string &in  group_name,
const string &in  setting_name 
)

Delete a Variable Preset

DeleteVarPresetSet( "Tess", "Fine" );
if ( GetVarPresetSettingNamesWName( "Tess" ).size() != 1 ) { Print ( "---> Error: DeleteVarPresetSet" ); }
Parameters
[in]group_nameVariable Presets group
[in]setting_nameVariable Presets setting name
Returns
true is successful, false otherwise

◆ EditVarPresetParm() [1/2]

void EditVarPresetParm ( const string &in  parm_ID,
double  parm_val 
)

Edit the value of a Parm in the currently active Variable Preset

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
string p1 = FindParm( pod1, "Shape", "Tess_U" );
Parameters
[in]parm_IDParm ID
[in]parm_valParm value

◆ EditVarPresetParm() [2/2]

void EditVarPresetParm ( const string &in  parm_ID,
double  parm_val,
const string &in  group_name,
const string &in  setting_name 
)

Edit the value of a Parm in the specified Variable Preset group and setting

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
string p1 = FindParm( pod1, "Shape", "Tess_U" );
AddVarPresetGroup( "New_Group" );
EditVarPresetParm( p1, 5, "Tess", "Coarse" );
Parameters
[in]parm_IDParm ID
[in]parm_valParm value
[in]group_nameVariable Presets group name
[in]setting_nameVariable Presets setting name

◆ GetCurrentGroupName()

string GetCurrentGroupName ( )

Get the currently active Variable Presets group name

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
string p1 = FindParm( pod1, "Shape", "Tess_U" );
AddVarPresetGroup( "New_Group" );
AddVarPresetSetting( "New_Setting" );
Print( "Current Group: " );
Returns
Variable Presets group name

◆ GetCurrentSettingName()

string GetCurrentSettingName ( )

Get the currently active Variable Presets setting name

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
string p1 = FindParm( pod1, "Shape", "Tess_U" );
AddVarPresetGroup( "New_Group" );
AddVarPresetSetting( "New_Setting" );
Print( "Current Setting: " );
Returns
Variable Presets setting name

◆ GetVarPresetGroupNames()

string [] GetVarPresetGroupNames ( )

Get all Variable Preset group names

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
if ( GetVarPresetGroupNames().size() != 1 ) { Print( "---> Error: API AddVarPresetGroup" ); }
Returns
Array of Variable Presets group names

◆ GetVarPresetParmIDs()

string [] GetVarPresetParmIDs ( )

Get the Parm IDs contained in the currently active Variable Presets group

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
string p1 = FindParm( "PodGeom", "Shape", "Tess_U" );
if ( p_IDs.size() != 1 ) { Print( "---> Error: API AddVarPresetParm" ); }
Returns
Array of Variable Presets Parm IDs

◆ GetVarPresetParmIDsWName()

string [] GetVarPresetParmIDsWName ( const string &in  group_name)

Get the Parm IDs contained in the specitied Variable Presets group

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetGroup( "New_Group" );
AddVarPresetSetting( "New_Setting_1" );
AddVarPresetSetting( "New_Setting_2" );
p1 = FindParm( pod1, "XForm", "Y_Rel_Rotation" );
p2 = FindParm( pod1, "XForm", "Z_Rel_Rotation" );
array < string > parm_ids = GetVarPresetParmValsWNames( "New_Group" );
if ( parm_ids.size() != 2 ) { Print( "---> Error: API GetVarPresetParmIDsWName" ); }
Parameters
[in]group_nameVariable Presets group name
Returns
Array of Parm IDs

◆ GetVarPresetParmVals()

double [] GetVarPresetParmVals ( )

Get the value of each Parm in the currently active Variable Preset group and setting

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
string p1 = FindParm( pod1, "Shape", "Tess_U" );
if ( p_vals[0] != 5 ) { Print ( "---> Error: API EditVarPresetParm" ); }
Returns
Array of Variable Presets Parm values

◆ GetVarPresetParmValsWNames()

double [] GetVarPresetParmValsWNames ( const string &in  group_name,
const string &in  setting_name 
)

Get the value of each Parm in the specified Variable Preset group and setting

Parameters
[in]group_nameVariable Presets group name
[in]setting_nameVariable Presets setting name
// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetGroup( "New_Group" );
AddVarPresetSetting( "New_Setting_1" );
AddVarPresetSetting( "New_Setting_2" );
p1 = FindParm( pod1, "XForm", "Y_Rel_Rotation" );
p2 = FindParm( pod1, "XForm", "Z_Rel_Rotation" );
EditVarPresetParm( p2, 2, "New_Group", "New_Setting_2" );
array < double > parm_vals = GetVarPresetParmValsWNames( "New_Group", "New_Setting_2" );
if ( parm_vals.size() != 2 ) { Print( "---> Error: API GetVarPresetParmValsWNames" ); }
Returns
Array of Variable Presets Parm values

◆ GetVarPresetSettingNamesWIndex()

string [] GetVarPresetSettingNamesWIndex ( int  group_index)

Get the name of each settings in the specified Variable Presets group index

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
string p1 = FindParm( pod1, "Shape", "Tess_U" );
AddVarPresetGroup( "New_Group" );
AddVarPresetSetting( "New_Setting_1" );
AddVarPresetSetting( "New_Setting_2" );
if ( group_1_settings.size() != 2 ) { Print( "---> Error: API GetVarPresetSettingNamesWIndex" ); }
Parameters
[in]group_indexVariable Presets group index
Returns
Array of Variable Presets setting names

◆ GetVarPresetSettingNamesWName()

string [] GetVarPresetSettingNamesWName ( const string &in  group_name)

Get the name of each settings in the specified Variable Presets group name

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetSetting( "Coarse" );
if ( GetVarPresetSettingNamesWName( "Tess" ).size() != 1 ) { Print( "---> Error: API AddVarPresetSetting" ); }
Parameters
[in]group_nameVariable Presets group name
Returns
Array of Variable Presets setting names

◆ SwitchVarPreset()

void SwitchVarPreset ( const string &in  group_name,
const string &in  setting_name 
)

Change the currently active Variable Preset

// Add Pod Geom
string pod1 = AddGeom( "POD", "" );
AddVarPresetGroup( "Config" );
AddVarPresetSetting( "Default" );
p1 = FindParm( pod1, "XForm", "Y_Rel_Rotation" );
p2 = FindParm( pod1, "XForm", "Z_Rel_Rotation" );
SwitchVarPreset( "Config", "Default" );
Parameters
[in]group_nameVariable Presets group name
[in]setting_nameVariable Presets setting name
GetCurrentGroupName
string GetCurrentGroupName()
GetVarPresetParmValsWNames
double[] GetVarPresetParmValsWNames(const string &in group_name, const string &in setting_name)
GetCurrentSettingName
string GetCurrentSettingName()
GetVarPresetParmIDs
string[] GetVarPresetParmIDs()
DeleteVarPresetSet
bool DeleteVarPresetSet(const string &in group_name, const string &in setting_name)
FindParm
string FindParm(const string &in parm_container_id, const string &in parm_name, const string &in group_name)
DeleteVarPresetParm
void DeleteVarPresetParm(const string &in parm_ID)
GetVarPresetGroupNames
string[] GetVarPresetGroupNames()
array
AngelScript ScriptExtension for representing the C++ std::vector.
Definition: openvsp_as.h:244
SwitchVarPreset
void SwitchVarPreset(const string &in group_name, const string &in setting_name)
AddVarPresetGroup
void AddVarPresetGroup(const string &in group_name)
AddGeom
string AddGeom(const string &in type, const string &in parent=string())
EditVarPresetParm
void EditVarPresetParm(const string &in parm_ID, double parm_val)
Print
void Print(const string &in data, bool new_line=true)
GetVarPresetParmVals
double[] GetVarPresetParmVals()
GetVarPresetSettingNamesWIndex
string[] GetVarPresetSettingNamesWIndex(int group_index)
AddVarPresetParm
void AddVarPresetParm(const string &in parm_ID)
AddVarPresetSetting
void AddVarPresetSetting(const string &in setting_name)
GetVarPresetSettingNamesWName
string[] GetVarPresetSettingNamesWName(const string &in group_name)