OpenVSP API Documentation 3.51.0
Loading...
Searching...
No Matches
Functions
RoutingGeom Functions

This group of API functions is used to create and manipulate RoutingGeom objects, which define wire routing paths between points in the model. Click here to return to the main page. More...

Functions

int vsp::GetNumRoutingPts (const string &routing_id)
string vsp::AddRoutingPt (const string &routing_id, const string &geom_id, int surf_index)
string vsp::InsertRoutingPt (const string &routing_id, int index, const string &geom_id, int surf_index)
void vsp::DelRoutingPt (const string &routing_id, int index)
void vsp::DelAllRoutingPt (const string &routing_id)
int vsp::MoveRoutingPt (const string &routing_id, int index, int reorder_type)
string vsp::GetRoutingPtID (const string &routing_id, int index)
vector< string > vsp::GetAllRoutingPtIds (const string &routing_id)
string vsp::GetRoutingPtParentID (const string &pt_id)
void vsp::SetRoutingPtParentID (const string &pt_id, const string &parent_id)
vec3d vsp::GetMainRoutingPtCoord (const string &pt_id)
vec3d vsp::GetRoutingPtCoord (const string &routing_id, int index, int symm_index)
vector< vec3d > vsp::GetAllRoutingPtCoords (const string &routing_id, int symm_index)
vector< vec3d > vsp::GetRoutingCurve (const string &routing_id, int symm_index)

Detailed Description

Function Documentation

◆ AddRoutingPt()

string vsp::AddRoutingPt ( const string & routing_id,
const string & geom_id,
int surf_index )
extern

Add a routing point to a RoutingGeom. The new point will be the last point in the route. The new point will be anchored to the specified geom and surface.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
vsp::AddGeom
std::string AddGeom(const std::string &type, const std::string &parent=std::string())
vsp::SetParmVal
double SetParmVal(const std::string &parm_id, double val)
vsp::GetParm
std::string GetParm(const std::string &geom_id, const std::string &name, const std::string &group)
vsp::AddRoutingPt
string AddRoutingPt(const string &routing_id, const string &geom_id, int surf_index)
See also
AddRoutingPt, DelRoutingPt, InsertRoutingPt
Parameters
[in]routing_idstring RoutingGeom Geom ID
[in]geom_idstring Geom ID of geom to anchor new routing point to
[in]surf_indexint Index of surf to anchor new routing point to
Returns
string ParmContainer ID for the newly added routing point

◆ DelAllRoutingPt()

void vsp::DelAllRoutingPt ( const string & routing_id)
extern

Delete all routing points from a RoutingGeom.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
DelAllRoutingPt( routing_geom );
vsp::DelAllRoutingPt
void DelAllRoutingPt(const string &routing_id)
See also
AddRoutingPt, DelRoutingPt
Parameters
[in]routing_idstring RoutingGeom Geom ID

◆ DelRoutingPt()

void vsp::DelRoutingPt ( const string & routing_id,
int index )
extern

Delete a specified routing point from a RoutingGeom.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
DelRoutingPt( routing_geom, 1 );
vsp::DelRoutingPt
void DelRoutingPt(const string &routing_id, int index)
See also
AddRoutingPt, DelAllRoutingPt
Parameters
[in]routing_idstring RoutingGeom Geom ID
[in]indexint Index of routing point to delete

◆ GetAllRoutingPtCoords()

vector< vec3d > vsp::GetAllRoutingPtCoords ( const string & routing_id,
int symm_index )
extern

Get the coordinate locations along a RoutingGeom. The main copy is symm_index = 0.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
Update();
array<vec3d> pvec = GetAllRoutingPtCoords(routing_geom, 0);
vsp::GetAllRoutingPtCoords
vector< vec3d > GetAllRoutingPtCoords(const string &routing_id, int symm_index)
vsp::Update
void Update(bool update_managers=true)
See also
AddRoutingPt, DelRoutingPt, GetMainRoutingPtCoord, GetRoutingPtCoord, GetRoutingCurve
Parameters
[in]routing_idstring RoutingGeom Geom ID
[in]symm_indexint Symmetry index to get coordinate of
Returns
vector < vec3d > coordinate of routing points along RoutingGeom

◆ GetAllRoutingPtIds()

vector< string > vsp::GetAllRoutingPtIds ( const string & routing_id)
extern

Get the ParmContainer IDs of all the routing points within a RoutingGeom. The vector will contain the IDs in order.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
array<string> @rpts = GetAllRoutingPtIds(routing_geom);
vsp::GetAllRoutingPtIds
vector< string > GetAllRoutingPtIds(const string &routing_id)
See also
AddRoutingPt, DelAllRoutingPt, GetRoutingPtId
Parameters
[in]routing_idstring RoutingGeom Geom ID
Returns
vector<string> Vector of routing point ParmConatiner IDs

◆ GetMainRoutingPtCoord()

vec3d vsp::GetMainRoutingPtCoord ( const string & pt_id)
extern

Get the main coordinate location a routing point. The main location is the location of the base copy before symmetry has been applied.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
Update();
vec3d p1 = GetMainRoutingPtCoord(rpt1);
vec3d
Definition Vec3d.h:243
vsp::GetMainRoutingPtCoord
vec3d GetMainRoutingPtCoord(const string &pt_id)
See also
AddRoutingPt, DelRoutingPt, GetRoutingPtCoord, GetAllRoutingPtCoords, GetRoutingCurve
Parameters
[in]pt_idstring ParmContainer ID of desired routing point
Returns
vec3d coordinate of main routing point

◆ GetNumRoutingPts()

int vsp::GetNumRoutingPts ( const string & routing_id)
extern

Get the number of routing points in a RoutingGeom

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
int npt = GetNumRoutingPts(routing_geom);
vsp::GetNumRoutingPts
int GetNumRoutingPts(const string &routing_id)
See also
AddRoutingPt, DelRoutingPt
Parameters
[in]routing_idstring RoutingGeom Geom ID
Returns
int Number of routing points in specified RoutingGeom

◆ GetRoutingCurve()

vector< vec3d > vsp::GetRoutingCurve ( const string & routing_id,
int symm_index )
extern

Get points along a RoutingGeom. These points will follow the curve of a RoutingGeom with radiused routing points. The main copy is symm_index = 0.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
Update();
array<vec3d> pvec = GetRoutingCurve(routing_geom, 0);
vsp::GetRoutingCurve
vector< vec3d > GetRoutingCurve(const string &routing_id, int symm_index)
See also
AddRoutingPt, DelRoutingPt, GetMainRoutingPtCoord, GetRoutingPtCoord, GetAllRoutingPtCoords
Parameters
[in]routing_idstring RoutingGeom Geom ID
[in]symm_indexint Symmetry index to get coordinate of
Returns
vector < vec3d > coordinate of points along RoutingGeom curve

◆ GetRoutingPtCoord()

vec3d vsp::GetRoutingPtCoord ( const string & routing_id,
int index,
int symm_index )
extern

Get the coordinate location a routing point in a RoutingGeom. The main location is symm_index = 0.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
Update();
vec3d p1 = GetRoutingPtCoord(routing_geom, 1, 0);
vsp::GetRoutingPtCoord
vec3d GetRoutingPtCoord(const string &routing_id, int index, int symm_index)
See also
AddRoutingPt, DelRoutingPt, GetMainRoutingPtCoord, GetAllRoutingPtCoords, GetRoutingCurve
Parameters
[in]routing_idstring RoutingGeom Geom ID
[in]indexint Index of routing point to get cordinate of
[in]symm_indexint Symmetry index to get coordinate of
Returns
vec3d coordinate of routing point

◆ GetRoutingPtID()

string vsp::GetRoutingPtID ( const string & routing_id,
int index )
extern

Get the ParmContainer ID of a routing point within a RoutingGeom.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
string rid = GetRoutingPtID(routing_geom, 2);
vsp::GetRoutingPtID
string GetRoutingPtID(const string &routing_id, int index)
See also
AddRoutingPt, DelAllRoutingPt, GetAllRoutingPtIds
Parameters
[in]routing_idstring RoutingGeom Geom ID
[in]indexint Index of routing point to ID to retreive
Returns
string ParmContainer ID for the specified routing point

◆ GetRoutingPtParentID()

string vsp::GetRoutingPtParentID ( const string & pt_id)
extern

Get the Geom ID of the geom a routing point is anchored to.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
string gid = GetRoutingPtParentID(rpt1);
vsp::GetRoutingPtParentID
string GetRoutingPtParentID(const string &pt_id)
See also
AddRoutingPt, DelAllRoutingPt, GetAllRoutingPtIds
Parameters
[in]pt_idstring ParmContainer ID of desired routing point
Returns
string Geom ID for the geom the routing point is anchored to

◆ InsertRoutingPt()

string vsp::InsertRoutingPt ( const string & routing_id,
int index,
const string & geom_id,
int surf_index )
extern

Add a routing point to a RoutingGeom. The new point will be inserted before the specified index. The new point will be anchored to the specified geom and surface.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
int npt = GetNumRoutingPts(routing_geom);
string rptPre2 = InsertRoutingPt(routing_geom, 2, pod2, 0);
string uPre2 = GetParm( rptPre2, "U", "RoutePt");
SetParmVal(uPre2, 0.);
vsp::InsertRoutingPt
string InsertRoutingPt(const string &routing_id, int index, const string &geom_id, int surf_index)
See also
AddRoutingPt, DelRoutingPt
Parameters
[in]routing_idstring RoutingGeom Geom ID
[in]indexint Index of routing point to insert new point before
[in]geom_idstring Geom ID of geom to anchor new routing point to
[in]surf_indexint Index of surf to anchor new routing point to
Returns
string ParmContainer ID for the newly added routing point

◆ MoveRoutingPt()

int vsp::MoveRoutingPt ( const string & routing_id,
int index,
int reorder_type )
extern

Move a specified routing point within the route of a RoutingGeom.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
int newindx = MoveRoutingPt( routing_geom, 1, REORDER_MOVE_DOWN );
vsp::REORDER_MOVE_DOWN
@ REORDER_MOVE_DOWN
Definition APIDefines.h:1326
vsp::MoveRoutingPt
int MoveRoutingPt(const string &routing_id, int index, int reorder_type)
See also
AddRoutingPt, DelRoutingPt, REORDER_TYPE
Parameters
[in]routing_idstring RoutingGeom Geom ID
[in]indexint Index of routing point to move
[in]reorder_typeint Enum specifying reordering type (i.e. REORDER_MOVE_UP, REORDER_MOVE_DOWN, REORDER_MOVE_TOP, REORDER_MOVE_BOTTOM)

◆ SetRoutingPtParentID()

void vsp::SetRoutingPtParentID ( const string & pt_id,
const string & parent_id )
extern

Set the Geom ID of the geom a routing point is anchored to.

string pod1 = AddGeom("POD", "");
string pod2 = AddGeom("POD", "");
string ypod2 = GetParm(pod2, "Y_Rel_Location", "XForm");
SetParmVal(ypod2, 2.0);
string routing_geom = AddGeom("ROUTING", "");
string rpt0 = AddRoutingPt(routing_geom, pod1, 0);
string u0 = GetParm( rpt0, "U", "RoutePt");
SetParmVal(u0, 0.0);
string rpt1 = AddRoutingPt(routing_geom, pod2, 0);
string rpt2 = AddRoutingPt(routing_geom, pod1, 0);
string u2 = GetParm( rpt2, "U", "RoutePt");
SetParmVal(u2, 1.0);
SetRoutingPtParentID(rpt1, pod1);
vsp::SetRoutingPtParentID
void SetRoutingPtParentID(const string &pt_id, const string &parent_id)
See also
AddRoutingPt, DelAllRoutingPt, GetAllRoutingPtIds
Parameters
[in]pt_idstring ParmContainer ID of desired routing point
[in]parent_idstring Geom ID for the geom to anchor the routing point to
Generated on for OpenVSP API Documentation by doxygen 1.17.0