Curve Class Reference
Defines a curve object that mostly parallels Cubit's RefEdge class.
Inheritance
EntityGeomEntity
Body Volume Surface Curve Vertex
Public Member Functions
std::array< double, 3 >
std::array< double, 3 >
std::array< double, 3 >
std::array< double, 3 >
closest_point_trimmed( std::array< double, 3 > point)
Get the curvature of the Curve at a particular point.
std::array< double, 3 >
curve_center()
Get the center point of the Curve.
std::array< double, 3 >
position_from_fraction( double fraction_along_curve)
Get the position of the point a specified fraction along the Curve.
double
start_param()
Get the lowest value of the Curve in uv space.
double
u_from_position( std::array< double, 3 > position)
Get the u value of a particular position on the Curve.
std::array< double, 3 >
double
u_from_arc_length( double root_param, double arc_length)
Get the u value for a point a specified arc length away from a specified root parameter on the Curve.
double
std::array< double, 3 >
point_from_arc_length( double root_param, double arc_length)
Get the position on a Curve that is a specified arc length away from the specified root parameter.
double
length_from_u( double parameter1, double parameter2)
Get the length between two specified parameters on a Curve.
bool
is_periodic()
Get whether the Curve is periodic or not.
Curve()
~Curve()
Curve( const Curve & other)
Curve( CubitEntity * entity_ptr)
Detailed Description
Defines a curve object that mostly parallels Cubit's RefEdge class.
Member Function Documentation
std::array< double, 3 > closest_point(
- std::array< double, 3 > point)
std::array< double, 3 > closest_point_trimmed(
- std::array< double, 3 > point)
int color()
Returns The color value associated with the curve's current color
void color(
- int value)
Parameters
-
[in] valueThe color value that the curve will have
std::array< double, 3 > curvature(
- std::array< double, 3 > point)
std::array< double, 3 > curve_center()
Returns A vector containing the coordinates of the Curve's center according to the following:
0 - x coordinate
1 - y coordinate
2 - z coordinate
0 - x coordinate
1 - y coordinate
2 - z coordinate
double end_param()
Returns The ending value of the parameter
bool is_periodic()
Returns Whether the Curve is periodic or not
double length()
Returns The length of the Curve
double length_from_u(
- double parameter1,
- double parameter2)
Parameters
-
[in] parameter1The beginning parameter
-
[in] parameter2The ending parameter
Returns The length between the two specified paramters along the Curve
std::array< double, 3 > point_from_arc_length(
- double root_param,
- double arc_length)
Parameters
-
[in] root_paramThe root parameter from which the arc length is added to
-
[in] arc_lengthThe arc length along the Curve away from the root parameter
Returns A vector that contains the coordinates of a position a specified arc length away from the root parameter
std::array< double, 3 > position_from_fraction(
- double fraction_along_curve)
std::array< double, 3 > position_from_u(
- double u_value)
Parameters
-
[in] u_valueThe u value of the position along the Curve
Returns A vector containing the coordinates of the output position
void set_color(
- int value)
Parameters
-
[in] valueThe color value that the curve will have
double start_param()
Returns The beginning value of the parameter
std::array< double, 3 > tangent(
- std::array< double, 3 > point)
double u_from_arc_length(
- double root_param,
- double arc_length)
Parameters
-
[in] root_paramThe beginning parameter from which the arc length is added to
-
[in] arc_lengthThe length away from the root parameter of the output parameter
Returns The u value of the Curve the arc length away from the root parameter
double u_from_position(
- std::array< double, 3 > position)
Parameters
-
[in] positionA vector containing the coordinates of the input position
Returns The u value of the position along the Curve