This group of API functions can be used to control the Ruler Tool through the API.
Click here to return to the main page.
More...
|
string | AddRuler (const string &in startgeomid, int startsurfindx, double startu, double startw, const string &in endgeomid, int endsurfindx, double endu, double endw, const string &in name) |
|
string [] | GetAllRulers () |
|
void | DelRuler (const string &in id) |
|
void | DeleteAllRulers () |
|
string | AddProbe (const string &in geomid, int surfindx, double u, double w, const string &in name) |
|
string [] | GetAllProbes () |
|
void | DelProbe (const string &in id) |
|
void | DeleteAllProbes () |
|
◆ AddProbe()
string AddProbe |
( |
const string &in |
geomid, |
|
|
int |
surfindx, |
|
|
double |
u, |
|
|
double |
w, |
|
|
const string &in |
name |
|
) |
| |
Create a new Probe and add it to the Measure Tool
string pid1 =
AddGeom(
"POD",
"" );
SetParmVal( pid1,
"Y_Rel_Location",
"XForm", 2.0 );
string probe_id =
AddProbe( pid1, 0, 0.5, 0.8,
"Probe 1" );
- Parameters
-
[in] | geomid | Parent Geom ID |
[in] | surfindx | Main surface index from the parent Geom |
[in] | u | Surface u (0 - 1) coordinate |
[in] | w | Surface w (0 - 1) coordinate |
[in] | name | Probe name |
- Returns
- Probe ID
◆ AddRuler()
string AddRuler |
( |
const string &in |
startgeomid, |
|
|
int |
startsurfindx, |
|
|
double |
startu, |
|
|
double |
startw, |
|
|
const string &in |
endgeomid, |
|
|
int |
endsurfindx, |
|
|
double |
endu, |
|
|
double |
endw, |
|
|
const string &in |
name |
|
) |
| |
Create a new Ruler and add it to the Measure Tool
string pid1 =
AddGeom(
"POD",
"" );
SetParmVal( pid1,
"Y_Rel_Location",
"XForm", 2.0 );
string pid2 =
AddGeom(
"POD",
"" );
SetParmVal( pid2,
"Z_Rel_Location",
"XForm", 4.0 );
string rid =
AddRuler( pid1, 1, 0.2, 0.3, pid2, 0, 0.2, 0.3,
"Ruler 1" );
- Parameters
-
[in] | startgeomid | Start parent Geom ID |
[in] | startsurfindx | Main surface index from the staring parent Geom |
[in] | startu | Surface u (0 - 1) start coordinate |
[in] | startw | Surface w (0 - 1) start coordinate |
[in] | endgeomid | End parent Geom ID |
[in] | endsurfindx | Main surface index on the end parent Geom |
[in] | endu | Surface u (0 - 1) end coordinate |
[in] | endw | Surface w (0 - 1) end coordinate |
[in] | name | Ruler name |
- Returns
- Ruler ID
◆ DeleteAllProbes()
Delete all Probes from the Measure Tool
string pid1 =
AddGeom(
"POD",
"" );
SetParmVal( pid1,
"Y_Rel_Location",
"XForm", 2.0 );
string probe_id_1 =
AddProbe( pid1, 0, 0.5, 0.8,
"Probe 1" );
string probe_id_2 =
AddProbe( pid1, 0, 0.2, 0.3,
"Probe 2" );
if ( probe_array.size() != 0 ) {
Print(
"Error: DeleteAllProbes" ); }
◆ DeleteAllRulers()
Delete all Rulers from the Meaure Tool
string pid1 =
AddGeom(
"POD",
"" );
SetParmVal( pid1,
"Y_Rel_Location",
"XForm", 2.0 );
string pid2 =
AddGeom(
"POD",
"" );
SetParmVal( pid2,
"Z_Rel_Location",
"XForm", 4.0 );
string rid1 =
AddRuler( pid1, 1, 0.2, 0.3, pid2, 0, 0.2, 0.3,
"Ruler 1" );
string rid2 =
AddRuler( pid1, 0, 0.4, 0.6, pid1, 1, 0.8, 0.9,
"Ruler 2" );
◆ DelProbe()
void DelProbe |
( |
const string &in |
id | ) |
|
Delete a specific Probe from the Measure Tool
string pid1 =
AddGeom(
"POD",
"" );
SetParmVal( pid1,
"Y_Rel_Location",
"XForm", 2.0 );
string probe_id_1 =
AddProbe( pid1, 0, 0.5, 0.8,
"Probe 1" );
string probe_id_2 =
AddProbe( pid1, 0, 0.2, 0.3,
"Probe 2" );
if ( probe_array.size() != 1 ) {
Print(
"Error: DelProbe" ); }
- Parameters
-
◆ DelRuler()
void DelRuler |
( |
const string &in |
id | ) |
|
Delete a particular Ruler from the Meaure Tool
string pid1 =
AddGeom(
"POD",
"" );
SetParmVal( pid1,
"Y_Rel_Location",
"XForm", 2.0 );
string pid2 =
AddGeom(
"POD",
"" );
SetParmVal( pid2,
"Z_Rel_Location",
"XForm", 4.0 );
string rid1 =
AddRuler( pid1, 1, 0.2, 0.3, pid2, 0, 0.2, 0.3,
"Ruler 1" );
string rid2 =
AddRuler( pid1, 0, 0.4, 0.6, pid1, 1, 0.8, 0.9,
"Ruler 2" );
- Parameters
-
◆ GetAllProbes()
Get an array of all Probe IDs from the Measure Tool
string pid1 =
AddGeom(
"POD",
"" );
SetParmVal( pid1,
"Y_Rel_Location",
"XForm", 2.0 );
string probe_id =
AddProbe( pid1, 0, 0.5, 0.8,
"Probe 1" );
Print(
"One Probe: ",
false );
- Returns
- [in] Array of Probe IDs
◆ GetAllRulers()
Get an array of all Ruler IDs from the Measure Tool
string pid1 =
AddGeom(
"POD",
"" );
SetParmVal( pid1,
"Y_Rel_Location",
"XForm", 2.0 );
string pid2 =
AddGeom(
"POD",
"" );
SetParmVal( pid2,
"Z_Rel_Location",
"XForm", 4.0 );
string rid1 =
AddRuler( pid1, 1, 0.2, 0.3, pid2, 0, 0.2, 0.3,
"Ruler 1" );
string rid2 =
AddRuler( pid1, 0, 0.4, 0.6, pid1, 1, 0.8, 0.9,
"Ruler 2" );
for( int n = 0 ; n < int( ruler_array.length() ) ; n++ )
{
}
- Returns
- Array of Ruler IDs