User Tools

Site Tools


api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
api [2015/01/22 13:13]
jr [Custom Component Functions]
api [2019/11/09 18:36]
ramcdona removed
Line 26: Line 26:
 **void AddCFDSource( int [[api#CFD Mesh Source Type Enums|type]],​ const string & geom_id, int surf_index, double l1, double r1, double u1, double w1, double l2 = 0, double r2 = 0, double u2 = 0, double w2 = 0 )**\\ **void AddCFDSource( int [[api#CFD Mesh Source Type Enums|type]],​ const string & geom_id, 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 source of specified type to geom.  l1 = length of tri, r1 = radius of source, u1 and w1 are parametric coordinates. Add a CFD mesh source of specified type to geom.  l1 = length of tri, r1 = radius of source, u1 and w1 are parametric coordinates.
 +
  
 ==== ErrorObj Class ==== ==== ErrorObj Class ====
Line 34: Line 35:
 **string ErrorObj::​GetErrorString()** **string ErrorObj::​GetErrorString()**
 Return the error string from this error object.\\ Return the error string from this error object.\\
 +
  
 ==== Error Functions ==== ==== Error Functions ====
Line 46: Line 48:
 **VSPExit( int error_code )** **VSPExit( int error_code )**
 Exits program with provided error code\\ Exits program with provided error code\\
 +
  
 ==== File I/O Functions ==== ==== File I/O Functions ====
 +**string GetVSPFileName()**\\
 **void ReadVSPFile( string file_name )** **void ReadVSPFile( string file_name )**
 Read a vsp geometry file. Clear old geometry first.\\ Read a vsp geometry file. Clear old geometry first.\\
Line 58: Line 62:
 **string ImportFile( string file_name, int [[api#​Import Type Enums|import_type]],​ string parent )** **string ImportFile( string file_name, int [[api#​Import Type Enums|import_type]],​ string parent )**
 Import a file and insert it as a child of parent. \\ Import a file and insert it as a child of parent. \\
 +
  
 ==== Geom ==== ==== Geom ====
Line 88: Line 93:
 **string AddSubSurf( string geom_id, int [[api#Sub Surface Type Enums|set]] )** **string AddSubSurf( string geom_id, int [[api#Sub Surface Type Enums|set]] )**
 Add a sub surface to the geometry. A string ID is returned which can be used with FindParm to edit the sub surface.\\ Add a sub surface to the geometry. A string ID is returned which can be used with FindParm to edit the sub surface.\\
-**string GetSubSurf( string geom_id, int index )** 
-Get a sub surface id given geometry ID and index.\\ 
 **void DeleteSubSurf( string geom_id, string subsurf_id )** **void DeleteSubSurf( string geom_id, string subsurf_id )**
 Delete sub surface given geom ID and sub surface ID.\\ Delete sub surface given geom ID and sub surface ID.\\
Line 100: Line 103:
 **void InsertXSec( strin geom_id, int index, int type )** **void InsertXSec( strin geom_id, int index, int type )**
 Insert xsec of provided type after index.\\ Insert xsec of provided type after index.\\
 +
 +
 +==== Wing Section Functions ====
 +**void SetDriverGroup(const string&​in,​ int, int, int, int)**\\
 +
 +
 +==== Container Functions ====
 +**array<​string>​@ FindContainers()**\\
 +**array<​string>​@ FindContainersWithName(const string&​in)**\\
 +**string FindContainer(const string&​in,​ int)**\\
 +**string GetContainerName(const string&​in)**\\
 +**array<​string>​@ FindContainerGroupNames(const string&​in)**\\
 +**array<​string>​@ FindContainerParmIDs(const string&​in)**\\
 +
  
 ==== Matrix4d Class ==== ==== Matrix4d Class ====
Line 132: Line 149:
 **void Matrix4d::​buildXForm(vec3d pos, vec3d rot, vec3d center_of_rot)** **void Matrix4d::​buildXForm(vec3d pos, vec3d rot, vec3d center_of_rot)**
 Build a matrix to translate to pos and rot about center of rotation.\\ Build a matrix to translate to pos and rot about center of rotation.\\
 +
  
 ==== Parm Functions ==== ==== Parm Functions ====
Line 166: Line 184:
 **string GetParmName( string parm_id )** **string GetParmName( string parm_id )**
 Returns parm name string.\\ Returns parm name string.\\
 +**string GetParmGroupName(const string&​in)**\\
 +**string GetParmDisplayGroupName(const string&​in)**\\
 **string GetParmContainer( string parm_id )** **string GetParmContainer( string parm_id )**
 Returns the parm container'​s id string.\\ Returns the parm container'​s id string.\\
Line 172: Line 192:
 **string FindParm( string parm_container_id,​ string name, string group )** **string FindParm( string parm_container_id,​ string name, string group )**
 Find a parm ID given parm container id, name and group.\\ Find a parm ID given parm container id, name and group.\\
 +
  
 ==== Results ==== ==== Results ====
Line 202: Line 223:
 **void WriteResultsCSVFile(string id, string file_name )** **void WriteResultsCSVFile(string id, string file_name )**
 Write the specified results to a csv file.\\ Write the specified results to a csv file.\\
 +**WriteTestResults()**\\
 +
  
 ==== Set Functions ==== ==== Set Functions ====
Line 218: Line 241:
 **void SetSetFlag( string geom_id, int set_index, bool flag )** **void SetSetFlag( string geom_id, int set_index, bool flag )**
 Set the geometry set flag.\\ Set the geometry set flag.\\
 +
  
 ==== Utility Functions==== ==== Utility Functions====
Line 236: Line 260:
 **double Deg2Rad( double )**                **double Deg2Rad( double )**               
 Convert degrees to radians.\\ ​ Convert degrees to radians.\\ ​
 +
  
 ==== vec3d Class ==== ==== vec3d Class ====
Line 312: Line 337:
 **vec3d RotateArbAxis(vec3d p, double theta, vec3d axis )** **vec3d RotateArbAxis(vec3d p, double theta, vec3d axis )**
 Rotate the vector about an arbitrary axis.\\ Rotate the vector about an arbitrary axis.\\
 +**array<​vec3d>​@ GetProxyVec3dArray()**\\
 +**void SetVec3dArray(array<​vec3d>​@)**\\
  
 ==== Vehicle Functions ==== ==== Vehicle Functions ====
Line 318: Line 345:
 **void ClearVSPModel()** **void ClearVSPModel()**
 Clear all geometry.\\ Clear all geometry.\\
 +
  
 ==== XSec ==== ==== XSec ====
Line 350: Line 378:
 **void ResetXSecSkinParms( string xsec_id )** **void ResetXSecSkinParms( string xsec_id )**
 Reset all xsec skim parms to default\\ Reset all xsec skim parms to default\\
 +**void ReadFileAirfoil(const string&​in,​ const string&​in)**\\
 +**void SetAirfoilPnts(const string&​in,​ array<​vec3d>​@,​ array<​vec3d>​@)**\\
 +**array<​vec3d>​@ GetAirfoilUpperPnts(const string&​in)**\\
 +**array<​vec3d>​@ GetAirfoilLowerPnts(const string&​in)**\\
  
  
Line 377: Line 409:
 **string GetCurrCustomGeom()** **string GetCurrCustomGeom()**
 Return the current active custom geom id.\\ Return the current active custom geom id.\\
 +**string GetCustomParm( int )**\\
 **int AddGui( int [[api#GUI Device Enums|type]],​ string label = string(), string parm_name = string(), string group_name = string(), double range = 10.0 )** **int AddGui( int [[api#GUI Device Enums|type]],​ string label = string(), string parm_name = string(), string group_name = string(), double range = 10.0 )**
 Add a GUI device the the custom geom definition. ​ If parm_name and group_name are provided then UpdateGui is not required.\\ Add a GUI device the the custom geom definition. ​ If parm_name and group_name are provided then UpdateGui is not required.\\
 +**void UpdateGui( int, const string & in )**\\
 **string AddXSecSurf()** **string AddXSecSurf()**
 Add a cross-section surface to the active custom component. ​ Returns xsecsurf id string.\\ Add a cross-section surface to the active custom component. ​ Returns xsecsurf id string.\\
Line 389: Line 423:
 **void CloneSurf(int index, Matrix4d mat)** **void CloneSurf(int index, Matrix4d mat)**
 Clone the xsec surf and transform by mat.\\ Clone the xsec surf and transform by mat.\\
 +**void TransformSurf( int, Matrix4d & in )**\\
 +**void SetVspSurfType(int,​ int = - 1)**\\
 +**void SetVspSurfCfdType(int,​ int = - 1)**\\
 **void SetCustomXSecLoc( string xsec_id, vec3d loc )** **void SetCustomXSecLoc( string xsec_id, vec3d loc )**
 Set the cross section location.\\ Set the cross section location.\\
 +**vec3d GetCustomXSecLoc(const string&​in)**\\
 **void SetCustomXSecRot( string xsec_id, vec3d rot )** **void SetCustomXSecRot( string xsec_id, vec3d rot )**
 Set the cross section rotation.\\ Set the cross section rotation.\\
 +**vec3d GetCustomXSecRot(const string&​in)**\\
 **bool CheckClearTriggerEvent( int gui_id )** **bool CheckClearTriggerEvent( int gui_id )**
 Check for a trigger event and clear trigger if found.\\ Check for a trigger event and clear trigger if found.\\
-**void ​AppendCustomXSec( string ​xsec_id, int xsec_surf_id,​ int [[api#Cross Sections Curve Type Enums|type]] ​ )** +**void ​SetupCustomDefaultSource(int,​ int, double, double, double, double, double = 0, double = 0, double = 0, double = 0)**\\ 
-Append a xsec to the xsec_surf\\+**void ClearAllCustomDefaultSources()**\\ 
 +**void SetCustomCenter(double,​ double, double)**\\ 
 +**string AppendXSec(const string&inint)**\\ 
 +**string AppendCustomXSec( ​int xsec_surf_id,​ int [[api#Cross Sections Curve Type Enums|type]] ​ )** 
 +Append a xsec to the xsec_surf. Returns xsec id.\\ 
 +**void CutCustomXSec( sint xsec_surf_id,​ int index )** 
 +Cut the xsec at index\\ 
 +**void CopyCustomXSec( sint xsec_surf_id,​ int index )** 
 +Copy the xsec at index to the clipboard.\\ 
 +**void PasteCustomXSec( sint xsec_surf_id,​ int index )** 
 +Paste clipboard xsec to index\\ 
 +**string InsertCustomXSec( int xsec_surf_id,​ int index, int [[api#Cross Sections Curve Type Enums|type]] ​ )** 
 +Insert a xsec to the xsec_surf after index.\\
  
 +
 +==== Advanced Parameter Link Functions ====
 +**void AddInput(const string&​in,​ int, const string&​in,​ const string&​in,​ const string&​in)**\\
 +**void AddOutput(const string&​in,​ int, const string&​in,​ const string&​in,​ const string&​in)**\\
 +**void SetVar(const string&​in,​ double)**\\
 +**double GetVar(const string&​in)**\\
 +
 +
 +==== Design Variable Functions ====
 +**void ReadApplyDESFile(const string&​in)**\\
 +**void WriteDESFile(const string&​in)**\\
 +**void ReadApplyXDDMFile(const string&​in)**\\
 +**void WriteXDDMFile(const string&​in)**\\
 +**int GetNumDesignVars()**\\
 +**void AddDesignVar(const string&​in,​ int)**\\
 +**void DeleteAllDesignVars()**\\
 +**string GetDesignVar(int)**\\
 +**int GetDesignVarType(int)**\\
  
 ===== Script/API Enums ===== ===== Script/API Enums =====
 +
 +==== Absolute or Relative Flag Enums ====
 +**ABS**\\
 +**REL**\\
  
 ==== CFD Control Type Enums ==== ==== CFD Control Type Enums ====
Line 414: Line 487:
 **CFD_FAR_MAX_GAP**\\ **CFD_FAR_MAX_GAP**\\
 **CFD_FAR_NUM_CIRCLE_SEGS**\\ **CFD_FAR_NUM_CIRCLE_SEGS**\\
-**CFD_FAR_LENGTH**\\ 
 **CFD_FAR_SIZE_ABS_FLAG**\\ **CFD_FAR_SIZE_ABS_FLAG**\\
 +**CFD_FAR_LENGTH**\\
 +**CFD_FAR_WIDTH**\\
 **CFD_FAR_HEIGHT**\\ **CFD_FAR_HEIGHT**\\
 **CFD_FAR_X_SCALE**\\ **CFD_FAR_X_SCALE**\\
Line 426: Line 500:
 **CFD_WAKE_SCALE**\\ **CFD_WAKE_SCALE**\\
 **CFD_WAKE_ANGLE**\\ **CFD_WAKE_ANGLE**\\
-**CFD_MAX_GAP**\\ 
  
 ==== CFD Mesh Source Type Enums ==== ==== CFD Mesh Source Type Enums ====
Line 432: Line 505:
 **LINE_SOURCE**\\ **LINE_SOURCE**\\
 **BOX_SOURCE**\\ **BOX_SOURCE**\\
 +
 +==== VSP Surface Behavior Type Enums ====
 +**NORMAL_SURF**\\
 +**WING_SURF**\\
 +**DISK_SURF**\\
 +
 +==== VSP CFD Surface Behavior Type Enums ====
 +**CFD_NORMAL**\\
 +**CFD_NEGATIVE**\\
 +**CFD_TRANSPARENT**\\
 +
 ==== Computation File Enums ==== ==== Computation File Enums ====
 **NO_FILE_TYPE**\\ **NO_FILE_TYPE**\\
Line 441: Line 525:
 **DEGEN_GEOM_CSV_TYPE**\\ **DEGEN_GEOM_CSV_TYPE**\\
 **DEGEN_GEOM_M_TYPE**\\ **DEGEN_GEOM_M_TYPE**\\
 +**CFD_STL_TYPE**\\
 +**CFD_POLY_TYPE**\\
 +**CFD_TRI_TYPE**\\
 +**CFD_OBJ_TYPE**\\
 +**CFD_DAT_TYPE**\\
 +**CFD_KEY_TYPE**\\
 +**CFD_GMSH_TYPE**\\
 +**CFD_SRF_TYPE**\\
 +**CFD_TKEY_TYPE**\\
  
 ==== Cross Section Type Enums ==== ==== Cross Section Type Enums ====
Line 471: Line 564:
 **XS_SHIFT_MID**\\ **XS_SHIFT_MID**\\
 **XS_SHIFT_TE**\\ **XS_SHIFT_TE**\\
 +
 +==== Wing Driver Selection Enums ====
 +**AR_WSECT_DRIVER**\\
 +**SPAN_WSECT_DRIVER**\\
 +**AREA_WSECT_DRIVER**\\
 +**TAPER_WSECT_DRIVER**\\
 +**AVEC_WSECT_DRIVER**\\
 +**ROOTC_WSECT_DRIVER**\\
 +**TIPC_WSECT_DRIVER**\\
 +**SECSWEEP_WSECT_DRIVER**\\
 +
 +==== Cross Section Closure Type Enums ====
 +**CLOSE_NONE**\\
 +**CLOSE_SKEWLOW**\\
 +**CLOSE_SKEWUP**\\
 +**CLOSE_SKEWBOTH**\\
 +**CLOSE_EXTRAP**\\
 +**CLOSE_NUM_TYPES**\\
 +
 +==== Cross Section Trim Type Enums ====
 +**TRIM_NONE**\\
 +**TRIM_X**\\
 +**TRIM_THICK**\\
 +**TRIM_NUM_TYPES**\\
  
 ==== Direction Index Enums ==== ==== Direction Index Enums ====
Line 476: Line 593:
 **Y_DIR**\\ **Y_DIR**\\
 **Z_DIR**\\ **Z_DIR**\\
 +
 +==== Symmetry Code Enums ====
 +**SYM_XY**\\
 +**SYM_XZ**\\
 +**SYM_YZ**\\
 +**SYM_ROT_X**\\
 +**SYM_ROT_Y**\\
 +**SYM_ROT_Z**\\
 +**SYM_PLANAR_TYPES**\\
 +**SYM_NUM_TYPES**\\
  
 ==== Error Code Enums ==== ==== Error Code Enums ====
Line 495: Line 622:
 **EXPORT_XSEC**\\ **EXPORT_XSEC**\\
 **EXPORT_STL**\\ **EXPORT_STL**\\
-**EXPORT_RHINO3D**\\ 
 **EXPORT_AWAVE**\\ **EXPORT_AWAVE**\\
 **EXPORT_NASCART**\\ **EXPORT_NASCART**\\
Line 504: Line 630:
 **EXPORT_GMSH**\\ **EXPORT_GMSH**\\
 **EXPORT_X3D**\\ **EXPORT_X3D**\\
-**EXPORT_BEZ**\\ 
  
 ==== GUI Device Enums ==== ==== GUI Device Enums ====
 **GDEV_TAB**\\ **GDEV_TAB**\\
 +**GDEV_SCROLL_TAB**\\
 **GDEV_GROUP**\\ **GDEV_GROUP**\\
 **GDEV_PARM_BUTTON**\\ **GDEV_PARM_BUTTON**\\
Line 540: Line 666:
 **IMPORT_NASCART**\\ **IMPORT_NASCART**\\
 **IMPORT_CART3D_TRI**\\ **IMPORT_CART3D_TRI**\\
-**IMPORT_XSEC_SURF**\\ 
 **IMPORT_XSEC_MESH**\\ **IMPORT_XSEC_MESH**\\
 +**IMPORT_PTS**\\
  
 ==== Parm Type Enums ==== ==== Parm Type Enums ====
Line 560: Line 686:
 **SS_RECTANGLE**\\ **SS_RECTANGLE**\\
 **SS_ELLIPSE**\\ **SS_ELLIPSE**\\
 +
 +==== XDDM Quantity Type Enums ====
 +**XDDM_VAR**\\
 +**XDDM_CONST**\\
 +
 +
 +
 ===== AngelScript Functions And Classes ===== ===== AngelScript Functions And Classes =====