This group of API functions pertains to general surface queries for Geom surfaces, such as computing 3D location from surface coordinates, identifying curvature, and performing point projections.
Click here to return to the main page.
More...
Functions | |
vec3d | CompPnt01 (const string &in geom_id, const int &in surf_indx, const double &in u, const double &in w) |
vec3d | CompNorm01 (const string &in geom_id, const int &in surf_indx, const double &in u, const double &in w) |
vec3d | CompTanU01 (const string &in geom_id, const int &in surf_indx, const double &in u, const double &in w) |
vec3d | CompTanW01 (const string &in geom_id, const int &in surf_indx, const double &in u, const double &in w) |
void | CompCurvature01 (const string &in geom_id, const int &in surf_indx, const double &in u, const double &in w, double &out k1, double &out k2, double &out ka, double &out kg) |
double | ProjPnt01 (const string &in geom_id, const int &in surf_indx, const vec3d &in pt, double &out u, double &out w) |
double | ProjPnt01I (const string &in geom_id, const vec3d &in pt, int &out surf_indx, double &out u, double &out w) |
double | ProjPnt01Guess (const string &in geom_id, const int &in surf_indx, const vec3d &in pt, const double &in u0, const double &in w0, double &out u, double &out w) |
double | AxisProjPnt01 (const string &in geom_id, const int &in surf_indx, const int &in iaxis, const vec3d &in pt, double &out u_out, double &out w_ou, vec3d &out p_out) |
double | AxisProjPnt01I (const string &in geom_id, const int &in iaxis, const vec3d &in pt, int &out surf_indx_out, double &out u_out, double &out w_out, vec3d &out p_out) |
double | AxisProjPnt01Guess (const string &in geom_id, const int &in surf_indx, const int &in iaxis, const vec3d &in pt, const double &in u0, const double &in w0, double &out u_out, double &out w_out, vec3d &out p_out) |
void | GetUWTess01 (const string &in geom_id, int &in surf_indx, double[]@ us, double[]@ ws) |
vec3d [] | CompVecPnt01 (const string &in geom_id, const int &in surf_indx, double[]@ us, double[]@ ws) |
vec3d [] | CompVecNorm01 (const string &in geom_id, const int &in surf_indx, double[]@ us, double[]@ ws) |
void | CompVecCurvature01 (const string &in geom_id, const int &in surf_indx, double[]@ us, double[]@ ws, double[]@ k1s, double[]@ k2s, double[]@ kas, double[]@ kgs) |
void | ProjVecPnt01 (const string &in geom_id, const int &in surf_indx, vec3d[]@ pts, double[]@ us, double[]@ ws, double[]@ ds) |
void | ProjVecPnt01Guess (const string &in geom_id, const int &in surf_indx, vec3d[]@ pts, double[]@ u0s, double[]@ w0s, double[]@ us, double[]@ ws, double[]@ ds) |
void | AxisProjVecPnt01 (const string &in geom_id, const int &in surf_indx, const int &in iaxis, vec3d[]@ pts, double[]@ us, double[]@ ws, vec3d[]@ ps_out, double[]@ ds) |
void | AxisProjVecPnt01Guess (const string &in geom_id, int &in surf_indx, const int &in iaxis, vec3d[]@ pts, double[]@ u0s, double[]@ w0s, double[]@ us, double[]@ ws, vec3d[]@ ps_out, double[]@ ds) |
double AxisProjPnt01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
const int &in | iaxis, | ||
const vec3d &in | pt, | ||
double &out | u_out, | ||
double &out | w_ou, | ||
vec3d &out | p_out | ||
) |
Project an input 3D coordinate point onto a surface along a specified axis. If the axis-aligned ray from the point intersects the surface multiple times, the nearest intersection is returned. If the axis-aligned ray from the point does not intersect the surface, the original point is returned and -1 is returned in the other output parameters.
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | iaxis | Axis direction to project point along (X_DIR, Y_DIR, or Z_DIR) |
[in] | pt | Input 3D coordinate point |
[out] | u_out | Output closest U (0 - 1) surface coordinate |
[out] | w_out | Output closest W (0 - 1) surface coordinate |
[out] | p_out | Output 3D coordinate point |
double AxisProjPnt01Guess | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
const int &in | iaxis, | ||
const vec3d &in | pt, | ||
const double &in | u0, | ||
const double &in | w0, | ||
double &out | u_out, | ||
double &out | w_out, | ||
vec3d &out | p_out | ||
) |
Project an input 3D coordinate point onto a surface along a specified axis given an initial guess of surface parameter. If the axis-aligned ray from the point intersects the surface multiple times, the nearest intersection is returned. If the axis-aligned ray from the point does not intersect the surface, the original point is returned and -1 is returned in the other output parameters. The surface parameter guess should allow this call to be faster than calling AxisProjPnt01 without a guess.
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | iaxis | Axis direction to project point along (X_DIR, Y_DIR, or Z_DIR) |
[in] | pt | Input 3D coordinate point |
[in] | u0 | Input U (0 - 1) surface coordinate guess |
[in] | w0 | Input W (0 - 1) surface coordinate guess |
[out] | u_out | Output closest U (0 - 1) surface coordinate |
[out] | w_out | Output closest W (0 - 1) surface coordinate |
[out] | p_out | Output 3D coordinate point |
double AxisProjPnt01I | ( | const string &in | geom_id, |
const int &in | iaxis, | ||
const vec3d &in | pt, | ||
int &out | surf_indx_out, | ||
double &out | u_out, | ||
double &out | w_out, | ||
vec3d &out | p_out | ||
) |
Project an input 3D coordinate point onto a Geom along a specified axis. The intersecting surface index is also returned. If the axis-aligned ray from the point intersects the Geom multiple times, the nearest intersection is returned. If the axis-aligned ray from the point does not intersect the Geom, the original point is returned and -1 is returned in the other output parameters.
[in] | geom_id | Parent Geom ID |
[in] | iaxis | Axis direction to project point along (X_DIR, Y_DIR, or Z_DIR) |
[in] | pt | Input 3D coordinate point |
[out] | surf_indx_out | Output main surface index from the parent Geom |
[out] | u_out | Output closest U (0 - 1) surface coordinate |
[out] | w_out | Output closest W (0 - 1) surface coordinate |
[out] | p_out | Output 3D coordinate point |
void AxisProjVecPnt01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
const int &in | iaxis, | ||
vec3d@ [] | pts, | ||
double@ [] | us, | ||
double@ [] | ws, | ||
vec3d@ [] | ps_out, | ||
double@ [] | ds | ||
) |
Project an input array of 3D coordinate points onto a surface along a specified axis. If the axis-aligned ray from the point intersects the surface multiple times, the nearest intersection is returned. If the axis-aligned ray from the point does not intersect the surface, the original point is returned and -1 is returned in the other output parameters.
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | iaxis | Axis direction to project point along (X_DIR, Y_DIR, or Z_DIR) |
[in] | pts | Input array of 3D coordinate points |
[out] | us | Output array of the closest U (0 - 1) surface coordinate for each 3D input point |
[out] | ws | Output array of the closest W (0 - 1) surface coordinate for each 3D input point |
[out] | ps_out | Output array of 3D coordinate point |
[out] | ds | Output array of axis distances for each 3D point and the projected point of the surface |
void AxisProjVecPnt01Guess | ( | const string &in | geom_id, |
int &in | surf_indx, | ||
const int &in | iaxis, | ||
vec3d@ [] | pts, | ||
double@ [] | u0s, | ||
double@ [] | w0s, | ||
double@ [] | us, | ||
double@ [] | ws, | ||
vec3d@ [] | ps_out, | ||
double@ [] | ds | ||
) |
Project an input array of 3D coordinate points onto a surface along a specified axis given initial guess arrays of surface parameter. If the axis-aligned ray from the point intersects the surface multiple times, the nearest intersection is returned. If the axis-aligned ray from the point does not intersect the surface, the original point is returned and -1 is returned in the other output parameters. The surface parameter guess should allow this call to be faster than calling AxisProjVecPnt01 without a guess.
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | iaxis | Axis direction to project point along (X_DIR, Y_DIR, or Z_DIR) |
[in] | pts | Input array of 3D coordinate points |
[in] | u0s | Input array of U (0 - 1) surface coordinate guesses |
[in] | w0s | Input array of W (0 - 1) surface coordinate guesses |
[out] | us | Output array of the closest U (0 - 1) surface coordinate for each 3D input point |
[out] | ws | Output array of the closest W (0 - 1) surface coordinate for each 3D input point |
[out] | ps_out | Output array of 3D coordinate point |
[out] | ds | Output array of axis distances for each 3D point and the projected point of the surface |
void CompCurvature01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
const double &in | u, | ||
const double &in | w, | ||
double &out | k1, | ||
double &out | k2, | ||
double &out | ka, | ||
double &out | kg | ||
) |
Determine the curvature of a specified surface at the input surface coordinate point
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | u | U (0 - 1) surface coordinate |
[in] | w | W (0 - 1) surface coordinate |
[out] | k1 | Output value of maximum principal curvature |
[out] | k2 | Output value of minimum principal curvature |
[out] | ka | Output value of mean curvature |
[out] | kg | Output value of Gaussian curvature |
vec3d CompNorm01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
const double &in | u, | ||
const double &in | w | ||
) |
Calculate the normal vector on the specified surface at input surface coordinate
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | u | U (0 - 1) surface coordinate |
[in] | w | W (0 - 1) surface coordinate |
vec3d CompPnt01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
const double &in | u, | ||
const double &in | w | ||
) |
Calculate the 3D coordinate equivalent for the input surface coordinate point
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | u | U (0 - 1) surface coordinate |
[in] | w | W (0 - 1) surface coordinate |
vec3d CompTanU01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
const double &in | u, | ||
const double &in | w | ||
) |
Calculate the vector tangent to the specified surface at input surface coordinate in the U direction
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | u | U (0 - 1) surface coordinate |
[in] | w | W (0 - 1) surface coordinate |
vec3d CompTanW01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
const double &in | u, | ||
const double &in | w | ||
) |
Calculate the vector tangent to the specified surface at input surface coordinate in the W direction
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | u | U (0 - 1) surface coordinate |
[in] | w | W (0 - 1) surface coordinate |
void CompVecCurvature01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
double@ [] | us, | ||
double@ [] | ws, | ||
double@ [] | k1s, | ||
double@ [] | k2s, | ||
double@ [] | kas, | ||
double@ [] | kgs | ||
) |
Determine the curvature of a specified surface at each surface coordinate point in the input arrays
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | us | Input array of U (0 - 1) surface coordinates |
[in] | ws | Input array of W (0 - 1) surface coordinates |
[out] | k1s | Output array of maximum principal curvatures |
[out] | k2s | Output array of minimum principal curvatures |
[out] | kas | Output array of mean curvatures |
[out] | kgs | Output array of Gaussian curvatures |
vec3d [] CompVecNorm01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
double@ [] | us, | ||
double@ [] | ws | ||
) |
Determine the normal vector on a surface for each surface coordinate point in the input arrays
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | us | Input array of U (0 - 1) surface coordinates |
[in] | ws | Input array of W (0 - 1) surface coordinates |
vec3d [] CompVecPnt01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
double@ [] | us, | ||
double@ [] | ws | ||
) |
Determine 3D coordinate for each surface coordinate point in the input arrays
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | us | Input array of U (0 - 1) surface coordinates |
[in] | ws | Input array of W (0 - 1) surface coordinates |
void GetUWTess01 | ( | const string &in | geom_id, |
int &in | surf_indx, | ||
double@ [] | us, | ||
double@ [] | ws | ||
) |
Get the surface coordinate point of each intersection of the tesselated wireframe for a particular surface
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[out] | us | Output array of U (0 - 1) surface coordinates |
[out] | ws | Output array of W (0 - 1) surface coordinates |
double ProjPnt01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
const vec3d &in | pt, | ||
double &out | u, | ||
double &out | w | ||
) |
Determine the nearest surface coordinate for an input 3D coordinate point and calculate the distance between the 3D point and the closest point of the surface.
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | pt | Input 3D coordinate point |
[out] | u | Output closest U (0 - 1) surface coordinate |
[out] | w | Output closest W (0 - 1) surface coordinate |
double ProjPnt01Guess | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
const vec3d &in | pt, | ||
const double &in | u0, | ||
const double &in | w0, | ||
double &out | u, | ||
double &out | w | ||
) |
Determine the nearest surface coordinate for an input 3D coordinate point and calculate the distance between the 3D point and the closest point of the surface. This function takes an input surface coordinate guess for, offering a potential decrease in computation time compared to ProjPnt01.
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | pt | Input 3D coordinate point |
[in] | u0 | Input U (0 - 1) surface coordinate guess |
[in] | w0 | Input W (0 - 1) surface coordinate guess |
[out] | u | Output closest U (0 - 1) surface coordinate |
[out] | w | Output closest W (0 - 1) surface coordinate |
double ProjPnt01I | ( | const string &in | geom_id, |
const vec3d &in | pt, | ||
int &out | surf_indx, | ||
double &out | u, | ||
double &out | w | ||
) |
Determine the nearest surface coordinate and corresponding parent Geom main surface index for an input 3D coordinate point. Return the distance between the closest point and the input.
[in] | geom_id | Parent Geom ID |
[in] | pt | Input 3D coordinate point |
[out] | surf_indx | Output main surface index from the parent Geom |
[out] | u | Output closest U (0 - 1) surface coordinat |
[out] | w | Output closest W (0 - 1) surface coordinat |
void ProjVecPnt01 | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
vec3d@ [] | pts, | ||
double@ [] | us, | ||
double@ [] | ws, | ||
double@ [] | ds | ||
) |
Determine the nearest surface coordinates for an input array of 3D coordinate points and calculate the distance between each 3D point and the closest point of the surface.
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | pts | Input array of 3D coordinate points |
[out] | us | Output array of the closest U (0 - 1) surface coordinate for each 3D input point |
[out] | ws | Output array of the closest W (0 - 1) surface coordinate for each 3D input point |
[out] | ds | Output array of distances for each 3D point and the closest point of the surface |
void ProjVecPnt01Guess | ( | const string &in | geom_id, |
const int &in | surf_indx, | ||
vec3d@ [] | pts, | ||
double@ [] | u0s, | ||
double@ [] | w0s, | ||
double@ [] | us, | ||
double@ [] | ws, | ||
double@ [] | ds | ||
) |
Determine the nearest surface coordinates for an input array of 3D coordinate points and calculate the distance between each 3D point and the closest point of the surface. This function takes an input array of surface coordinate guesses for each 3D coordinate, offering a potential decrease in computation time compared to ProjVecPnt01.
[in] | geom_id | Parent Geom ID |
[in] | surf_indx | Main surface index from the parent Geom |
[in] | pts | Input array of 3D coordinate points |
[in] | u0s | Input array of U (0 - 1) surface coordinate guesses |
[in] | w0s | Input array of W (0 - 1) surface coordinate guesses |
[out] | us | Output array of the closest U (0 - 1) surface coordinate for each 3D input point |
[out] | ws | Output array of the closest W (0 - 1) surface coordinate for each 3D input point |
[out] | ds | Output array of distances for each 3D point and the closest point of the surface |