On this page:
11.9.1  Inheritance diagram for Curve:
2022.4+26187-e1209cf7 Apr 14, 2022

11.9  Curve

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

#include <CubitInterfaceEx.hpp>

11.9.1  Inheritance diagram for Curve:

Public Member Functions

void 

color (int value)

 

Set the color of the Curve. More...

 

void 

set_color (int value)

 

Set the color of the Curve. More...

 

int 

color ()

 

Get the color of the Curve. More...

 

std::array< double, 3 > 

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

 

Get the tangent to the Curve at a particular point. More...

 

std::array< double, 3 > 

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

 

Get the curvature of the Curve at a particular point. More...

 

std::array< double, 3 > 

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

 

Get the curvature of the Curve at a particular point. More...

 

std::array< double, 3 > 

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

 

Get the curvature of the Curve at a particular point. More...

 

double 

length ()

 

Get the length of the Curve. More...

 

std::array< double, 3 > 

curve_center ()

 

Get the center point of the Curve. More...

 

std::array< double, 3 > 

position_from_fraction (double fraction_along_curve)

 

Get the position of the point a specified fraction along the Curve. More...

 

double 

start_param ()

 

Get the lowest value of the Curve in uv space. More...

 

double 

end_param ()

 

Get the highest value of the Curve in uv space. More...

 

double 

u_from_position (std::array< double, 3 > position)

 

Get the u value of a particular position on the Curve. More...

 

std::array< double, 3 > 

position_from_u (double u_value)

 

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

 

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. More...

 

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. More...

 

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. More...

 

double 

length_from_u (double parameter1, double parameter2)

 

Get the length between two specified parameters on a Curve. More...

 

bool 

is_periodic ()

 

Get whether the Curve is periodic or not. More...

 

double 

dihedral_angle (Curve other, Surface common_surface)

 

Get the dihedral angle between this curve and another curve relate to the given surface. More...

 

 

Curve (const Curve &other)

 

 

Curve (CubitEntity *entity_ptr)

 

Detailed Description

Defines a curve object that mostly parallels Cubit’s RefEdge class. Member Function Documentation
closest_point()

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

Get the curvature of the Curve at a particular point.

std::vector<double> point(3, 0);

std::vector<double> close = curve->closest_point(point);

close = curve.closest_point([0,0,0])

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
closest_point_trimmed()

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

Get the curvature of the Curve at a particular point.

std::vector<double> point(3, 0);

std::vector<double> close = curve->closest_point(point);

close = curve.closest_point([0,0,0])

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
color() [1/2]

 int color ( )

Get the color of the Curve.

int col = curve->color();

col = curve.color()

Returns:
The color value associated with the curve’s current color
color() [2/2]

 void color ( int  value)

Set the color of the Curve.

Parameters:

[in]

value

The color value that the curve will have


curvature()

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

Get the curvature of the Curve at a particular point.

std::vector<double> point(3, 0);

std::vector<double> curvature = curve->curvature(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
curve_center()

 std::array<double,3> curve_center ( )

Get the center point of the Curve.

std::array<double,3> center = curve->curve_center();

center = curve.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
dihedral_angle()

 double dihedral_angle ( Curve  other, Surface  common_surface  )

Get the dihedral angle between this curve and another curve relate to the given surface.

Parameters:

other

The other curve object that forms a dihedral angle with this one.

common_surface

Surface object that contains both curves.

Returns:
the dihedral angle between the curves, in radians
end_param()

 double end_param ( )

Get the highest value of the Curve in uv space.

double end = curve->end_param();

Returns:
The ending value of the parameter
fraction_from_arc_length()

 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.

double fraction = curve->fraction_from_arc_length(vertex, 0.5);

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
is_periodic()

 bool is_periodic ( )

Get whether the Curve is periodic or not.

bool periodic = curve->is_periodic();

periodic = curve.is_periodic()

Returns:
Whether the Curve is periodic or not
length()

 double length ( )

Get the length of the Curve.

double len = curve->length();

len = curve.length()

Returns:
The length of the Curve
length_from_u()

 double length_from_u ( double  parameter1, double  parameter2  )

Get the length between two specified parameters on a Curve.

double length = curve->length_from_u(0, 0.5);

Parameters:

[in]

parameter1

The beginning parameter

[in]

parameter2

The ending parameter

Returns:
The length between the two specified paramters along the Curve
point_from_arc_length()

 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.

std::vector<double> position = curve->point_from_arc_length(0, 0.5);

position = curve.point_from_arc_length(0, 0.5)

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
position_from_fraction()

 std::array<double,3> position_from_fraction ( double  fraction_along_curve)

Get the position of the point a specified fraction along the Curve.

std::array<double,3> pos = curve->position_from_fraction(0.5);

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
position_from_u()

 std::array<double,3> position_from_u ( double  u_value)

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

std::vector<double> position = curve->position_from_u(0.5);

position = curve.position_from_u(0.5)

Parameters:

[in]

u_value

The u value of the position along the Curve

Returns:
A vector containing the coordinates of the output position
set_color()

 void set_color ( int  value)

Set the color of the Curve.

Parameters:

[in]

value

The color value that the curve will have


start_param()

 double start_param ( )

Get the lowest value of the Curve in uv space.

double start = curve->start_param();

start = curve.start_param()

Returns:
The beginning value of the parameter
tangent()

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

Get the tangent to the Curve at a particular point.

std::vector<double> point(3, 0);

std::vector<double> tan = curve->tangent(point);

tan = curve.tangent([0,0,0])

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
u_from_arc_length()

 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 u = curve->u_from_arc_length(0, 0.5);

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
u_from_position()

 double u_from_position ( std::array< double, 3 >  position)

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

std::vector<double> point(3, 0);

double u = curve->u_from_position(point);

u = curve.u_from_position([0,0,0])

Parameters:

[in]

position

A vector containing the coordinates of the input position

Returns:
The u value of the position along the Curve