Edit Curve XSec Functions

Functions for modifying XSecs of type XS_EDIT_CURVE are defined here. Click here to return to the main page. More...

Functions
void	vsp::EditXSecInitShape (const std::string &xsec_id)
void	vsp::EditXSecConvertTo (const std::string &xsec_id, const int &newtype)
std::vector< double >	vsp::GetEditXSecUVec (const std::string &xsec_id)
std::vector< vec3d >	vsp::GetEditXSecCtrlVec (const std::string &xsec_id, bool non_dimensional=true)
void	vsp::SetEditXSecPnts (const std::string &xsec_id, const std::vector< double > &u_vec, const std::vector< vec3d > &control_pts, const std::vector< double > &r_vec)
void	vsp::EditXSecDelPnt (const std::string &xsec_id, const int &indx)
int	vsp::EditXSecSplit01 (const std::string &xsec_id, const double &u)
void	vsp::MoveEditXSecPnt (const std::string &xsec_id, const int &indx, const vec3d &new_pnt)
void	vsp::ConvertXSecToEdit (const std::string &geom_id, const int &indx=0)
std::vector< bool >	vsp::GetEditXSecFixedUVec (const std::string &xsec_id)
void	vsp::SetEditXSecFixedUVec (const std::string &xsec_id, std::vector< bool > fixed_u_vec)
void	vsp::ReparameterizeEditXSec (const std::string &xsec_id)

Detailed Description

Function Documentation

ConvertXSecToEdit()

void vsp::ConvertXSecToEdit ( const std::string & geom_id, const int & indx = 0 )

extern

Convert any XSec type into an EditCurveXSec. This function will work for BOR Geoms, in which case the input XSec index is ignored.

// Add Stack
string sid = AddGeom( "STACK", "" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( sid, 0 );
 
ChangeXSecShape( xsec_surf, 1, XS_ROUNDED_RECTANGLE );
 
// Convert Rounded Rectangle to Edit Curve type XSec
ConvertXSecToEdit( sid, 1 );
 
// Identify XSec 1
string xsec_1 = GetXSec( xsec_surf, 1 );
 
// Get the control points for the default shape
array < vec3d > xsec1_pts = GetEditXSecCtrlVec( xsec_1, true ); // The returned control points will not be scaled by width and height
 
// The section is an edit curve carrying a closed cubic Bezier, normalized
// to the unit box.
if ( GetXSecShape( xsec_1 ) != XS_EDIT_CURVE )
{
    Print( "ERROR: the section is not an edit curve" );
    __failure++;
}
 
if ( xsec1_pts.size() < 4 )
{
    Print( "ERROR: the edit curve carries too few control points" );
    __failure++;
}
else if ( dist( xsec1_pts[0], xsec1_pts[xsec1_pts.size() - 1] ) > 1e-9 )
{
    Print( "ERROR: the edit curve does not close" );
    __failure++;
}

Parameters

[in]	geom_id	string Geom ID
[in]	indx	int XSec index

EditXSecConvertTo()

void vsp::EditXSecConvertTo ( const std::string & xsec_id, const int & newtype )

extern

Convert the EditCurveXSec curve type to the specified new type. Note, EditCurveXSec uses the same enumerations for PCurve to identify curve type, but APPROX_CEDIT is not supported at this time.

// Add Stack
string sid = AddGeom( "STACK", "" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( sid, 0 );
 
ChangeXSecShape( xsec_surf, 1, XS_EDIT_CURVE );
 
// Identify XSec 1
string xsec_1 = GetXSec( xsec_surf, 1 );
 
// The default shape is a Bezier ellipse, stored in groups of three plus a
// closing point.
array< vec3d > @bezier_pts = GetEditXSecCtrlVec( xsec_1, true );
 
if ( bezier_pts.size() < 4 || ( bezier_pts.size() - 1 ) % 3 != 0 )
{
    Print( "ERROR: the edit curve did not start out as a cubic Bezier" );
    __failure++;
}
 
// Set XSec 1 to Linear
EditXSecConvertTo( xsec_1, LINEAR );
 
Update();
 
// A linear curve needs no interior control points, so the conversion drops
// them: the ellipse keeps only the points that were on the curve.
array< vec3d > @linear_pts = GetEditXSecCtrlVec( xsec_1, true );
 
if ( int( linear_pts.size() ) != ( int( bezier_pts.size() ) - 1 ) / 3 + 1 )
{
    Print( "ERROR: EditXSecConvertTo did not drop the interior control points" );
    __failure++;
}
 
// Converting back has to put them back.
EditXSecConvertTo( xsec_1, CEDIT );
 
Update();
 
if ( GetEditXSecCtrlVec( xsec_1, true ).size() != bezier_pts.size() )
{
    Print( "ERROR: EditXSecConvertTo would not convert back" );
    __failure++;
}

See also

PCURV_TYPE

Parameters

[in]	xsec_id	string XSec ID
[in]	newtype	int New curve type enum (i.e. CEDIT)

EditXSecDelPnt()

void vsp::EditXSecDelPnt ( const std::string & xsec_id, const int & indx )

extern

Delete an EditCurveXSec control point. Note, cubic Bezier intermediate control points (those not on the curve) cannot be deleted. The previous and next Bezier control point will be deleted along with the point on the curve. Regardless of curve type, the first and last points may not be deleted.

// Add Stack
string sid = AddGeom( "STACK", "" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( sid, 0 );
 
ChangeXSecShape( xsec_surf, 2, XS_EDIT_CURVE );
 
// Identify XSec 2
string xsec_2 = GetXSec( xsec_surf, 2 );
 
// Turn off R/L symmetry
SetParmVal( GetXSecParm( xsec_2, "SymType"), SYM_NONE );
 
array < vec3d > old_pnts = GetEditXSecCtrlVec( xsec_2, true ); // The returned control points will not be scaled by width and height
 
EditXSecDelPnt( xsec_2, 3 ); // Remove control point at bottom of circle
 
array < vec3d > new_pnts = GetEditXSecCtrlVec( xsec_2, true ); // The returned control points will not be scaled by width and height
 
if ( old_pnts.size() - new_pnts.size() != 3  )
{
    Print( "Error: EditXSecDelPnt");
    __failure++;
}

Parameters

[in]	xsec_id	string XSec ID
[in]	indx	int Control point index

EditXSecInitShape()

void vsp::EditXSecInitShape ( const std::string & xsec_id )

extern

Initialize the EditCurveXSec to the current value of m_ShapeType (i.e. EDIT_XSEC_ELLIPSE)

// Add Stack
string sid = AddGeom( "STACK", "" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( sid, 0 );
 
ChangeXSecShape( xsec_surf, 2, XS_EDIT_CURVE );
 
// Identify XSec 2
string xsec_2 = GetXSec( xsec_surf, 2 );
 
// Set XSec 2 to linear
EditXSecConvertTo( xsec_2, LINEAR );
 
array< vec3d > @linear_pts = GetEditXSecCtrlVec( xsec_2, true );
 
EditXSecInitShape( xsec_2 ); // Change back to default ellipse
 
Update();
 
// The default ellipse is a four point Bezier, so it carries more control
// points than the linear square it replaced.
array< vec3d > @ellipse_pts = GetEditXSecCtrlVec( xsec_2, true );
 
if ( ellipse_pts.size() < 4 || ( ellipse_pts.size() - 1 ) % 3 != 0 )
{
    Print( "ERROR: EditXSecInitShape did not restore a cubic Bezier" );
    __failure++;
}
 
if ( ellipse_pts.size() <= linear_pts.size() )
{
    Print( "ERROR: EditXSecInitShape did not rebuild the control points" );
    __failure++;
}
 
// The ellipse is symmetric about both axes, so it stays inside the unit box
// the control points are normalized to.
for ( int i = 0; i < int( ellipse_pts.size() ); i++ )
{
    if ( abs( ellipse_pts[i].x() ) > 0.5 + 1e-9 || abs( ellipse_pts[i].y() ) > 0.5 + 1e-9 )
    {
        Print( "ERROR: the rebuilt shape is not normalized" );
        __failure++;
    }
}

See also

INIT_EDIT_XSEC_TYPE

Parameters

[in]

xsec_id

string XSec ID

EditXSecSplit01()

int vsp::EditXSecSplit01 ( const std::string & xsec_id, const double & u )

extern

Split the EditCurveXSec at the specified U value

// Add Stack
string sid = AddGeom( "STACK", "" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( sid, 0 );
 
ChangeXSecShape( xsec_surf, 2, XS_EDIT_CURVE );
 
// Identify XSec 2
string xsec_2 = GetXSec( xsec_surf, 2 );
 
// Turn off R/L symmetry
SetParmVal( GetXSecParm( xsec_2, "SymType"), SYM_NONE );
 
array < vec3d > old_pnts = GetEditXSecCtrlVec( xsec_2, true ); // The returned control points will not be scaled by width and height
 
int new_pnt_ind = EditXSecSplit01( xsec_2, 0.375 );
 
array < vec3d > new_pnts = GetEditXSecCtrlVec( xsec_2, true ); // The returned control points will not be scaled by width and height
 
if ( new_pnts.size() - old_pnts.size() != 3  )
{
    Print( "Error: EditXSecSplit01");
    __failure++;
}

Parameters

[in]	xsec_id	string XSec ID
[in]	u	double U value to split the curve at (0 - 1)

Returns

int Index of the point added from the split

GetEditXSecCtrlVec()

std::vector< vec3d > vsp::GetEditXSecCtrlVec ( const std::string & xsec_id, bool non_dimensional = true )

extern

Get the control point vector for an EditCurveXSec. Note, the returned array of vec3d values will be represented in 2D with Z set to 0.

// Add Stack
string sid = AddGeom( "STACK", "" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( sid, 0 );
 
ChangeXSecShape( xsec_surf, 1, XS_EDIT_CURVE );
 
// Identify XSec 1
string xsec_1 = GetXSec( xsec_surf, 1 );
 
// Get the control points for the default shape
array < vec3d > xsec1_pts = GetEditXSecCtrlVec( xsec_1, true ); // The returned control points will not be scaled by width and height
if ( xsec1_pts.length() == 0 )
{
    Print( "ERROR: GetEditXSecCtrlVec returned nothing" );
    __failure++;
}
 
Print( "Normalized Bottom Point of XSecCurve: " + xsec1_pts[3].x() + ", " + xsec1_pts[3].y() + ", " + xsec1_pts[3].z() );

Parameters

[in]	xsec_id	string XSec ID
[in]	non_dimensional	bool True to get the points non-dimensionalized, False to get them scaled by m_Width and m_Height

Returns

vector <vec3d> Array of control points

GetEditXSecFixedUVec()

std::vector< bool > vsp::GetEditXSecFixedUVec ( const std::string & xsec_id )

extern

Get the vector of fixed U flags for each control point in an EditCurveXSec. The fixed U flag is used to hold the U parameter of the control point constant when performing an equal arc length reparameterization of the curve.

// Add Wing
string wid = AddGeom( "WING" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( wid, 0 );
 
ChangeXSecShape( xsec_surf, 1, XS_EDIT_CURVE );
 
// Identify XSec 1
string xsec_1 = GetXSec( xsec_surf, 1 );
 
array < bool > @ fixed_u_vec = GetEditXSecFixedUVec( xsec_1 );
if ( fixed_u_vec.length() == 0 )
{
    Print( "ERROR: GetEditXSecFixedUVec returned nothing" );
    __failure++;
}
 
fixed_u_vec[3] = true; // change a flag
 
SetEditXSecFixedUVec( xsec_1, fixed_u_vec );
 
array < vec3d > before_pts = GetEditXSecCtrlVec( xsec_1, true );
 
ReparameterizeEditXSec( xsec_1 );
 
Update();
 
// Reparameterizing redistributes U without changing the shape, so the same
// control points are still there.
array < vec3d > after_pts = GetEditXSecCtrlVec( xsec_1, true );
 
if ( after_pts.size() != before_pts.size() )
{
    Print( "ERROR: ReparameterizeEditXSec changed the number of control points" );
    __failure++;
}
 
// The U values stay in order over the unit interval.
array < double > u_vec = GetEditXSecUVec( xsec_1 );
 
if ( u_vec.size() != after_pts.size() )
{
    Print( "ERROR: the U vector does not match the control points" );
    __failure++;
}
else
{
    if ( !closeTo( u_vec[0], 0.0, 1e-9 ) || !closeTo( u_vec[u_vec.size() - 1], 1.0, 1e-9 ) )
    {
        Print( "ERROR: the U vector does not span the curve" );
        __failure++;
    }
 
    for ( int i = 1; i < int( u_vec.size() ); i++ )
    {
        if ( u_vec[i] < u_vec[i - 1] )
        {
            Print( "ERROR: the U vector is not increasing at " + i );
            __failure++;
        }
    }
}

See also

SetEditXSecFixedUVec, ReparameterizeEditXSec

Parameters

[in]

xsec_id

string XSec ID

Returns

vector <bool> Array of bool values for each control point

GetEditXSecUVec()

std::vector< double > vsp::GetEditXSecUVec ( const std::string & xsec_id )

extern

Get the U parameter vector for an EditCurveXSec. The vector will be in increasing order with a range of 0 - 1.

// Add Stack
string sid = AddGeom( "STACK", "" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( sid, 0 );
 
ChangeXSecShape( xsec_surf, 2, XS_EDIT_CURVE );
 
// Identify XSec 2
string xsec_2 = GetXSec( xsec_surf, 2 );
 
// Set XSec 2 to linear
EditXSecConvertTo( xsec_2, LINEAR );
 
array < double > u_vec = GetEditXSecUVec( xsec_2 );
 
if ( u_vec[1] - 0.25 > 1e-6 )
{
    Print( "Error: GetEditXSecUVec" );
    __failure++;
}

Parameters

[in]

xsec_id

string XSec ID

Returns

vector <double> Array of U parameter values

MoveEditXSecPnt()

void vsp::MoveEditXSecPnt ( const std::string & xsec_id, const int & indx, const vec3d & new_pnt )

extern

Move an EditCurveXSec control point. The XSec points are nondimensionalized by m_Width and m_Height and defined in 2D, so the Z value of the new coordinate point will be ignored.

// Add Stack
string sid = AddGeom( "STACK", "" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( sid, 0 );
 
ChangeXSecShape( xsec_surf, 1, XS_EDIT_CURVE );
 
// Identify XSec 1
string xsec_1 = GetXSec( xsec_surf, 1 );
 
// Turn off R/L symmetry
SetParmVal( GetXSecParm( xsec_1, "SymType"), SYM_NONE );
 
// Get the control points for the default shape
array < vec3d > xsec1_pts = GetEditXSecCtrlVec( xsec_1, true ); // The returned control points will not be scaled by width and height
 
// Identify a control point that lies on the curve and shift it in Y
int move_pnt_ind = 3;
 
vec3d new_pnt = vec3d( xsec1_pts[move_pnt_ind].x(), 2 * xsec1_pts[move_pnt_ind].y(), 0.0 );
 
// Move the control point
MoveEditXSecPnt( xsec_1, move_pnt_ind, new_pnt );
 
array < vec3d > new_pnts = GetEditXSecCtrlVec( xsec_1, true ); // The returned control points will not be scaled by width and height
 
if ( dist( new_pnt, new_pnts[move_pnt_ind] ) > 1e-6 )
{
    Print( "Error: MoveEditXSecPnt" );
    __failure++;
}

Parameters

[in]	xsec_id	string XSec ID
[in]	indx	int Control point index
[in]	new_pnt	vec3d Coordinate of the new point

ReparameterizeEditXSec()

void vsp::ReparameterizeEditXSec ( const std::string & xsec_id )

extern

Perform an equal arc length repareterization on an EditCurveXSec. The reparameterization is performed between specific U values if the Fixed U flag is true. This allows corners, such as at 0.25, 0.5, and 0.75 U, to be held constant while everything between them is reparameterized.

// Add Wing
string wid = AddGeom( "WING" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( wid, 0 );
 
ChangeXSecShape( xsec_surf, 1, XS_EDIT_CURVE );
 
// Identify XSec 1
string xsec_1 = GetXSec( xsec_surf, 1 );
 
array < bool > @ fixed_u_vec = GetEditXSecFixedUVec( xsec_1 );
 
fixed_u_vec[3] = true; // change a flag
 
SetEditXSecFixedUVec( xsec_1, fixed_u_vec );
 
array < vec3d > before_pts = GetEditXSecCtrlVec( xsec_1, true );
 
ReparameterizeEditXSec( xsec_1 );
 
Update();
 
// Reparameterizing redistributes U without changing the shape, so the same
// control points are still there.
array < vec3d > after_pts = GetEditXSecCtrlVec( xsec_1, true );
 
if ( after_pts.size() != before_pts.size() )
{
    Print( "ERROR: ReparameterizeEditXSec changed the number of control points" );
    __failure++;
}
 
// The U values stay in order over the unit interval.
array < double > u_vec = GetEditXSecUVec( xsec_1 );
 
if ( u_vec.size() != after_pts.size() )
{
    Print( "ERROR: the U vector does not match the control points" );
    __failure++;
}
else
{
    if ( !closeTo( u_vec[0], 0.0, 1e-9 ) || !closeTo( u_vec[u_vec.size() - 1], 1.0, 1e-9 ) )
    {
        Print( "ERROR: the U vector does not span the curve" );
        __failure++;
    }
 
    for ( int i = 1; i < int( u_vec.size() ); i++ )
    {
        if ( u_vec[i] < u_vec[i - 1] )
        {
            Print( "ERROR: the U vector is not increasing at " + i );
            __failure++;
        }
    }
}

See also

SetEditXSecFixedUVec, GetEditXSecFixedUVec

Parameters

[in]

xsec_id

string XSec ID

SetEditXSecFixedUVec()

void vsp::SetEditXSecFixedUVec ( const std::string & xsec_id, std::vector< bool > fixed_u_vec )

extern

Set the vector of fixed U flags for each control point in an EditCurveXSec. The fixed U flag is used to hold the U parameter of the control point constant when performing an equal arc length reparameterization of the curve.

// Add Wing
string wid = AddGeom( "WING" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( wid, 0 );
 
ChangeXSecShape( xsec_surf, 1, XS_EDIT_CURVE );
 
// Identify XSec 1
string xsec_1 = GetXSec( xsec_surf, 1 );
 
array < bool > @ fixed_u_vec = GetEditXSecFixedUVec( xsec_1 );
 
fixed_u_vec[3] = true; // change a flag
 
SetEditXSecFixedUVec( xsec_1, fixed_u_vec );
 
if ( GetEditXSecFixedUVec( xsec_1 ).length() != fixed_u_vec.length() )
{
    Print( "ERROR: SetEditXSecFixedUVec length" );
    __failure++;
}
 
ReparameterizeEditXSec( xsec_1 );

See also

GetEditXSecFixedUVec, ReparameterizeEditXSec

Parameters

[in]	xsec_id	string XSec ID
[in]	fixed_u_vec	vector <bool> Array of fixed U flags

SetEditXSecPnts()

void vsp::SetEditXSecPnts ( const std::string & xsec_id, const std::vector< double > & u_vec, const std::vector< vec3d > & control_pts, const std::vector< double > & r_vec )

extern

Set the U parameter vector and the control point vector for an EditCurveXSec. The arrays must be of equal length, with the values for U defined in increasing order and range 0 - 1. The input control points to SetEditXSecPnts must be nondimensionalized in the approximate range of [-0.5, 0.5].

// Add Stack
string sid = AddGeom( "STACK", "" );
 
// Get First (and Only) XSec Surf
string xsec_surf = GetXSecSurf( sid, 0 );
 
ChangeXSecShape( xsec_surf, 2, XS_EDIT_CURVE );
 
// Identify XSec 2
string xsec_2 = GetXSec( xsec_surf, 2 );
 
// Set XSec 2 to linear
EditXSecConvertTo( xsec_2, LINEAR );
 
// Turn off R/L symmetry
SetParmVal( GetXSecParm( xsec_2, "SymType"), SYM_NONE );
 
// Define a square
array < vec3d > xsec2_pts(5);
 
xsec2_pts[0] = vec3d( 0.5, 0.5, 0.0 );
xsec2_pts[1] = vec3d( 0.5, -0.5, 0.0 );
xsec2_pts[2] = vec3d( -0.5, -0.5, 0.0 );
xsec2_pts[3] = vec3d( -0.5, 0.5, 0.0 );
xsec2_pts[4] = vec3d( 0.5, 0.5, 0.0 );
 
// u vec must start at 0.0 and end at 1.0
array < double > u_vec(5);
 
u_vec[0] = 0.0;
u_vec[1] = 0.25;
u_vec[2] = 0.5;
u_vec[3] = 0.75;
u_vec[4] = 1.0;
 
array < double > r_vec(5);
 
r_vec[0] = 0.0;
r_vec[1] = 0.0;
r_vec[2] = 0.0;
r_vec[3] = 0.0;
r_vec[4] = 0.0;
 
SetEditXSecPnts( xsec_2, u_vec, xsec2_pts, r_vec ); // Note: points are unscaled by the width and height parms
 
array < vec3d > new_pnts = GetEditXSecCtrlVec( xsec_2, true ); // The returned control points will not be scaled by width and height
 
if ( dist( new_pnts[3], xsec2_pts[3] ) > 1e-6 )
{
    Print( "Error: SetEditXSecPnts");
    __failure++;
}

Parameters

[in]	xsec_id	string XSec ID
[in]	u_vec	vector <double> Array of U parameter values
[in]	r_vec	vector <double> Array of R parameter values
[in]	control_pts	vector <vec3d> Nondimensionalized array of control points