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
string []	GetGeomTypes ()
string	AddGeom (const string &in type, const string &in parent=string())
void	UpdateGeom (const string &in geom_id)
void	DeleteGeom (const string &in geom_id)
void	DeleteGeomVec (string[]@ del_arr)
void	CutGeomToClipboard (const string &in geom_id)
void	CopyGeomToClipboard (const string &in geom_id)
string []	PasteGeomClipboard (const string &in parent_id="")
string []	FindGeoms ()
string []	FindGeomsWithName (const string &in name)
void	SetGeomName (const string &in geom_id, const string &in name)
string	GetGeomName (const string &in geom_id)
string []	GetGeomParmIDs (const string &in geom_id)
string	GetGeomTypeName (const string &in geom_id)
int	GetNumMainSurfs (const string &in geom_id)

Detailed Description

Function Documentation

AddGeom()

string AddGeom	(	const string &in	type,
		const string &in	parent = string()
	)

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

Parameters

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

CopyGeomToClipboard()

void CopyGeomToClipboard

(

const string &in

geom_id

)

Copy Geom from current location and store on clipboard

See also

PasteGeomClipboard

Parameters

[in]

geom_id

Geom ID

CutGeomToClipboard()

void CutGeomToClipboard

(

const string &in

geom_id

)

Cut Geom from current location and store on clipboad

See also

PasteGeomClipboard

Parameters

[in]

geom_id

Geom ID

DeleteGeom()

void DeleteGeom

(

const string &in

geom_id

)

Delete a particular Geom

Parameters

[in]

geom_id

Geom ID

DeleteGeomVec()

void DeleteGeomVec

(

string@ []

del_arr

)

Delete multiple Geoms

Parameters

[in]

del_arr

Array of Geom IDs

FindGeoms()

string [] FindGeoms

(

)

Find and return all Geom IDs in the model

Returns

Array of all Geom IDs

FindGeomsWithName()

string [] FindGeomsWithName

(

const string &in

name

)

Find and return all Geom IDs with the specified name

Parameters

[in]

name

Geom name

Returns

Array of Geom IDs

GetGeomName()

string GetGeomName

(

const string &in

geom_id

)

Get the name of a specific Geom

Parameters

[in]

geom_id

Geom ID

Returns

Geom name

GetGeomParmIDs()

string [] GetGeomParmIDs

(

const string &in

geom_id

)

Get all Parm IDs associated with this Geom Parm container

Parameters

[in]

geom_id

Geom ID

Returns

Array of Parm IDs

GetGeomTypeName()

string GetGeomTypeName

(

const string &in

geom_id

)

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

Parameters

[in]

geom_id

Geom ID

Returns

Geom type name

GetGeomTypes()

string [] GetGeomTypes

(

)

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

Returns

Array of Geom type names

GetNumMainSurfs()

int GetNumMainSurfs

(

const string &in

geom_id

)

Get the number of main surfaces for the specified Geom. Multiple main surfaces may exist for CustoGeoms, when symmetry is actve, etc.

Parameters

[in]

geom_id

Geom ID

Returns

Number of main surfaces

PasteGeomClipboard()

string [] PasteGeomClipboard

(

const string &in

parent_id = ""

)

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.

Parameters

[in]

parent_id

Parent Geom ID

Returns

Array of pasted Geom IDs

SetGeomName()

void SetGeomName	(	const string &in	geom_id,
		const string &in	name
	)

Set the name of the specified Geom

Parameters

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

UpdateGeom()

void UpdateGeom

(

const string &in

geom_id

)

Perform an update for the specified Geom

See also

Update()

Parameters

[in]

geom_id

Geom ID