Geom Functions

This group of functions is available for adding, deleting, and modifying OpenVSP Geoms through the API. Click here to return to the main page. More...

Functions
void	vsp::SetGeomMaterialName (const std::string &geom_id, const std::string &name)
std::vector< std::string >	vsp::GetGeomTypes ()
std::string	vsp::AddGeom (const std::string &type, const std::string &parent=std::string())
void	vsp::UpdateGeom (const std::string &geom_id)
void	vsp::DeleteGeom (const std::string &geom_id, int clone_delete=CLONE_DELETE_LEAVE_EMPTY)
void	vsp::DeleteGeomVec (const std::vector< std::string > &del_vec, int clone_delete=CLONE_DELETE_LEAVE_EMPTY)
void	vsp::CutGeomToClipboard (const std::string &geom_id, int clone_delete=CLONE_DELETE_LEAVE_EMPTY)
void	vsp::CopyGeomToClipboard (const std::string &geom_id)
std::vector< std::string >	vsp::PasteGeomClipboard (const std::string &parent=std::string())
std::string	vsp::ConvertFuselageToStack (const std::string &geom_id)
std::vector< std::string >	vsp::FindGeoms ()
std::vector< std::string >	vsp::FindGeomsWithName (const std::string &name)
std::string	vsp::FindGeom (const std::string &name, int index)
void	vsp::SetGeomName (const std::string &geom_id, const std::string &name)
std::string	vsp::GetGeomName (const std::string &geom_id)
void	vsp::SetGeomCloneOriginal (const std::string &clone_id, const std::string &original_id)
std::string	vsp::GetGeomCloneOriginal (const std::string &clone_id)
std::vector< std::string >	vsp::CloneGeomVec (const std::vector< std::string > &geom_id_vec, const std::string &name_suffix="_Clone")
void	vsp::SetGeomCloneNameSuffix (const std::string &clone_id, const std::string &name_suffix)
std::string	vsp::GetGeomCloneNameSuffix (const std::string &clone_id)
std::string	vsp::ReplaceCloneGeom (const std::string &clone_id)
std::vector< std::string >	vsp::FindGeomClones (const std::vector< std::string > &geom_id_vec)
std::vector< std::string >	vsp::GetGeomParmIDs (const std::string &geom_id)
std::string	vsp::GetGeomTypeName (const std::string &geom_id)
void	vsp::SetGeomParent (const std::string &geom_id, const std::string &parent_id)
void	vsp::ReorderGeom (const std::string &geom_id, int reorder_type)
std::string	vsp::AttachGeomTexture (const std::string &geom_id, const std::string &file_name)
void	vsp::RemoveGeomTexture (const std::string &geom_id, const std::string &texture_id)
std::vector< std::string >	vsp::GetGeomTextureIDVec (const std::string &geom_id)
std::string	vsp::GetGeomTextureFileName (const std::string &geom_id, const std::string &texture_id)
std::string	vsp::GetGeomParent (const std::string &geom_id)
std::string	vsp::GetGeomSymAncestorID (const std::string &geom_id)
std::string	vsp::GetGeomIncorporatedAncestorID (const std::string &geom_id)
void	vsp::SetGeomSymAncestorID (const std::string &geom_id, const std::string &ancestor_id)
void	vsp::SetGeomIncorporatedAncestorID (const std::string &geom_id, const std::string &ancestor_id)
std::vector< std::string >	vsp::GetGeomChildren (const std::string &geom_id)
int	vsp::GetNumMainSurfs (const std::string &geom_id)
int	vsp::GetTotalNumSurfs (const std::string &geom_id)
int	vsp::GetGeomVSPSurfType (const std::string &geom_id, int main_surf_ind=0)
int	vsp::GetGeomVSPSurfCfdType (const std::string &geom_id, int main_surf_ind=0)
vec3d	vsp::GetGeomBBoxMax (const std::string &geom_id, int main_surf_ind=0, bool ref_frame_is_absolute=true)
vec3d	vsp::GetGeomBBoxMin (const std::string &geom_id, int main_surf_ind=0, bool ref_frame_is_absolute=true)
void	vsp::SplitWingXSec (const std::string &wing_id, int section_index)
std::vector< int >	vsp::GetDriverGroup (const std::string &geom_id, int section_index)
void	vsp::ResetPropellerThickness (const std::string &geom_id)
void	vsp::CopyAirfoil (const std::string &geom_id, int index)
void	vsp::PasteAirfoil (const std::string &geom_id, int index)
void	vsp::ClearSkinning (const std::string &geom_id, int index=-1)
void	vsp::ResetGeomScale (const std::string &geom_id)
void	vsp::AcceptGeomScale (const std::string &geom_id)
std::vector< vec3d >	vsp::GetPtCloudPnts (const std::string &geom_id)
std::string	vsp::CreateNGonMeshGeom (const std::string &geom_id)
std::string	vsp::CreateConvexHull (const std::string &geom_id)
void	vsp::ProjectPtCloudPts (const std::string &geom_id, const std::string &target_geom_id, int surf_index, int dir_index)

Detailed Description

Function Documentation

AcceptGeomScale()

void vsp::AcceptGeomScale ( const std::string & geom_id )

extern

Turn a MeshGeom into a Point Cloud Geom made of its mesh nodes. This is the Mesh screen's Convert to Point Cloud button.

string pid = AddGeom( "POD" );
 
string mesh_id = ExportFile( "Example_Mesh.msh", SET_ALL, EXPORT_GMSH );
 
string cloud_id = CreatePtCloudGeom( mesh_id );
 
if ( cloud_id.length() == 0 || GetGeomTypeName( cloud_id ) != "PtCloud" )
{
    Print( "ERROR: CreatePtCloudGeom did not make a point cloud" );
    __failure++;
}
 
// A Geom that is not a mesh has to be rejected.
CreatePtCloudGeom( pid );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: CreatePtCloudGeom accepted a Geom that is not a mesh" );
    __failure++;
}
 
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

CreateNGonMeshGeom, CreateConvexHull

Parameters

[in]

geom_id

string MeshGeom ID

Returns

string Point Cloud Geom ID

Keep a Geom's scaled size and reset the scale factor to one, folding the scaling into the Geom's own dimensions. This is the Scale tab's Accept button.

string pid = AddGeom( "POD" );
 
Update();
 
vec3d before_max = GetGeomBBoxMax( pid, 0, false );
 
SetParmValUpdate( pid, "Scale", "XForm", 2.0 );
 
Update();
 
AcceptGeomScale( pid );
 
Update();
 
// The scale factor comes back to one but the size it produced is kept.
if ( !closeTo( GetParmVal( pid, "Scale", "XForm" ), 1.0, 1e-9 ) )
{
    Print( "ERROR: AcceptGeomScale did not reset the scale factor" );
    __failure++;
}
 
vec3d after_max = GetGeomBBoxMax( pid, 0, false );
 
if ( !closeTo( after_max.x(), 2.0 * before_max.x(), 1e-6 ) )
{
    Print( "ERROR: AcceptGeomScale did not keep the scaled size" );
    __failure++;
}

See also

ResetGeomScale

Parameters

[in]

geom_id

string Geom ID

Here is the call graph for this function:

Here is the caller graph for this function:

AddGeom()

std::string vsp::AddGeom ( const std::string & type, const std::string & parent = std::string() )

extern

Add a new Geom of given type as a child of the specified parent. If no parent or an invalid parent is given, the Geom is placed at the top level

//==== Add Wing Geometry ====//
string wing_id = AddGeom( "WING" );
 
if ( wing_id.length() == 0 || wing_id == "NONE" )
{
    Print( "ERROR: AddGeom returned no id" );
    __failure++;
}

Parameters

[in]	type	string Geom type (i.e FUSELAGE, POD, etc.)
[in]	parent	string Parent Geom ID

Returns

string Geom ID

Here is the call graph for this function:

Here is the caller graph for this function:

AttachGeomTexture()

std::string vsp::AttachGeomTexture ( const std::string & geom_id, const std::string & file_name )

extern

Attach a texture image to a Geom, the way the Add button on the Texture screen does. A texture is drawn on the Geom's surface at a placement given by its Parms; the returned ID is a ParmContainer ID, so U, W, U_Scale, W_Scale, Transparency, U_Flip and W_Flip in the "Texture_Parm" group are reached the usual way.

string pod_id = AddGeom( "POD", "" );
 
string tex_id = AttachGeomTexture( pod_id, "textures/nasa-logo.tga" );
 
if ( tex_id.length() == 0 )
{
    Print( "ERROR: AttachGeomTexture attached nothing" );
    __failure++;
}
 
// Place the logo on the upper surface, at half size.
SetParmVal( tex_id, "U", "Texture_Parm", 0.35 );
SetParmVal( tex_id, "W", "Texture_Parm", 0.25 );
SetParmVal( tex_id, "U_Scale", "Texture_Parm", 0.5 );
SetParmVal( tex_id, "W_Scale", "Texture_Parm", 0.5 );
 
Update();
 
array< string > @tex_ids = GetGeomTextureIDVec( pod_id );
 
if ( tex_ids.size() != 1 || tex_ids[0] != tex_id )
{
    Print( "ERROR: the texture is not in the texture list" );
    __failure++;
}

See also

RemoveGeomTexture, GetGeomTextureIDVec, GetGeomTextureFileName

Parameters

[in]	geom_id	string Geom ID
[in]	file_name	string Name of the texture image file

Returns

string ParmContainer ID for the attached texture

Here is the call graph for this function:

Here is the caller graph for this function:

ClearSkinning()

void vsp::ClearSkinning ( const std::string & geom_id, int index = -1 )

extern

Clear the skinning of one cross section, or of every cross section when the index is left at -1. This is the Skinning tab's Clear and Clear All buttons. A Geom whose cross sections are not skinned, or an index past the last cross section, is an error.

string sid = AddGeom( "STACK", "" );
 
string xsec_surf = GetXSecSurf( sid, 0 );
 
string xsec = GetXSec( xsec_surf, 1 );
 
SetXSecTanAngles( xsec, XSEC_BOTH_SIDES, 15.0 );
 
Update();
 
if ( !closeTo( GetParmVal( GetXSecParm( xsec, "TopLAngleSet" ) ), 1.0, 1e-12 ) )
{
    Print( "ERROR: the skinning was never set" );
    __failure++;
}
 
ClearSkinning( sid, 1 );
 
Update();
 
// Clearing releases the section's skinning controls and puts symmetry back
// on; the angle itself becomes whatever the skin solves for.
if ( !closeTo( GetParmVal( GetXSecParm( xsec, "TopLAngleSet" ) ), 0.0, 1e-12 ) ||
     !closeTo( GetParmVal( GetXSecParm( xsec, "AllSym" ) ), 1.0, 1e-12 ) )
{
    Print( "ERROR: ClearSkinning did not release the section" );
    __failure++;
}
 
// A Geom with no cross sections has to be rejected.
string pid = AddGeom( "POD" );
 
ClearSkinning( pid );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: ClearSkinning accepted a Geom with no cross sections" );
    __failure++;
}
 
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

ResetXSecSkinParms, ClearSkinningByID

Parameters

[in]	geom_id	string Geom ID
[in]	index	int Cross section index, or -1 for every section

Here is the call graph for this function:

Here is the caller graph for this function:

CloneGeomVec()

std::vector< std::string > vsp::CloneGeomVec ( const std::vector< std::string > & geom_id_vec, const std::string & name_suffix = "_Clone" )

extern

Make a Clone Geom of each Geom in a group, keeping the hierarchy among them. The top Clone of each hierarchy is a sibling of its original, starts at the original's placement, and has CloneXForm off so it can be moved. The Clones below it have CloneXForm on, so they keep their originals' relative placement. The Clones are returned in model hierarchy order, not the order passed in; use GetGeomCloneOriginal to match them up.

string pod = AddGeom( "POD" );
 
string wing = AddGeom( "WING", pod );
 
Update();
 
//==== Clone both at once ====//
array< string > group;
group.push_back( pod );
group.push_back( wing );
 
array< string > clones = CloneGeomVec( group );
 
if ( clones.size() != 2 )
{
    Print( "ERROR: CloneGeomVec did not make a Clone of each Geom" );
    __failure++;
}
 
//==== Match each Clone to its original ====//
string pod_clone;
string wing_clone;
 
for ( int i = 0; i < int( clones.size() ); i++ )
{
    if ( GetGeomCloneOriginal( clones[i] ) == pod )
    {
        pod_clone = clones[i];
    }
    else if ( GetGeomCloneOriginal( clones[i] ) == wing )
    {
        wing_clone = clones[i];
    }
}
 
if ( pod_clone == "" || wing_clone == "" )
{
    Print( "ERROR: CloneGeomVec did not make a Clone of each Geom" );
    __failure++;
}
 
//==== The hierarchy is kept ====//
if ( GetGeomParent( wing_clone ) != pod_clone )
{
    Print( "ERROR: CloneGeomVec did not keep the hierarchy" );
    __failure++;
}
 
//==== The pod's Clone sits beside the pod, not under it ====//
if ( GetGeomParent( pod_clone ) != GetGeomParent( pod ) )
{
    Print( "ERROR: CloneGeomVec did not put the top of the group beside the original" );
    __failure++;
}
 
//==== Only the top Clone places itself ====//
if ( GetParmVal( FindParm( pod_clone, "CloneXForm", "Behavior" ) ) != 0.0 )
{
    Print( "ERROR: CloneGeomVec did not leave the top of the group free to be placed" );
    __failure++;
}
 
if ( GetParmVal( FindParm( wing_clone, "CloneXForm", "Behavior" ) ) != 1.0 )
{
    Print( "ERROR: CloneGeomVec did not have the rest of the group copy its placement" );
    __failure++;
}

See also

SetGeomCloneOriginal, SetGeomCloneNameSuffix

Parameters

[in]	geom_id_vec	vector<string> Vector of Geom IDs to clone
[in]	name_suffix	string Suffix automatic naming appends to each original's name

Returns

vector<string> Vector of the new Clone Geom IDs

Here is the call graph for this function:

Here is the caller graph for this function:

ConvertFuselageToStack()

std::string vsp::ConvertFuselageToStack ( const std::string & geom_id )

extern

Replace a Fuselage with a Stack of the same shape. Each cross section is placed where the Fuselage put it, and its skinning is carried across, so the surface is unchanged. The Stack goes in the Fuselage's place in the model, under its name, with its children, subsurfaces, structures, mesh sources, textures and attributes.

The Stack takes over the Fuselage's identity: its Geom ID, the IDs of the Parms the two have in common, and the IDs of each cross section and its Parms. A link, a design variable or an advanced link on one of those Parms goes on naming the same thing, and the ID this returns is the ID that was passed in. Some Parms are paired with a counterpart that means something different: a cross section's rotation, which in a Stack is relative to the section before it, and its location fractions, which become the Stack's X, Y and Z deltas – lengths, and relative ones. Only the Fuselage's length has no counterpart at all; attributes on it, or on a cross section's copy of it, move to the Stack itself. Attributes elsewhere – on the Geom, a cross section, a subsurface, a Parm – stay with the ID they were on.

CompareGeomSurfaces measures how closely the Stack's surfaces match a copy of the Fuselage kept for the purpose.

//==== A Fuselage rotated about a point along its length, with a Pod hung off it ====//
string fid = AddGeom( "FUSELAGE" );
SetParmVal( FindParm( fid, "Origin", "XForm" ), 0.4 );
SetParmVal( FindParm( fid, "Y_Rel_Rotation", "XForm" ), 8.0 );
 
string pid = AddGeom( "POD", fid );
SetParmVal( FindParm( pid, "X_Rel_Location", "XForm" ), 6.0 );
 
Update();
 
vec3d before = CompPnt01( fid, 0, 0.3, 0.2 );
vec3d pod_before = CompPnt01( pid, 0, 0.5, 0.5 );
 
//==== Convert it ====//
string sid = ConvertFuselageToStack( fid );
 
if ( GetErrorLastCallFlag() )               { Print( "---> Error: API ConvertFuselageToStack reported an error " ); __failure++; }
 
Update();
 
if ( sid != fid )                           { Print( "---> Error: API ConvertFuselageToStack did not keep the ID " ); __failure++; }
 
if ( GetGeomTypeName( sid ) != "Stack" )    { Print( "---> Error: API ConvertFuselageToStack did not make a Stack " ); __failure++; }
 
//==== The surface is where it was, and so is the Pod ====//
if ( dist( before, CompPnt01( sid, 0, 0.3, 0.2 ) ) > 1e-9 )      { Print( "---> Error: API ConvertFuselageToStack moved the surface " ); __failure++; }
 
if ( dist( pod_before, CompPnt01( pid, 0, 0.5, 0.5 ) ) > 1e-9 )  { Print( "---> Error: API ConvertFuselageToStack moved a child " ); __failure++; }

Parameters

[in]

geom_id

string Fuselage Geom ID

Returns

string ID of the Stack, which is the Fuselage's own ID

Here is the call graph for this function:

Here is the caller graph for this function:

CopyAirfoil()

void vsp::CopyAirfoil ( const std::string & geom_id, int index )

extern

Link two Parms so that changing the first drives the second. This is the simple Parm Link the Link screen builds, not an Advanced Link. The link is created with its offset active and set to the difference between the two Parms, so B follows A while holding its current separation.

string pod1 = AddGeom( "POD", "" );
string pod2 = AddGeom( "POD", "" );
 
string xa = GetParm( pod1, "X_Rel_Location", "XForm" );
string xb = GetParm( pod2, "X_Rel_Location", "XForm" );
 
SetParmVal( xb, 3.0 );
 
Update();
 
string link_id = AddParmLink( xa, xb );
 
if ( link_id.length() == 0 )
{
    Print( "ERROR: AddParmLink returned no id" );
    __failure++;
}
 
if ( GetNumParmLinks() != 1 || GetParmLinkID( 0 ) != link_id )
{
    Print( "ERROR: AddParmLink did not add the link" );
    __failure++;
}
 
// The link drives B from A, holding the three unit offset it started with.
SetParmValUpdate( xa, 5.0 );
 
Update();
 
if ( !closeTo( GetParmVal( xb ), 8.0, 1e-6 ) )
{
    Print( "ERROR: the parm link did not drive its output" );
    __failure++;
}
 
// Linking the same pair twice has to be refused.
AddParmLink( xa, xb );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: AddParmLink accepted a duplicate link" );
    __failure++;
}
 
// That error was raised deliberately, so take it back off the queue.
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

GetNumParmLinks, GetParmLinkID, DelParmLink, DelAllParmLinks, AddAdvLink

Parameters

[in]	parm_a_id	string Parm ID of the driving Parm
[in]	parm_b_id	string Parm ID of the driven Parm

Returns

string Parm Link ID

Copy the airfoil of a wing section to the airfoil clipboard. This is a separate clipboard from the one CopyXSec uses, so an airfoil can be moved without carrying the section geometry with it.

string wid = AddGeom( "WING" );
 
// Give section 1 a distinctive airfoil.
string xsec_surf = GetXSecSurf( wid, 0 );
 
ChangeXSecShape( xsec_surf, 1, XS_SIX_SERIES );
 
Update();
 
CopyAirfoil( wid, 1 );
 
PasteAirfoil( wid, 0 );
 
// The airfoil travels; the section geometry does not.
if ( GetXSecShape( GetXSec( xsec_surf, 0 ) ) != XS_SIX_SERIES )
{
    Print( "ERROR: the airfoil did not paste" );
    __failure++;
}
 
// A Geom that is not a wing has to be rejected.
string pid = AddGeom( "POD" );
 
CopyAirfoil( pid, 0 );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: CopyAirfoil accepted a Geom that is not a wing" );
    __failure++;
}
 
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

PasteAirfoil, CopyXSec, CopyAirfoilByID

Parameters

[in]	geom_id	string Wing Geom ID
[in]	index	int Wing section index

Here is the call graph for this function:

Here is the caller graph for this function:

CopyGeomToClipboard()

void vsp::CopyGeomToClipboard ( const std::string & geom_id )

extern

Copy Geom from current location and store on clipboard

//==== Add Pod Geometries ====//
string pid1 = AddGeom( "POD", "" );
string pid2 = AddGeom( "POD", "" );
 
CopyGeomToClipboard( pid1 );
 
PasteGeomClipboard( pid2 ); // Paste Pod 1 as child of Pod 2
 
array< string > @geom_ids = FindGeoms();
 
if ( geom_ids.size() != 3 )                { Print( "---> Error: API Copy/Paste Geom  " ); __failure++; }

See also

PasteGeomClipboard

Parameters

[in]

geom_id

string Geom ID

Here is the call graph for this function:

Here is the caller graph for this function:

CreateConvexHull()

std::string vsp::CreateConvexHull ( const std::string & geom_id )

extern

Build the convex hull of a Point Cloud Geom. The hull arrives as a new MeshGeom; the point cloud itself is left alone. This is the Point Cloud screen's Convex Hull button.

string pid = AddGeom( "POD" );
 
string mesh_id = ExportFile( "Example_Mesh.msh", SET_ALL, EXPORT_GMSH );
 
string cloud_id = CreatePtCloudGeom( mesh_id );
 
int num_pnts = GetPtCloudPnts( cloud_id ).size();
 
string hull_id = CreateConvexHull( cloud_id );
 
Update();
 
// The hull is a mesh of its own, and the cloud it came from is untouched.
if ( hull_id.length() == 0 || GetGeomTypeName( hull_id ) != "Mesh" )
{
    Print( "ERROR: CreateConvexHull did not make a hull mesh" );
    __failure++;
}
 
if ( int( GetPtCloudPnts( cloud_id ).size() ) != num_pnts )
{
    Print( "ERROR: CreateConvexHull disturbed the point cloud" );
    __failure++;
}
 
// A Geom that is not a point cloud has to be rejected.
CreateConvexHull( pid );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: CreateConvexHull accepted a Geom that is not a point cloud" );
    __failure++;
}
 
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

CreatePtCloudGeom, GetPtCloudPnts

Parameters

[in]

geom_id

string Point Cloud Geom ID

Returns

string MeshGeom ID of the hull

Here is the call graph for this function:

Here is the caller graph for this function:

CreateNGonMeshGeom()

std::string vsp::CreateNGonMeshGeom ( const std::string & geom_id )

extern

Turn a MeshGeom into an NGon Mesh Geom. This is the Mesh screen's Convert to NGon Mesh button.

string pid = AddGeom( "POD" );
 
string mesh_id = ExportFile( "Example_Mesh.msh", SET_ALL, EXPORT_GMSH );
 
string ngon_id = CreateNGonMeshGeom( mesh_id );
 
if ( ngon_id.length() == 0 || GetGeomTypeName( ngon_id ) != "NGonMesh" )
{
    Print( "ERROR: CreateNGonMeshGeom did not make an NGon mesh" );
    __failure++;
}
 
// A Geom that is not a mesh has to be rejected.
CreateNGonMeshGeom( pid );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: CreateNGonMeshGeom accepted a Geom that is not a mesh" );
    __failure++;
}
 
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

CreatePtCloudGeom

Parameters

[in]

geom_id

string MeshGeom ID

Returns

string NGon Mesh Geom ID

Here is the call graph for this function:

Here is the caller graph for this function:

CutGeomToClipboard()

void vsp::CutGeomToClipboard ( const std::string & geom_id, int clone_delete = CLONE_DELETE_LEAVE_EMPTY )

extern

Cut Geom from current location and store on clipboard. A pasted Geom is a new Geom, so clone_delete applies to each Clone of the cut Geom, as for DeleteGeom. A Clone cut along with it is pasted as a Clone of the pasted Geom.

//==== Add Pod Geometries ====//
string pid1 = AddGeom( "POD", "" );
string pid2 = AddGeom( "POD", "" );
 
CutGeomToClipboard( pid1 );
 
PasteGeomClipboard( pid2 ); // Paste Pod 1 as child of Pod 2
 
array< string > @geom_ids = FindGeoms();
 
if ( geom_ids.size() != 2 )                { Print( "---> Error: API Cut/Paste Geom  " ); __failure++; }
 
//==== Cutting a Geom replaces its Clone with a real Geom ====//
string pid3 = AddGeom( "POD", "" );
array< string > one;
one.push_back( pid3 );
string clone_id = CloneGeomVec( one )[0];
 
CutGeomToClipboard( pid3, CLONE_DELETE_REPLACE );
 
if ( GetGeomTypeName( clone_id ) != "Pod" )   { Print( "---> Error: CutGeomToClipboard did not replace the Clone" ); __failure++; }

See also

PasteGeomClipboard, FindGeomClones, CLONE_DELETE_TYPE

Parameters

[in]	geom_id	string Geom ID
[in]	clone_delete	int What becomes of each Clone of the Geom (CLONE_DELETE_TYPE)

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteGeom()

void vsp::DeleteGeom ( const std::string & geom_id, int clone_delete = CLONE_DELETE_LEAVE_EMPTY )

extern

Delete a particular Geom. clone_delete says what becomes of each Clone of it. By default each is left empty and VSP_CLONE_ORIGINAL_LOST is reported for it. FindGeomClones lists them beforehand.

//==== Add Wing Geometry ====//
string wing_id = AddGeom( "WING" );
 
//==== Add Pod Geometry ====//
string pod_id = AddGeom( "POD" );
 
int num_before_del = FindGeoms().length();
DeleteGeom( wing_id );
if ( FindGeoms().length() >= num_before_del )
{
    Print( "ERROR: DeleteGeom removed nothing" );
    __failure++;
}
 
//==== A Clone of a deleted Geom is left empty and reported ====//
array< string > one;
one.push_back( pod_id );
string clone_id = CloneGeomVec( one )[0];
 
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}
 
DeleteGeom( pod_id );
 
if ( GetGeomCloneOriginal( clone_id ) != "" )
{
    Print( "ERROR: DeleteGeom left the Clone an original" );
    __failure++;
}
 
bool lost = false;
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
    if ( err.GetErrorCode() == VSP_CLONE_ORIGINAL_LOST )
    {
        lost = true;
    }
}
if ( !lost )
{
    Print( "ERROR: DeleteGeom did not report the emptied Clone" );
    __failure++;
}

See also

FindGeomClones, CLONE_DELETE_TYPE

Parameters

[in]	geom_id	string Geom ID
[in]	clone_delete	int What becomes of each Clone of the Geom (CLONE_DELETE_TYPE)

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteGeomVec()

void vsp::DeleteGeomVec ( const std::vector< std::string > & del_vec, int clone_delete = CLONE_DELETE_LEAVE_EMPTY )

extern

Delete multiple Geoms. clone_delete applies to each Clone of them that is not itself being deleted, as for DeleteGeom.

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD", "" );
 
string rid = ExecAnalysis( "CompGeom" );
 
array<string>@ mesh_id_vec = GetStringResults( rid, "Mesh_GeomID" );
 
int num_before_del = FindGeoms().length();
DeleteGeomVec( mesh_id_vec );
if ( FindGeoms().length() >= num_before_del )
{
    Print( "ERROR: DeleteGeomVec removed nothing" );
    __failure++;
}
 
//==== Delete a Geom and its Clones together ====//
array< string > one;
one.push_back( pid );
string clone_id = CloneGeomVec( one )[0];
 
DeleteGeomVec( one, CLONE_DELETE_WITH_ORIGINAL );
 
if ( FindGeoms().find( clone_id ) >= 0 )
{
    Print( "ERROR: DeleteGeomVec left the Clone behind" );
    __failure++;
}

See also

FindGeomClones, CLONE_DELETE_TYPE

Parameters

[in]	del_vec	vector<string> Vector of Geom IDs
[in]	clone_delete	int What becomes of each Clone of those Geoms (CLONE_DELETE_TYPE)

Here is the call graph for this function:

Here is the caller graph for this function:

FindGeom()

std::string vsp::FindGeom ( const std::string & name, int index )

extern

Find and return the Geom ID with the specified name at given index. Equivalent to FindGeomsWithName( name )[index].

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD", "" );
 
SetGeomName( pid, "ExamplePodName" );
 
string geom_id = FindGeom( "ExamplePodName", 0 );
 
array< string > @geom_ids = FindGeomsWithName( "ExamplePodName" );
 
if ( geom_ids[0] != geom_id )
{
    Print( "---> Error: API FindGeom & FindGeomsWithName" );
    __failure++;
}

See also

FindGeomsWithName

Parameters

[in]	name	string Geom name
[in]	index

Returns

string Geom ID with name at specified index

Here is the call graph for this function:

Here is the caller graph for this function:

FindGeomClones()

std::vector< std::string > vsp::FindGeomClones ( const std::vector< std::string > & geom_id_vec )

extern

Find the Clones of a group of Geoms that are not in the group themselves – the ones a delete or cut of the group would leave empty. Clones of these Clones are not returned, though CLONE_DELETE_WITH_ORIGINAL deletes them too.

string pod = AddGeom( "POD" );
 
Update();
 
array< string > group;
group.push_back( pod );
 
array< string > clones = CloneGeomVec( group );
 
//==== The pod's Clone is found ====//
array< string > @found = FindGeomClones( group );
 
if ( found.size() != 1 || found[0] != clones[0] )
{
    Print( "ERROR: FindGeomClones did not find the Clone of the pod" );
    __failure++;
}
 
//==== A Clone in the group is not returned ====//
group.push_back( clones[0] );
 
if ( FindGeomClones( group ).size() != 0 )
{
    Print( "ERROR: FindGeomClones found a Clone that is going too" );
    __failure++;
}
 
//==== Delete the pod, replacing its Clone ====//
DeleteGeom( pod, CLONE_DELETE_REPLACE );
 
if ( GetGeomTypeName( clones[0] ) != "Pod" )
{
    Print( "ERROR: DeleteGeom did not replace the Clone" );
    __failure++;
}

See also

DeleteGeom, DeleteGeomVec, CutGeomToClipboard, CLONE_DELETE_TYPE

Parameters

[in]

geom_id_vec

vector<string> Vector of Geom IDs

Returns

vector<string> IDs of the Clones of those Geoms that are not among them

Here is the call graph for this function:

Here is the caller graph for this function:

FindGeoms()

std::vector< std::string > vsp::FindGeoms ( )

extern

Find and return all Geom IDs in the model

//==== Add Pod Geometries ====//
string pod1 = AddGeom( "POD", "" );
string pod2 = AddGeom( "POD", "" );
 
//==== There Should Be Two Geoms =====//
array< string > @geom_ids = FindGeoms();
 
if ( geom_ids.size() != 2 )                        { Print( "---> Error: API FindGeoms " ); __failure++; }

Returns

vector<string> Array of all Geom IDs

Here is the call graph for this function:

Here is the caller graph for this function:

FindGeomsWithName()

std::vector< std::string > vsp::FindGeomsWithName ( const std::string & name )

extern

Find and return all Geom IDs with the specified name

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD", "" );
 
SetGeomName( pid, "ExamplePodName" );
 
array< string > @geom_ids = FindGeomsWithName( "ExamplePodName" );
 
if ( geom_ids.size() != 1 )
{
    Print( "---> Error: API FindGeomsWithName " );
    __failure++;
}

See also

FindGeom

Parameters

[in]

name

string Geom name

Returns

vector<string> Array of Geom IDs

Here is the call graph for this function:

Here is the caller graph for this function:

GetDriverGroup()

std::vector< int > vsp::GetDriverGroup ( const std::string & geom_id, int section_index )

extern

Set the driver group for a wing section or a XSecCurve. Care has to be taken when setting these driver groups to ensure a valid combination.

//==== Add Wing Geometry and Set Parms ====//
string wing_id = AddGeom( "WING", "" );
 
//==== Set Wing Section Controls ====//
SetDriverGroup( wing_id, 1, AR_WSECT_DRIVER, ROOTC_WSECT_DRIVER, TIPC_WSECT_DRIVER );
 
Update();
 
//==== Set Parms ====//
SetParmVal( wing_id, "Root_Chord", "XSec_1", 2 );
SetParmVal( wing_id, "Tip_Chord", "XSec_1", 1 );
 
Update();
 
// The three chosen drivers are the values that hold; span is now solved for
// from the aspect ratio and the two chords.
double ar = GetParmVal( wing_id, "Aspect", "XSec_1" );
double span = GetParmVal( wing_id, "Span", "XSec_1" );
 
if ( !closeTo( GetParmVal( wing_id, "Root_Chord", "XSec_1" ), 2.0, 1e-6 ) ||
     !closeTo( GetParmVal( wing_id, "Tip_Chord", "XSec_1" ), 1.0, 1e-6 ) )
{
    Print( "ERROR: the driving Parms did not hold their values" );
    __failure++;
}
 
// A section of this planform has area span * ( root + tip ) / 2, and aspect
// ratio span * span / area.
double area = span * ( 2.0 + 1.0 ) * 0.5;
 
if ( !closeTo( ar, span * span / area, 1e-6 ) )
{
    Print( "ERROR: SetDriverGroup left the section inconsistent" );
    __failure++;
}

See also

WING_DRIVERS, XSEC_DRIVERS

Parameters

[in]	geom_id	string Geom ID
[in]	section_index	int Wing section index
[in]	driver_0	int First driver enum (i.e. SPAN_WSECT_DRIVER)
[in]	driver_1	int Second driver enum (i.e. ROOTC_WSECT_DRIVER)
[in]	driver_2	int Third driver enum (i.e. TIPC_WSECT_DRIVER)

Get the driver group for a wing section or an XSec. A wing section reports three drivers; an XSecCurve reports the drivers of its own driver group.

//==== Add Wing Geometry ====//
string wing_id = AddGeom( "WING", "" );
 
SetDriverGroup( wing_id, 1, AR_WSECT_DRIVER, ROOTC_WSECT_DRIVER, TIPC_WSECT_DRIVER );
 
Update();
 
array < int > drivers = GetDriverGroup( wing_id, 1 );
 
// The drivers come back in the order they were set.
if ( drivers.size() != 3 )
{
    Print( "ERROR: GetDriverGroup did not report three wing drivers" );
    __failure++;
}
else
{
    if ( drivers[0] != AR_WSECT_DRIVER || drivers[1] != ROOTC_WSECT_DRIVER || drivers[2] != TIPC_WSECT_DRIVER )
    {
        Print( "ERROR: GetDriverGroup did not report the drivers that were set" );
        __failure++;
    }
}
 
// A section index past the end has to be rejected.
GetDriverGroup( wing_id, 100 );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: GetDriverGroup accepted a section index past the end" );
    __failure++;
}
 
// That error was raised deliberately, so take it back off the queue.
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

WING_DRIVERS, XSEC_DRIVERS, SetDriverGroup, GetDriverGroupByID

Parameters

[in]	geom_id	string Geom ID
[in]	section_index	int Wing section or XSec index

Returns

vector<int> Array of driver enums

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomBBoxMax()

vec3d vsp::GetGeomBBoxMax ( const std::string & geom_id, int main_surf_ind = 0, bool ref_frame_is_absolute = true )

extern

Get the maximum coordinate of the bounding box of a Geom with given surface index. The Geom bounding box may be specified in absolute or body reference frame.

A Geom with no surfaces – a mesh, a point cloud, a wireframe – answers out of its own bounding box, and main_surf_ind does not apply. That box is built in absolute coordinates, so the body reference frame answer is the absolute box turned back through the model matrix, which contains the geometry but is not as tight as the box a surface gives.

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD" );
 
SetParmVal( FindParm( pid, "Y_Rotation", "XForm" ), 45 );
SetParmVal( FindParm( pid, "Z_Rotation", "XForm" ), 25 );
 
Update();
 
vec3d max_pnt = GetGeomBBoxMax( pid, 0, false );
 
vec3d min_pnt = GetGeomBBoxMin( pid, 0, false );
 
if ( max_pnt.x() <= min_pnt.x() || max_pnt.y() <= min_pnt.y() || max_pnt.z() <= min_pnt.z() )
{
    Print( "ERROR: GetGeomBBoxMax is not above the minimum corner" );
    __failure++;
}

See also

GetGeomBBoxMin

Parameters

[in]	geom_id	string Geom ID
[in]	main_surf_ind	int Index of the surface of that Geom, counting symmetric copies, from 0 to GetTotalNumSurfs() - 1 (the name is kept for scripts that pass it by keyword)
[in]	ref_frame_is_absolute	bool Flag to specify absolute or body reference frame

Returns

vec3d Maximum coordinate of the bounding box

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomBBoxMin()

vec3d vsp::GetGeomBBoxMin ( const std::string & geom_id, int main_surf_ind = 0, bool ref_frame_is_absolute = true )

extern

Get the minimum coordinate of the bounding box of a Geom with given surface index. The Geom bounding box may be specified in absolute or body reference frame.

A Geom with no surfaces – a mesh, a point cloud, a wireframe – answers out of its own bounding box, and main_surf_ind does not apply. That box is built in absolute coordinates, so the body reference frame answer is the absolute box turned back through the model matrix, which contains the geometry but is not as tight as the box a surface gives.

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD" );
 
SetParmVal( FindParm( pid, "Y_Rotation", "XForm" ), 45 );
SetParmVal( FindParm( pid, "Z_Rotation", "XForm" ), 25 );
 
Update();
 
vec3d min_pnt = GetGeomBBoxMin( pid, 0, false );
 
vec3d max_pnt = GetGeomBBoxMax( pid, 0, false );
 
if ( min_pnt.x() >= max_pnt.x() || min_pnt.y() >= max_pnt.y() || min_pnt.z() >= max_pnt.z() )
{
    Print( "ERROR: GetGeomBBoxMin is not below the maximum corner" );
    __failure++;
}

See also

GetGeomBBoxMax

Parameters

[in]	geom_id	string Geom ID
[in]	main_surf_ind	int Index of the surface of that Geom, counting symmetric copies, from 0 to GetTotalNumSurfs() - 1 (the name is kept for scripts that pass it by keyword)
[in]	ref_frame_is_absolute	bool Flag to specify absolute or body reference frame

Returns

vec3d Minimum coordinate of the bounding box

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomChildren()

std::vector< std::string > vsp::GetGeomChildren ( const std::string & geom_id )

extern

Get the IDs for each child of the input parent Geom.

//==== Add Parent and Child Geometry ====//
string pod1 = AddGeom( "POD" );
 
string pod2 = AddGeom( "POD", pod1 );
 
string pod3 = AddGeom( "POD", pod2 );
 
Print( "Children of Pod #1: " );
 
array<string> children = GetGeomChildren( pod1 );
if ( children.length() == 0 )
{
    Print( "ERROR: GetGeomChildren returned nothing" );
    __failure++;
}
 
for ( int i = 0; i < int( children.size() ); i++ )
{
    Print( "\t", false );
    Print( children[i] );
}

Parameters

[in]

geom_id

string Geom ID

Returns

vector<string> Vector of child Geom IDs

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomCloneNameSuffix()

std::string vsp::GetGeomCloneNameSuffix ( const std::string & clone_id )

extern

Get the suffix automatic naming appends to the original's name. A new Clone starts with "_Clone".

//==== Add Pod Geom and a Clone of it ====//
string pod = AddGeom( "POD" );
 
string clone = AddGeom( "CLONE" );
 
SetGeomCloneOriginal( clone, pod );
 
Update();
 
if ( GetGeomCloneNameSuffix( clone ) != "_Clone" )
{
    Print( "ERROR: GetGeomCloneNameSuffix did not report the default suffix" );
    __failure++;
}

See also

SetGeomCloneNameSuffix, CloneGeomVec

Parameters

[in]

clone_id

string Clone Geom ID

Returns

string Suffix appended to the original's name

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomCloneOriginal()

std::string vsp::GetGeomCloneOriginal ( const std::string & clone_id )

extern

Get the Geom a Clone Geom is a Clone of. An empty string means the Clone has not been given one, or has been cleared.

//==== Add Pod Geom and a Clone of it, made under the Pod ====//
string pod = AddGeom( "POD" );
 
string clone = AddGeom( "CLONE", pod );
 
//==== A Clone with no original set takes its parent ====//
Update();
 
if ( GetGeomCloneOriginal( clone ) != pod )
{
    Print( "ERROR: a Clone made under a Geom did not take it as its original" );
    __failure++;
}
 
//==== Once cleared, it does not take the parent again ====//
SetGeomCloneOriginal( clone, "" );
 
Update();
 
if ( GetGeomCloneOriginal( clone ) != "" )
{
    Print( "ERROR: GetGeomCloneOriginal answered for a Clone that has none" );
    __failure++;
}
 
//==== Reports the original that was set ====//
SetGeomCloneOriginal( clone, pod );
 
Update();
 
if ( GetGeomCloneOriginal( clone ) != pod )
{
    Print( "ERROR: GetGeomCloneOriginal did not report the Geom that was set" );
    __failure++;
}
 
//==== A Geom that is not a Clone is rejected; clear the queue first ====//
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj drained = PopLastError();
}
 
GetGeomCloneOriginal( pod );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: GetGeomCloneOriginal answered for a Geom that is not a Clone" );
    __failure++;
}
 
// That error was raised deliberately, so take it back off the queue.
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

SetGeomCloneOriginal

Parameters

[in]

clone_id

string Clone Geom ID

Returns

string ID of the Geom being cloned, or an empty string if there is none

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomIncorporatedAncestorID()

std::string vsp::GetGeomIncorporatedAncestorID ( const std::string & geom_id )

extern

Get the ID of the Geom whose Parasite Drag row a Geom is incorporated into, which its IncorporatedGen Parm names by generation.

string parent_id = AddGeom( "POD" );
 
string child_id = AddGeom( "POD", parent_id );
 
SetParmVal( child_id, "IncorporatedGen", "ParasiteDragProps", 1 );
 
if ( GetGeomIncorporatedAncestorID( child_id ) != parent_id )
{
    Print( "ERROR: GetGeomIncorporatedAncestorID did not return the parent" );
    __failure++;
}

See also

GetGeomParent

Parameters

[in]

geom_id

string Geom ID

Returns

string Geom ID

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomName()

std::string vsp::GetGeomName ( const std::string & geom_id )

extern

Get the name of a specific Geom

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD", "" );
 
SetGeomName( pid, "ExamplePodName" );
 
string name_str = "Geom Name: " + GetGeomName( pid );
 
Print( name_str );
 
if ( GetGeomName( pid ) != "ExamplePodName" )
{
    Print( "ERROR: GetGeomName did not report the name that was set" );
    __failure++;
}
 
// The name is how FindGeomsWithName looks Geoms up.
array< string > @found = FindGeomsWithName( "ExamplePodName" );
 
if ( found.size() != 1 || found[0] != pid )
{
    Print( "ERROR: GetGeomName disagrees with FindGeomsWithName" );
    __failure++;
}

Parameters

[in]

geom_id

string Geom ID

Returns

string Geom name

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomParent()

std::string vsp::GetGeomParent ( const std::string & geom_id )

extern

Get the parent Geom ID for the input child Geom. "NONE" is returned if the Geom has no parent.

//==== Add Parent and Child Geometry ====//
string pod1 = AddGeom( "POD" );
 
string pod2 = AddGeom( "POD", pod1 );
 
Print( "Parent ID of Pod #2: ", false );
 
Print( GetGeomParent( pod2 ) );
 
if ( GetGeomParent( pod2 ) != pod1 )
{
    Print( "ERROR: GetGeomParent did not report the parent it was given" );
    __failure++;
}
 
// The relationship has to read the same from the other end.
array< string > @children = GetGeomChildren( pod1 );
 
if ( children.size() != 1 || children[0] != pod2 )
{
    Print( "ERROR: GetGeomParent disagrees with GetGeomChildren" );
    __failure++;
}
 
// A Geom added with no parent sits at the top level.
if ( GetGeomParent( pod1 ) != "NONE" )
{
    Print( "ERROR: GetGeomParent did not report NONE for a top level Geom" );
    __failure++;
}

Parameters

[in]

geom_id

string Geom ID

Returns

string Parent Geom ID

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomParmIDs()

std::vector< std::string > vsp::GetGeomParmIDs ( const std::string & geom_id )

extern

Get all Parm IDs associated with this Geom Parm container

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD", "" );
 
Print( string( "---> Test Get Parm Arrays" ) );
 
array< string > @parm_array = GetGeomParmIDs( pid );
 
if ( parm_array.size() < 1 )            { Print( "---> Error: API GetGeomParmIDs " ); __failure++; }

Parameters

[in]

geom_id

string Geom ID

Returns

vector<string> Array of Parm IDs

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomSymAncestorID()

std::string vsp::GetGeomSymAncestorID ( const std::string & geom_id )

extern

Get the ID of the Geom whose frame a Geom's symmetry is about, which its Sym_Ancestor Parm names by generation. An empty string means the global origin.

string parent_id = AddGeom( "POD" );
 
string child_id = AddGeom( "POD", parent_id );
 
SetParmVal( child_id, "Sym_Ancestor", "Sym", 2 );
 
if ( GetGeomSymAncestorID( child_id ) != parent_id )
{
    Print( "ERROR: GetGeomSymAncestorID did not return the parent" );
    __failure++;
}

See also

GetGeomParent

Parameters

[in]

geom_id

string Geom ID

Returns

string Geom ID, or an empty string for the global origin

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomTextureFileName()

std::string vsp::GetGeomTextureFileName ( const std::string & geom_id, const std::string & texture_id )

extern

Get the image file a texture was attached from.

string pod_id = AddGeom( "POD", "" );
 
string tex_id = AttachGeomTexture( pod_id, "textures/nasa-logo.tga" );
 
if ( GetGeomTextureFileName( pod_id, tex_id ) != "textures/nasa-logo.tga" )
{
    Print( "ERROR: GetGeomTextureFileName did not report the file" );
    __failure++;
}

See also

AttachGeomTexture

Parameters

[in]	geom_id	string Geom ID
[in]	texture_id	string Texture ParmContainer ID

Returns

string Name of the texture image file

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomTextureIDVec()

std::vector< std::string > vsp::GetGeomTextureIDVec ( const std::string & geom_id )

extern

Get the ParmContainer IDs of all the textures attached to a Geom, in the order they are drawn.

string pod_id = AddGeom( "POD", "" );
 
// A fresh Geom carries no textures.
if ( GetGeomTextureIDVec( pod_id ).size() != 0 )
{
    Print( "ERROR: a new Geom already carries textures" );
    __failure++;
}
 
AttachGeomTexture( pod_id, "textures/nasa-logo.tga" );
AttachGeomTexture( pod_id, "textures/window.tga" );
 
if ( GetGeomTextureIDVec( pod_id ).size() != 2 )
{
    Print( "ERROR: GetGeomTextureIDVec, two were attached" );
    __failure++;
}

See also

AttachGeomTexture, RemoveGeomTexture

Parameters

[in]

geom_id

string Geom ID

Returns

vector<string> Vector of texture ParmContainer IDs

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomTypeName()

std::string vsp::GetGeomTypeName ( const std::string & geom_id )

extern

Get the type name of specified Geom (i.e. FUSELAGE)

//==== Add Wing Geometry ====//
string wing_id = AddGeom( "WING" );
 
Print( "Geom Type Name: ", false );
 
Print( GetGeomTypeName( wing_id ) );
 
if ( GetGeomTypeName( wing_id ) != "Wing" )
{
    Print( "ERROR: GetGeomTypeName did not report the type that was added" );
    __failure++;
}
 
// A Geom of a different type has to report a different name.
string pod_id = AddGeom( "POD" );
 
if ( GetGeomTypeName( pod_id ) == GetGeomTypeName( wing_id ) )
{
    Print( "ERROR: GetGeomTypeName gave two types the same name" );
    __failure++;
}

Parameters

[in]

geom_id

string Geom ID

Returns

string Geom type name

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomTypes()

std::vector< std::string > vsp::GetGeomTypes ( )

extern

Get an array of all Geom types (i.e FUSELAGE, POD, etc.)

//==== Add Pod Geometries ====//
string pod1 = AddGeom( "POD", "" );
string pod2 = AddGeom( "POD", "" );
 
array< string > @type_array = GetGeomTypes();
 
if ( type_array[0] != "POD" )                { Print( "---> Error: API GetGeomTypes  " ); __failure++; }

Returns

vector<string> Array of Geom type names

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomVSPSurfCfdType()

int vsp::GetGeomVSPSurfCfdType ( const std::string & geom_id, int main_surf_ind = 0 )

extern

Get the VSP surface CFD type of the specified Geom

//==== Add Wing Geometry ====//
string wing_id = AddGeom( "WING" );
 
if ( GetGeomVSPSurfCfdType( wing_id ) != CFD_NORMAL )
{
    Print( "---> Error: API GetGeomVSPSurfCfdType " );
    __failure++;
}

See also

VSP_SURF_CFD_TYPE

Parameters

[in]	geom_id	string Geom ID
[in]	main_surf_ind	int Main surface index

Returns

int VSP surface CFD type enum (i.e. CFD_TRANSPARENT), or -1 if the Geom or index is invalid

Here is the call graph for this function:

Here is the caller graph for this function:

GetGeomVSPSurfType()

int vsp::GetGeomVSPSurfType ( const std::string & geom_id, int main_surf_ind = 0 )

extern

Get the VSP surface type of the specified Geom

//==== Add Wing Geometry ====//
string wing_id = AddGeom( "WING" );
 
if ( GetGeomVSPSurfType( wing_id ) != WING_SURF )
{
    Print( "---> Error: API GetGeomVSPSurfType " );
    __failure++;
}

See also

VSP_SURF_TYPE

Parameters

[in]	geom_id	string Geom ID
[in]	main_surf_ind	int Main surface index

Returns

int VSP surface type enum (i.e. DISK_SURF), or -1 if the Geom or index is invalid

Here is the call graph for this function:

Here is the caller graph for this function:

GetNumMainSurfs()

int vsp::GetNumMainSurfs ( const std::string & geom_id )

extern

Get the number of main surfaces for the specified Geom. Multiple main surfaces may exist for CustoGeoms, propellors, etc., but does not include surfaces created due to symmetry.

//==== Add Prop Geometry ====//
string prop_id = AddGeom( "PROP" );
 
int num_surf = 0;
 
num_surf = GetNumMainSurfs( prop_id ); // Should be the same as the number of blades
 
if ( num_surf != GetIntParmVal( FindParm( prop_id, "NumBlade", "Design" ) ) )
{
    Print( "ERROR: GetNumMainSurfs does not match the blade count" );
    __failure++;
}
 
Print( "Number of Propeller Surfaces: ", false );
 
Print( num_surf );

Parameters

[in]

geom_id

string Geom ID

Returns

int Number of main surfaces

Here is the call graph for this function:

Here is the caller graph for this function:

GetPtCloudPnts()

std::vector< vec3d > vsp::GetPtCloudPnts ( const std::string & geom_id )

extern

Get the points of a Point Cloud Geom

string pid = AddGeom( "POD" );
 
string mesh_id = ExportFile( "Example_Mesh.msh", SET_ALL, EXPORT_GMSH );
 
string cloud_id = CreatePtCloudGeom( mesh_id );
 
array< vec3d > @pnts = GetPtCloudPnts( cloud_id );
 
if ( pnts.size() == 0 )
{
    Print( "ERROR: GetPtCloudPnts returned nothing" );
    __failure++;
}
 
// A Geom that is not a point cloud has to be rejected.
GetPtCloudPnts( pid );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: GetPtCloudPnts accepted a Geom that is not a point cloud" );
    __failure++;
}
 
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

CreatePtCloudGeom, CreateConvexHull

Parameters

[in]

geom_id

string Point Cloud Geom ID

Returns

vector<vec3d> Array of point cloud points

Here is the call graph for this function:

Here is the caller graph for this function:

GetTotalNumSurfs()

int vsp::GetTotalNumSurfs ( const std::string & geom_id )

extern

Get the total number of surfaces for the specified Geom. This is equivalent to the number of main surface multiplied by the number of symmetric copies.

//==== Add Wing Geometry ====//
string wing_id = AddGeom( "WING" );
 
int num_surf = 0;
 
num_surf = GetTotalNumSurfs( wing_id ); // Wings default with XZ symmetry on -> 2 surfaces
 
if ( num_surf != 2 )
{
    Print( "ERROR: GetTotalNumSurfs, expected 2 for a symmetric wing" );
    __failure++;
}
 
Print( "Total Number of Wing Surfaces: ", false );
 
Print( num_surf );

Parameters

[in]

geom_id

string Geom ID

Returns

int Number of main surfaces

Here is the call graph for this function:

Here is the caller graph for this function:

PasteAirfoil()

void vsp::PasteAirfoil ( const std::string & geom_id, int index )

extern

Paste the airfoil clipboard onto a wing section

string wid = AddGeom( "WING" );
 
Update();
 
CopyAirfoil( wid, 1 );
 
// A default wing has two sections, so there is nowhere past 1 to paste to.
PasteAirfoil( wid, 1 );
 
Update();

See also

CopyAirfoil, PasteXSec, PasteAirfoilByID

Parameters

[in]	geom_id	string Wing Geom ID
[in]	index	int Wing section index

Here is the call graph for this function:

Here is the caller graph for this function:

PasteGeomClipboard()

std::vector< std::string > vsp::PasteGeomClipboard ( const std::string & parent = std::string() )

extern

Paste Geom from clipboard into the model. The Geom is pasted as a child of the specified parent, but will be placed at top level if no parent or an invalid one is provided.

//==== Add Pod Geometries ====//
string pid1 = AddGeom( "POD", "" );
string pid2 = AddGeom( "POD", "" );
 
CutGeomToClipboard( pid1 );
 
PasteGeomClipboard( pid2 ); // Paste Pod 1 as child of Pod 2
 
array< string > @geom_ids = FindGeoms();
 
if ( geom_ids.size() != 2 )                { Print( "---> Error: API Cut/Paste Geom  " ); __failure++; }

Parameters

[in]

parent

string Parent Geom ID

Returns

vector<string> Vector of pasted Geom IDs

Here is the call graph for this function:

Here is the caller graph for this function:

ProjectPtCloudPts()

void vsp::ProjectPtCloudPts ( const std::string & geom_id, const std::string & target_geom_id, int surf_index, int dir_index )

extern

Project the points of a point cloud onto a surface of another Geom, the way the Project button on the Point Cloud screen does. Each point is moved along the chosen axis until it lands on the target surface; a point that does not hit the surface is left where it is.

string pid = AddGeom( "POD" );
 
// Mesh the Pod, then make a point cloud out of the mesh vertices.
string mesh_id = ExportFile( "ProjectExample.msh", SET_ALL, EXPORT_GMSH );
 
string cloud_id = CreatePtCloudGeom( mesh_id );
 
// Lift the cloud above the Pod so the points have somewhere to fall from.
SetParmVal( cloud_id, "Z_Rel_Location", "XForm", 5.0 );
 
Update();
 
array< vec3d > @before = GetPtCloudPnts( cloud_id );
 
ProjectPtCloudPts( cloud_id, pid, 0, Z_DIR );
 
Update();
 
array< vec3d > @after = GetPtCloudPnts( cloud_id );
 
// Projection moves points; it never adds or removes any.
if ( after.size() != before.size() )
{
    Print( "ERROR: ProjectPtCloudPts changed the point count" );
    __failure++;
}

See also

CreatePtCloudGeom, CreateConvexHull

Parameters

[in]	geom_id	string Point cloud Geom ID
[in]	target_geom_id	string Geom ID of the Geom to project onto
[in]	surf_index	int Surface index on the target Geom
[in]	dir_index	int Direction to project along, X_DIR, Y_DIR or Z_DIR (see DIR_INDEX)

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveGeomTexture()

void vsp::RemoveGeomTexture ( const std::string & geom_id, const std::string & texture_id )

extern

Remove a texture from a Geom, the way the Delete button on the Texture screen does.

string pod_id = AddGeom( "POD", "" );
 
string tex_id = AttachGeomTexture( pod_id, "textures/nasa-logo.tga" );
 
RemoveGeomTexture( pod_id, tex_id );
 
if ( GetGeomTextureIDVec( pod_id ).size() != 0 )
{
    Print( "ERROR: RemoveGeomTexture left the texture behind" );
    __failure++;
}

See also

AttachGeomTexture, GetGeomTextureIDVec

Parameters

[in]	geom_id	string Geom ID
[in]	texture_id	string Texture ParmContainer ID

Here is the call graph for this function:

Here is the caller graph for this function:

ReorderGeom()

void vsp::ReorderGeom ( const std::string & geom_id, int reorder_type )

extern

Move a Geom within the list of its siblings, the way the move buttons beside the Geom browser do. A Geom's position among its siblings sets the order it is written, exported and drawn in; it does not change the Geom's parent or its geometry.

string pod1 = AddGeom( "POD", "" );
string pod2 = AddGeom( "POD", "" );
 
// Both Pods sit at the top level, in the order they were added.
if ( FindGeoms()[0] != pod1 )
{
    Print( "ERROR: the Geoms did not start in creation order" );
    __failure++;
}
 
ReorderGeom( pod2, REORDER_MOVE_UP );
 
if ( FindGeoms()[0] != pod2 )
{
    Print( "ERROR: ReorderGeom did not move the Geom" );
    __failure++;
}
 
ReorderGeom( pod2, REORDER_MOVE_BOTTOM );
 
if ( FindGeoms()[0] != pod1 )
{
    Print( "ERROR: ReorderGeom did not move the Geom back" );
    __failure++;
}

See also

SetGeomParent

Parameters

[in]	geom_id	string Geom ID
[in]	reorder_type	int Reorder type enum (see REORDER_TYPE)

Here is the call graph for this function:

Here is the caller graph for this function:

ReplaceCloneGeom()

std::string vsp::ReplaceCloneGeom ( const std::string & clone_id )

extern

Replace a Clone with a full copy of the Geom it shows. The copy takes the Clone's place, name and children, the Clone's own Parm values (any whose Copy From Original switch is off) are written onto it, and the Clone is deleted.

The replacement takes the Clone's Geom ID, the IDs of the Parms they share, and its subsurfaces with their IDs, so attached Geoms, design variables, links and VSPAERO control surface groups keep working. The returned ID is the one passed in.

The replacement's Flip_Flag holds every plane the Clone showed its shape reflected about.

A Clone of a polygon mesh is not replaced, because a polygon mesh cannot be copied.

//==== A Pod and a Clone of it, placed separately ====//
string pod = AddGeom( "POD" );
 
string clone = AddGeom( "CLONE" );
 
SetGeomCloneOriginal( clone, pod );
 
SetParmVal( FindParm( clone, "Y_Rel_Location", "XForm" ), 4.0 );
 
//==== Flipped: the original about XZ, the Clone's own about XY ====//
SetParmVal( FindParm( pod, "Flip_Flag", "Sym" ), SYM_XZ );
SetParmVal( FindParm( clone, "Flip_Flag", "Sym" ), SYM_XY );
 
Update();
 
string name = GetGeomName( clone );
vec3d shown = CompPnt01( clone, 0, 0.3, 0.2 );
 
//==== Replace the Clone ====//
string real = ReplaceCloneGeom( clone );
 
Update();
 
//==== A Pod, under the Clone's name ====//
if ( GetGeomTypeName( real ) != "Pod" )
{
    Print( "ERROR: the replacement is not the original's type" );
    __failure++;
}
 
if ( GetGeomName( real ) != name )
{
    Print( "ERROR: the replacement did not take the Clone's name" );
    __failure++;
}
 
//==== With the Clone's own placement ====//
if ( abs( GetParmVal( FindParm( real, "Y_Rel_Location", "XForm" ) ) - 4.0 ) > 1e-6 )
{
    Print( "ERROR: the replacement did not take the position the Clone held of its own" );
    __failure++;
}
 
//==== With the same flip planes, so the surface is unchanged ====//
if ( int( GetParmVal( FindParm( real, "Flip_Flag", "Sym" ) ) + 0.5 ) != ( SYM_XZ | SYM_XY ) )
{
    Print( "ERROR: the replacement did not take the planes the Clone showed" );
    __failure++;
}
 
if ( dist( shown, CompPnt01( real, 0, 0.3, 0.2 ) ) > 1e-9 )
{
    Print( "ERROR: the replacement does not stand where the Clone stood" );
    __failure++;
}
 
//==== The replacement answers to the Clone's own ID ====//
if ( real != clone )
{
    Print( "ERROR: the replacement did not take the Clone's ID" );
    __failure++;
}
 
//==== It is no longer a Clone; clear the queue first ====//
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj drained = PopLastError();
}
 
GetGeomCloneOriginal( clone );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: what took the Clone's ID is still a Clone" );
    __failure++;
}
 
// That error was raised deliberately, so take it back off the queue.
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

SetGeomCloneOriginal, CloneGeomVec

Parameters

[in]

clone_id

string Clone Geom ID

Returns

string ID of the Geom that replaced it – the Clone's own ID – or an empty string on failure

Here is the call graph for this function:

Here is the caller graph for this function:

ResetGeomScale()

void vsp::ResetGeomScale ( const std::string & geom_id )

extern

Discard a Geom's pending scale and return it to its unscaled size. This is the Scale tab's Reset button. Use AcceptGeomScale to keep the scaled size instead.

string pid = AddGeom( "POD" );
 
Update();
 
vec3d before_max = GetGeomBBoxMax( pid, 0, false );
 
SetParmValUpdate( pid, "Scale", "XForm", 2.0 );
 
Update();
 
vec3d scaled_max = GetGeomBBoxMax( pid, 0, false );
 
if ( !closeTo( scaled_max.x(), 2.0 * before_max.x(), 1e-6 ) )
{
    Print( "ERROR: the Geom was never scaled" );
    __failure++;
}
 
ResetGeomScale( pid );
 
Update();
 
// The scale factor comes back to one and the Geom returns to its base size.
if ( !closeTo( GetParmVal( pid, "Scale", "XForm" ), 1.0, 1e-9 ) )
{
    Print( "ERROR: ResetGeomScale did not reset the scale factor" );
    __failure++;
}
 
vec3d after_max = GetGeomBBoxMax( pid, 0, false );
 
if ( !closeTo( after_max.x(), before_max.x(), 1e-6 ) )
{
    Print( "ERROR: ResetGeomScale did not undo the scaling" );
    __failure++;
}

Parameters

[in]

geom_id

string Geom ID

Here is the call graph for this function:

Here is the caller graph for this function:

ResetPropellerThickness()

void vsp::ResetPropellerThickness ( const std::string & geom_id )

extern

Rebuild a propeller's thickness curve from the airfoils actually on its cross sections, the way the Reset Thickness button on the Prop screen does. The thickness curve normally drives the sections; this runs the relationship the other way once, so a blade built up section by section gets a thickness curve that matches what it already is.

string prop_id = AddGeom( "PROP", "" );
 
Update();
 
ResetPropellerThickness( prop_id );
 
// The thickness curve now carries one point per cross section.
array< double > @tvec = PCurveGetTVec( prop_id, PROP_THICK );
 
string xsec_surf = GetXSecSurf( prop_id, 0 );
 
if ( tvec.size() != GetNumXSec( xsec_surf ) )
{
    Print( "ERROR: ResetPropellerThickness did not rebuild the curve" );
    __failure++;
}

See also

ApproximateAllPropellerPCurves, PCurveGetTVec

Parameters

[in]

geom_id

string Propeller Geom ID

Here is the call graph for this function:

Here is the caller graph for this function:

SetGeomCloneNameSuffix()

void vsp::SetGeomCloneNameSuffix ( const std::string & clone_id, const std::string & name_suffix )

extern

Set the suffix automatic naming appends to the original's name. With AutoName on, the Clone is renamed on the next update. The suffix is saved with the model.

//==== Add Pod Geom and a Clone of it ====//
string pod = AddGeom( "POD" );
 
string clone = AddGeom( "CLONE" );
 
SetGeomCloneOriginal( clone, pod );
 
Update();
 
SetGeomCloneNameSuffix( clone, "_Left" );
 
Update();
 
if ( GetGeomName( clone ) != GetGeomName( pod ) + "_Left" )
{
    Print( "ERROR: SetGeomCloneNameSuffix did not rename the Clone" );
    __failure++;
}
 
if ( GetGeomCloneNameSuffix( clone ) != "_Left" )
{
    Print( "ERROR: GetGeomCloneNameSuffix did not report the suffix that was set" );
    __failure++;
}

See also

GetGeomCloneNameSuffix, CloneGeomVec

Parameters

[in]	clone_id	string Clone Geom ID
[in]	name_suffix	string Suffix to append to the original's name

Here is the call graph for this function:

Here is the caller graph for this function:

SetGeomCloneOriginal()

void vsp::SetGeomCloneOriginal ( const std::string & clone_id, const std::string & original_id )

extern

Set which Geom a Clone Geom is a Clone of. A Clone shows the original's surfaces while keeping its own place in the model. What else it takes from the original – symmetry, Set membership, placement, attachment, colour, subsurfaces and the rest – is controlled by the Parms in its Behavior group. Passing an empty original_id leaves the Clone showing nothing and turns its AutoName off, so its name is the user's.

A Clone's Flip_Flag (group Sym) is its own. With CloneSym on, the Clone also shows its original's flip: the planes are combined, and a plane set on both cancels.

string pod = AddGeom( "POD", "" );
 
string clone = AddGeom( "CLONE", "" );
 
SetGeomCloneOriginal( clone, pod );
 
if ( GetGeomCloneOriginal( clone ) != pod )
{
    Print( "ERROR: SetGeomCloneOriginal did not take" );
    __failure++;
}
 
// A Clone cannot be its own original; refused, original unchanged.
SetGeomCloneOriginal( clone, clone );
 
if ( GetGeomCloneOriginal( clone ) != pod )
{
    Print( "ERROR: SetGeomCloneOriginal accepted the Clone as its own original" );
    __failure++;
}
 
// Clear that error before the next check.
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}
 
// Asking a Geom that is not a Clone is an error.
GetGeomCloneOriginal( pod );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: GetGeomCloneOriginal accepted a Geom that is not a Clone" );
    __failure++;
}
 
// That error was raised deliberately, so take it back off the queue.
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}
 
//==== The original's flip and the Clone's own combine ====//
SetParmVal( pod, "Y_Rel_Location", "XForm", 3.0 );
SetParmVal( clone, "Y_Rel_Location", "XForm", 3.0 );
Update();
vec3d plain = CompPnt01( clone, 0, 0.5, 0.25 );
 
SetParmVal( pod, "Flip_Flag", "Sym", SYM_XZ );
Update();
vec3d one_plane = CompPnt01( clone, 0, 0.5, 0.25 );
if ( abs( ( one_plane.y() - 3.0 ) + ( plain.y() - 3.0 ) ) > 1e-9 )
{
    Print( "ERROR: the Clone did not show its original's flip" );
    __failure++;
}
 
SetParmVal( clone, "Flip_Flag", "Sym", SYM_XZ );
Update();
if ( dist( plain, CompPnt01( clone, 0, 0.5, 0.25 ) ) > 1e-9 )
{
    Print( "ERROR: the same plane on both did not cancel" );
    __failure++;
}
 
//==== Clearing the original hands the name back ====//
SetGeomCloneOriginal( clone, "" );
if ( GetParmVal( FindParm( clone, "AutoName", "Behavior" ) ) != 0.0 )
{
    Print( "ERROR: clearing the original left AutoName on" );
    __failure++;
}

See also

GetGeomCloneOriginal, SYM_FLAG

Parameters

[in]	clone_id	string Clone Geom ID
[in]	original_id	string ID of the Geom to be cloned

Here is the call graph for this function:

Here is the caller graph for this function:

SetGeomIncorporatedAncestorID()

void vsp::SetGeomIncorporatedAncestorID ( const std::string & geom_id, const std::string & ancestor_id )

extern

Set the Geom whose Parasite Drag row a Geom is incorporated into, by ID, which sets its IncorporatedGen Parm. The Geom must be the Geom itself or one of its ancestors.

string parent_id = AddGeom( "POD" );
 
string child_id = AddGeom( "POD", parent_id );
 
SetGeomIncorporatedAncestorID( child_id, parent_id );
 
if ( GetGeomIncorporatedAncestorID( child_id ) != parent_id )
{
    Print( "ERROR: SetGeomIncorporatedAncestorID did not set the parent" );
    __failure++;
}

See also

GetGeomIncorporatedAncestorID

Parameters

[in]	geom_id	string Geom ID
[in]	ancestor_id	string ID of the Geom or one of its ancestors

Here is the call graph for this function:

Here is the caller graph for this function:

SetGeomMaterialName()

void vsp::SetGeomMaterialName ( const std::string & geom_id, const std::string & name )

extern

Set the material a Geom is drawn with, by name. The name must be one of the materials in the material library.

string pid = AddGeom( "POD" );
 
Update();
 
SetGeomMaterialName( pid, "Aluminum" );

See also

AddMaterial

Parameters

[in]	geom_id	string Geom ID
[in]	name	string Material name

Here is the call graph for this function:

Here is the caller graph for this function:

SetGeomName()

void vsp::SetGeomName ( const std::string & geom_id, const std::string & name )

extern

Set the name of the specified Geom. A Geom that names itself, such as a Clone with its AutoName Parm (group Behavior) on, refuses the name with an error; turn AutoName off first.

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD", "" );
 
SetGeomName( pid, "ExamplePodName" );
 
array< string > @geom_ids = FindGeomsWithName( "ExamplePodName" );
 
if ( geom_ids.size() != 1 )
{
    Print( "---> Error: API FindGeomsWithName " );
    __failure++;
}
 
//==== A Clone names itself until AutoName is turned off ====//
array< string > one;
one.push_back( pid );
string clone_id = CloneGeomVec( one )[0];
 
SetGeomName( clone_id, "MyClone" );
if ( GetGeomName( clone_id ) == "MyClone" )
{
    Print( "---> Error: SetGeomName renamed a Clone that names itself" );
    __failure++;
}
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}
 
SetParmVal( clone_id, "AutoName", "Behavior", 0.0 );
SetGeomName( clone_id, "MyClone" );
Update();
if ( GetGeomName( clone_id ) != "MyClone" )
{
    Print( "---> Error: SetGeomName did not rename the Clone" );
    __failure++;
}

Parameters

[in]	geom_id	string Geom ID
[in]	name	string Geom name

Here is the call graph for this function:

Here is the caller graph for this function:

SetGeomParent()

void vsp::SetGeomParent ( const std::string & geom_id, const std::string & parent_id )

extern

Get the parent Geom ID for the input child Geom. "NONE" is returned if the Geom has no parent.

//==== Reparent two PodGeoms ====//
string pod1 = AddGeom( "POD" );
string pod2 = AddGeom( "POD", pod1 );
string pod3 = AddGeom ("POD" );
 
string veh_id = GetVehicleID();
 
SetGeomParent( pod2, veh_id );
SetGeomParent( pod3, pod1 );
 
string pod2_parent = GetGeomParent( pod2 );
string pod3_parent = GetGeomParent( pod3 );
 
if ( pod2_parent != string("NONE") || pod3_parent != pod1 )
{
    Print( "SetGeomParent error!" );
    __failure++;
}

Parameters

[in]	geom_id	string Geom ID
[in]	parent_id	string Parent Geom ID

Here is the call graph for this function:

Here is the caller graph for this function:

SetGeomSymAncestorID()

void vsp::SetGeomSymAncestorID ( const std::string & geom_id, const std::string & ancestor_id )

extern

Set the Geom whose frame a Geom's symmetry is about, by ID, which sets its Sym_Ancestor Parm. The Geom must be the Geom itself or one of its ancestors; an empty string means the global origin.

string parent_id = AddGeom( "POD" );
 
string child_id = AddGeom( "POD", parent_id );
 
SetGeomSymAncestorID( child_id, parent_id );
 
if ( GetGeomSymAncestorID( child_id ) != parent_id )
{
    Print( "ERROR: SetGeomSymAncestorID did not set the parent" );
    __failure++;
}

See also

GetGeomSymAncestorID

Parameters

[in]	geom_id	string Geom ID
[in]	ancestor_id	string ID of the Geom or one of its ancestors, or an empty string

Here is the call graph for this function:

Here is the caller graph for this function:

SplitWingXSec()

void vsp::SplitWingXSec ( const std::string & wing_id, int section_index )

extern

Split a given wing section.

string wing_id = AddGeom( "WING", "" );
 
string xsec_surf = GetXSecSurf( wing_id, 0 );
 
int num_start = GetNumXSec( xsec_surf );
 
double span_start = GetParmVal( wing_id, "Span", "XSec_1" );
 
//==== Set Wing Section Controls ====//
SplitWingXSec( wing_id, 1 );
 
Update();
 
// Splitting a section turns one section into two, and the two halves span
// what the one section spanned.
if ( GetNumXSec( xsec_surf ) != num_start + 1 )
{
    Print( "ERROR: SplitWingXSec did not split the section" );
    __failure++;
}
else
{
    double span_1 = GetParmVal( wing_id, "Span", "XSec_1" );
    double span_2 = GetParmVal( wing_id, "Span", "XSec_2" );
 
    if ( !closeTo( span_1 + span_2, span_start, 1e-6 ) )
    {
        Print( "ERROR: SplitWingXSec changed the span of the wing" );
        __failure++;
    }
}

See also

WING_DRIVERS, XSEC_DRIVERS, SplitWingXSecByID

Parameters

[in]	wing_id	string Geom ID
[in]	section_index	int Wing section index

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateGeom()

void vsp::UpdateGeom ( const std::string & geom_id )

extern

Perform an update for the specified Geom.

Update() rebuilds the model from the top of the tree down and places each child Geom from its relative location, so a child stays attached when its parent moves. A child Geom in absolute mode ( Abs_Or_Relitive_flag set to ABS ) therefore loses an X_Location, Y_Location, Z_Location or X/Y/Z_Rotation set with SetParmVal when Update() runs. Call UpdateGeom on that Geom before Update(): it updates the Geom by itself and works out the relative location from the new absolute one. SetParmValUpdate does both in one call.

//==== Add Wing Geometry ====//
string wing_id = AddGeom( "WING" );
 
//==== Add Pod Geometry ====//
string pod_id = AddGeom( "POD" );
 
Update();
 
vec3d before_min = GetGeomBBoxMin( pod_id, 0, true );
 
SetParmVal( pod_id, "X_Rel_Location", "XForm", 5.0 );
 
UpdateGeom( pod_id ); // Faster than updating the whole vehicle
 
// Updating just this Geom has to move it, the same as a full Update would.
vec3d after_min = GetGeomBBoxMin( pod_id, 0, true );
 
if ( !closeTo( after_min.x() - before_min.x(), 5.0, 1e-6 ) )
{
    Print( "ERROR: UpdateGeom did not rebuild the Geom" );
    __failure++;
}

See also

Update()

Parameters

[in]

geom_id

string Geom ID

Here is the call graph for this function:

Here is the caller graph for this function: