Custom Geometry Functions

This functions grouped here are used to create and manipulate Custom Components. Custom components are defined in *.vspscript files included in the /"Custom Scripts/" directory. Examples of Custom Components are available in the directory for reference.

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

Functions
string	AddParm (int type, const string &in name, const string &in group)
string	GetCurrCustomGeom ()
string	GetCustomParm (int index)
int	AddGui (int type, const string &in label=string(), const string &in parm_name=string(), const string &in group_name=string(), double range=10.0)
void	UpdateGui (int gui_id, const string &in parm_id)
string	AddXSecSurf ()
void	RemoveXSecSurf (const string &in xsec_id)
void	ClearXSecSurfs ()
void	SkinXSecSurf (bool closed_flag=false)
void	CloneSurf (int index, Matrix4d &in mat)
void	TransformSurf (int index, Matrix4d &in mat)
void	SetVspSurfType (int type, int surf_index=- 1)
void	SetVspSurfCfdType (int type, int surf_index=- 1)
void	SetCustomXSecLoc (const string &in xsec_id, const vec3d &in loc)
vec3d	GetCustomXSecLoc (const string &in xsec_id)
void	SetCustomXSecRot (const string &in xsec_id, const vec3d &in rot)
vec3d	GetCustomXSecRot (const string &in xsec_id)
bool	CheckClearTriggerEvent (int gui_id)
void	SetupCustomDefaultSource (int type, int surf_index, double l1, double r1, double u1, double w1, double l2=0, double r2=0, double u2=0, double w2=0)
void	ClearAllCustomDefaultSources ()
void	SetCustomCenter (double x, double y, double z)
string	AppendXSec (const string &in xsec_surf_id, int type)
string	AppendCustomXSec (const string &in xsec_surf_id, int type)
void	CutCustomXSec (const string &in xsec_surf_id, int index)
void	CopyCustomXSec (const string &in xsec_surf_id, int index)
void	PasteCustomXSec (const string &in xsec_surf_id, int index)
string	InsertCustomXSec (const string &in xsec_surf_id, int type, int index)

Detailed Description

Function Documentation

AddGui()

int AddGui	(	int	type,
		const string &in	label = string(),
		const string &in	parm_name = string(),
		const string &in	group_name = string(),
		double	range = 10.0
	)

Add a GUI element for the current custom Geom. Some inputs may not be used depending on the input type. The Parm name and group name are used to identify the Parm ID associated with the GUI element.

//==== InitGui Is Called Once During Each Custom Geom Construction ====//
void InitGui()
{
    AddGui( GDEV_TAB, "Design"  );
 
    AddGui( GDEV_YGAP );
 
    AddGui( GDEV_DIVIDER_BOX, "Design" );
 
    AddGui( GDEV_SLIDER_ADJ_RANGE_INPUT, "Length", "Length", "Design"  );
 
    AddGui( GDEV_YGAP );
 
    AddGui( GDEV_SLIDER_ADJ_RANGE_INPUT, "Diameter", "Diameter", "Design"  );
}

See also

GDEV

Parameters

[in]	type	GUI element type enum (i.e. GDEV_SLIDER_ADJ_RANGE)
[in]	label	Optional GUI device label
[in]	parm_name	Optional Parm name
[in]	group_name	Optional Parm group name
[in]	range	Optional GUI element range

Returns

GUI element index

AddParm()

string AddParm	(	int	type,
		const string &in	name,
		const string &in	group
	)

Function to add a new Parm of input type, name, and group for a custom Geom component

string length = AddParm( PARM_DOUBLE_TYPE, "Length", "Design" );
 
SetParmValLimits( length, 10.0, 0.001, 1.0e12 );
 
SetParmDescript( length, "Total Length of Custom Geom" );

See also

PARM_TYPE

Parameters

[in]	type	Parm type enum (i.e. PARM_DOUBLE_TYPE)
[in]	name	Parm name
[in]	group	Parm group

Returns

Parm ID

AddXSecSurf()

string AddXSecSurf

(

)

Add an XSecSurf to the current custom Geom
/code{.cpp}

==== Add Cross Sections =====// string seat_surf = AddXSecSurf();

AppendCustomXSec( seat_surf, XS_POINT);

AppendCustomXSec( seat_surf, XS_ROUNDED_RECTANGLE);

AppendCustomXSec( seat_surf, XS_ROUNDED_RECTANGLE);

AppendCustomXSec( seat_surf, XS_POINT); /endcode

Returns

XSecSurf ID

AppendCustomXSec()

string AppendCustomXSec	(	const string &in	xsec_surf_id,
		int	type
	)

Append an XSec to the current custom Geom. This function is identical to AppendXSec.

//==== Add Cross Sections  =====//
    string xsec_surf = AddXSecSurf();
 
    AppendCustomXSec( xsec_surf, XS_POINT);
 
    AppendCustomXSec( xsec_surf, XS_CIRCLE );
 
    AppendCustomXSec( xsec_surf, XS_CIRCLE );
 
    AppendCustomXSec( xsec_surf, XS_ELLIPSE );
 
    AppendCustomXSec( xsec_surf, XS_POINT);

See also

XSEC_CRV_TYPE, AppendXSec

Parameters

[in]	xsec_surf_id	XSecSurf ID
[in]	type	XSec type enum (i.e. XSEC_WEDGE)

Returns

XSec ID

AppendXSec()

string AppendXSec	(	const string &in	xsec_surf_id,
		int	type
	)

Append an XSec to the current custom Geom. This function is identical to AppendCustomXSec.

//==== Add Cross Sections  =====//
    string xsec_surf = AddXSecSurf();
 
    AppendXSec( xsec_surf, XS_POINT);
 
    AppendXSec( xsec_surf, XS_CIRCLE );
 
    AppendXSec( xsec_surf, XS_CIRCLE );
 
    AppendXSec( xsec_surf, XS_ELLIPSE );
 
    AppendXSec( xsec_surf, XS_POINT);

See also

XSEC_CRV_TYPE, AppendCustomXSec

Parameters

[in]	xsec_surf_id	XSecSurf ID
[in]	type	XSec type enum (i.e. XSEC_WEDGE)

Returns

XSec ID

CheckClearTriggerEvent()

bool CheckClearTriggerEvent

(

int

gui_id

)

Check and clear a trigger event for a custom Geom GUI element

Parameters

[in]

gui_id

GUI element index

Returns

True if successful, false otherwise

ClearAllCustomDefaultSources()

void ClearAllCustomDefaultSources

(

)

Clear all default sources for the current custom Geom

SetupCustomDefaultSource( POINT_SOURCE, 0, 0.1, 1.0, 1.0, 1.0 );
 
ClearAllCustomDefaultSources();

ClearXSecSurfs()

void ClearXSecSurfs

(

)

Clear all XSecSurf from the current custom Geom
/code{.cpp}

==== Add Cross Sections =====// string surf1 = AddXSecSurf();

string surf2 = AddXSecSurf();

ClearXSecSurfs(); /endcode

CloneSurf()

void CloneSurf	(	int	index,
		Matrix4d &in	mat
	)

Make a copy of the current custom Geom's main surface at given index and apply a transformation

string geom_id = GetCurrCustomGeom();
 
//==== Get Curr Vals ====//
double width_val  = GetParmVal( GetParm( geom_id, "Width",  "Design" ) );
 
double height_val = GetParmVal( GetParm( geom_id, "Height", "Design" ) );
 
Matrix4d mat;
 
double y = i * width_val;
double z = j * height_val;
 
mat.translatef( 0.0, y, z );
 
CloneSurf( 0, mat );

Parameters

[in]	index	Main surface index
[in]	mat	Transformation matrix

CopyCustomXSec()

void CopyCustomXSec	(	const string &in	xsec_surf_id,
		int	index
	)

Copy an XSec from the current custom Geom and keep it in memory

See also

PasteCustomXSec

Parameters

[in]	xsec_surf_id	XSecSurf ID
[in]	index	XSec index

CutCustomXSec()

void CutCustomXSec	(	const string &in	xsec_surf_id,
		int	index
	)

Remove an XSec from the current custom Geom and keep it in memory

See also

PasteCustomXSec

Parameters

[in]	xsec_surf_id	XSecSurf ID
[in]	index	XSec index

GetCurrCustomGeom()

string GetCurrCustomGeom

(

)

Get the Geom ID of the current custom Geom

//==== Set Some Decent Tess Vals ====//
string geom_id = GetCurrCustomGeom();
 
SetParmVal( GetParm( geom_id, "Tess_U",  "Shape" ), 33 );
 
SetParmVal( GetParm( geom_id, "Tess_W",  "Shape" ), 13 );

Returns

Geom ID

GetCustomParm()

string GetCustomParm

(

int

index

)

Get the Parm ID for the input Parm index of the current custom Geom

Parameters

[in]

index

Parm index

Returns

Parm ID

GetCustomXSecLoc()

vec3d GetCustomXSecLoc

(

const string &in

xsec_id

)

Get the location of an XSec for the current custom Geom

string geom_id = GetCurrCustomGeom();
 
//==== Get The XSec Surf ====//
string xsec_surf = GetXSecSurf( geom_id, 0 );
 
string xsec0 = GetXSec( xsec_surf, 0 );
 
SetCustomXSecLoc( xsec0, vec3d( 1.0, 2.0, 3.0 ) );
 
vec3d loc =  GetCustomXSecLoc( xsec0 );
 
Print( "Custom XSec Location: ", false );
 
Print( loc );

Parameters

[in]

xsec_id

XSec ID

Returns

3D location

GetCustomXSecRot()

vec3d GetCustomXSecRot

(

const string &in

xsec_id

)

Get the rotation of an XSec for the current custom Geom

//==== Add Spine Surf ====//
string spine_surf = AddXSecSurf();
 
string spine_xsec = AppendXSec( spine_surf, XS_GENERAL_FUSE );
 
SetCustomXSecRot( spine_xsec, vec3d( 0, 0, 90 ) );
 
vec3d rot =  GetCustomXSecRot( xsec0 );
 
Print( "Custom XSec Rotation: ", false );
 
Print( rot );

Parameters

[in]

xsec_id

XSec ID

Returns

3D rotation (degrees)

InsertCustomXSec()

string InsertCustomXSec	(	const string &in	xsec_surf_id,
		int	type,
		int	index
	)

Insert a new XSec at the given index for the currently selected custom Geom

See also

XSEC_CRV_TYPE

Parameters

[in]	xsec_surf_id	XSecSurf ID
[in]	type	XSec type enum (i.e. XSEC_WEDGE)
[in]	index	XSec index

PasteCustomXSec()

void PasteCustomXSec	(	const string &in	xsec_surf_id,
		int	index
	)

Paste the XSec currently held in memory for the current custom Geom at given index

See also

CutCustomXSec, CopyCustomXSec

Parameters

[in]	xsec_surf_id	XSecSurf ID
[in]	index	XSec index

RemoveXSecSurf()

void RemoveXSecSurf

(

const string &in

xsec_id

)

Remove an XSecSurf from the current custom Geom

//==== Add Temp Spine Surf ====//
string spine_surf = AddXSecSurf();
 
string spine_xsec = AppendXSec( spine_surf, XS_GENERAL_FUSE );
 
SetCustomXSecRot( spine_xsec, vec3d( 0, 0, 90 ) );
 
//==== Get The XSec Surf ====//
string xsec_surf = GetXSecSurf( geom_id, 0 );
 
//==== Define XSecs ====//
int NUM_XSECS = 11;
 
for ( int i = 0 ; i < NUM_XSECS ; i++ )
{
    string xsec = GetXSec( xsec_surf, i );
 
    UpdateXSecLocRot( xsec, spine_xsec, i*0.10 );
}
 
//=== Remove Spine Surf ====//
RemoveXSecSurf( spine_surf );

Parameters

[in]

xsec_id

XSecSurf ID

SetCustomCenter()

void SetCustomCenter	(	double	x,
		double	y,
		double	z
	)

Set the center point of the current custom Geom

string geom_id = GetCurrCustomGeom();
 
double ht= GetParmVal( GetParm( geom_id, "Height", "Design" ) );
 
double origin = GetParmVal( GetParm( geom_id, "Origin", "XForm" ) );
 
SetCustomCenter( ht*origin, 0, 0 );

Parameters

[in]	x	X coordinate
[in]	y	Y coordinate
[in]	z	Z coordinate

SetCustomXSecLoc()

void SetCustomXSecLoc	(	const string &in	xsec_id,
		const vec3d &in	loc
	)

Set the location of an XSec for the current custom Geom

string geom_id = GetCurrCustomGeom();
 
//==== Get Curr Vals ====//
double diameter_val = GetParmVal( GetParm( geom_id, "Diameter", "Design" ) );
 
double nose_mult_val = GetParmVal( GetParm( geom_id, "NoseMult", "Design" ) );
 
//==== Get The XSec Surf ====//
string xsec_surf = GetXSecSurf( geom_id, 0 );
 
string xsec0 = GetXSec( xsec_surf, 0 );
 
SetCustomXSecLoc( xsec0, vec3d( 0.0, 0.0, nose_center_val*diameter_val ) );

Parameters

[in]	xsec_id	XSec ID
[in]	loc	3D location

SetCustomXSecRot()

void SetCustomXSecRot	(	const string &in	xsec_id,
		const vec3d &in	rot
	)

Set the rotation of an XSec for the current custom Geom

//==== Add Spine Surf ====//
string spine_surf = AddXSecSurf();
 
string spine_xsec = AppendXSec( spine_surf, XS_GENERAL_FUSE );
 
SetCustomXSecRot( spine_xsec, vec3d( 0, 0, 90 ) );

Parameters

[in]	xsec_id	XSec ID
[in]	rot	Angle of rotation about the X, Y and Z axes (degrees)

SetupCustomDefaultSource()

void SetupCustomDefaultSource	(	int	type,
		int	surf_index,
		double	l1,
		double	r1,
		double	u1,
		double	w1,
		double	l2 = 0,
		double	r2 = 0,
		double	u2 = 0,
		double	w2 = 0
	)

Add a CFD Mesh default source for the current custom Geom. Note, certain input params may not be used depending on the source type.

void Init()
{
    //==== Add Cross Sections  =====//
    string xsec_surf = AddXSecSurf();
 
    AppendCustomXSec( xsec_surf, XS_POINT);
 
    AppendCustomXSec( xsec_surf, XS_CIRCLE);
 
    //==== Add A Default Point Source At Nose ====//
    SetupCustomDefaultSource( POINT_SOURCE, 0, 0.1, 1.0, 1.0, 1.0 );
}

See also

CFD_MESH_SOURCE_TYPE

Parameters

[in]	type	CFD Mesh source type enum (i.e. BOX_SOURCE)
[in]	surf_index	Main surface index
[in]	l1	Source first edge length
[in]	r1	Source first radius
[in]	u1	Source first U location
[in]	w1	Source first W location
[in]	l2	Source second edge length
[in]	r2	Source second radius
[in]	u2	Source second U location
[in]	w2	Source second W location

SetVspSurfCfdType()

void SetVspSurfCfdType	(	int	type,
		int	surf_index = - 1
	)

Set the surface CFD type for the current custom Geom at given surface index

//==== UpdateSurf Is Called Every Time The Geom is Updated ====//
void UpdateSurf()
{
    SetVspSurfType( DISK_SURF, -1 );
 
    SetVspSurfCfdType( CFD_TRANSPARENT, -1 );
 
    SkinXSecSurf();
}

See also

VSP_SURF_CFD_TYPE

Parameters

[in]	type	CFD surface type enum (i.e. CFD_TRANSPARENT)
[in]	surf_index	Main surface index. The default value of -1 is used to indicate all main surfaces are the same type.

SetVspSurfType()

void SetVspSurfType	(	int	type,
		int	surf_index = - 1
	)

Set the surface type for the current custom Geom at given surface index

//==== UpdateSurf Is Called Every Time The Geom is Updated ====//
void UpdateSurf()
{
    SetVspSurfType( DISK_SURF, -1 );
 
    SetVspSurfCfdType( CFD_TRANSPARENT, -1 );
 
    SkinXSecSurf();
}

See also

VSP_SURF_TYPE

Parameters

[in]	type	Surface type enum (i.e DISK_SURF)
[in]	surf_index	Main surface index. The default value of -1 is used to indicate all main surfaces are the same type.

SkinXSecSurf()

void SkinXSecSurf

(

bool

closed_flag = false

)

Perform a skinning update for the current custom Geom. This is typically the last call in the UpdateSurf function that gets called every time the Geom is updated.

//==== UpdateSurf Is Called Every Time The Geom is Updated ====//
void UpdateSurf()
{
    string geom_id = GetCurrCustomGeom();
 
    //==== Get Curr Vals ====//
    double length_val = GetParmVal( GetParm( geom_id, "Length", "Design" ) );
 
    //==== Get The XSec Surf ====//
    string xsec_surf = GetXSecSurf( geom_id, 0 );
 
    //==== Define The First/Last XSec Placement ====//
    string xsec3 = GetXSec( xsec_surf, 3 );
 
    SetCustomXSecLoc( xsec3, vec3d( length_val, 0, 0 ) );
 
    SkinXSecSurf();
}

Parameters

[in]

closed_flag

Flag to set the last XSec equal to the first

TransformSurf()

void TransformSurf	(	int	index,
		Matrix4d &in	mat
	)

Perform a transformation for the main surface at input index for the current custom Geom

Parameters

[in]	index	Main surface index
[in]	mat	Transformation matrix

UpdateGui()

void UpdateGui	(	int	gui_id,
		const string &in	parm_id
	)

Update the GUI element with an associated Parm
/code{.cpp}

==== UpdateGui Is Called Every Time The Gui is Updated ====// void UpdateGui() { string geom_id = GetCurrCustomGeom();

UpdateGui( WidthSlider, GetParm( geom_id, "Width", "Design" ) );

UpdateGui( SeatHeightSlider, GetParm( geom_id, "SeatHeight", "Design" ) );

UpdateGui( SeatLengthSlider, GetParm( geom_id, "SeatLength", "Design" ) );

UpdateGui( BackHeightSlider, GetParm( geom_id, "BackHeight", "Design" ) );

} /endcode

Parameters

[in]	gui_id	Index of the GUI element
[in]	parm_id	Parm ID