Curve Class Reference

Defines a curve object that mostly parallels Cubit's RefEdge class.

Inheritance

Entity
GeomEntity
Body Volume Surface Curve Vertex

Public Member Functions

void

color( int value)

Set the color of the Curve.

void

set_color( int value)

Set the color of the Curve.

int

color()

Get the color of the Curve.

std::array< double, 3 >

tangent( std::array< double, 3 > point)

Get the tangent to the Curve at a particular point.

std::array< double, 3 >

curvature( std::array< double, 3 > point)

Get the curvature of the Curve at a particular point.

std::array< double, 3 >

closest_point( std::array< double, 3 > point)

Get the curvature of the Curve at a particular point.

std::array< double, 3 >

closest_point_trimmed( std::array< double, 3 > point)

Get the curvature of the Curve at a particular point.

double

length()

Get the length of the Curve.

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

end_param()

Get the highest 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 >

position_from_u( double u_value)

Get the position of a particular u value for the Curve.

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

fraction_from_arc_length( Vertex root_vertex, double length)

Get the fraction along the Curve a specified arc length is away from a given Vertex.

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)

Parameters

[in] point

A vector containing 3 doubles representing coordinates of a location on the Curve

Returns The closest point to the Curve from the location specified

std::array< double, 3 > closest_point_trimmed(

std::array< double, 3 > point)

Parameters

[in] point

A vector containing 3 doubles representing coordinates of a location on the Curve

Returns The closest point to the Curve from the location specified

int color()

Returns The color value associated with the curve's current color

void color(

int value)

Parameters

[in] value

The color value that the curve will have

std::array< double, 3 > curvature(

std::array< double, 3 > point)

Parameters

[in] point

A vector containing 3 doubles representing coordinates of a location on the Curve

Returns The curvature of the Curve at the location specified

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

double end_param()

Returns The ending value of the parameter

double fraction_from_arc_length(

Vertex root_vertex,
double length)

Parameters

[in] root_vertex

The Vertex to start from (vertex object)
[in] length

The length along the Curve away from the root Vertex

Returns The fraction of the Curve that is the specified length away from the specified Vertex

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] parameter1

The beginning parameter
[in] parameter2

The 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_param

The root parameter from which the arc length is added to
[in] arc_length

The 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)

Parameters

[in] fraction_along_curve

A decimal value between 0 and 1 to determine a particular position along the Curve

Returns A vector containing the coordinates of the position a specified fraction along the Curve:
0 - x coordinate
1 - y coordinate
2 - z coordinate

std::array< double, 3 > position_from_u(

double u_value)

Parameters

[in] u_value

The 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] value

The 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)

Parameters

[in] point

A vector containing 3 doubles representing coordinates of a location on the Curve

Returns The tangent to the Curve at the location specified

double u_from_arc_length(

double root_param,
double arc_length)

Parameters

[in] root_param

The beginning parameter from which the arc length is added to
[in] arc_length

The 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] position

A vector containing the coordinates of the input position

Returns The u value of the position along the Curve