Unigine::SplineGraph Class

vec3 lerpUpVector(vec3 start_up, vec3 end_up, float t) const
{
	float angle = acos(dot(start_up, end_up)) * RAD2DEG;
	vec3 rotation_axis = cross(start_up, end_up);

	return rotateAxisAngle(rotation_axis, angle * t) * start_up;
}

SplineGraph Class

Members

---

static SplineGraphPtr create ( ) #

Default constructor. Creates an empty spline graph.

static SplineGraphPtr create ( const char * name ) #

Constructor. Creates an empty spline graph with a given name.

Arguments

• const char * name - Spline graph name.

static SplineGraphPtr create ( const Ptr<SplineGraph> & graph ) #

Constructor. Creates a spline graph by copying a given source spline graph.

Arguments

• const Ptr<SplineGraph> & graph - Source spline graph.

float getLength ( int index ) const#

Returns the length of the segment with a given index.

Arguments

• int index - Segment index.

Return value

Segment length.

int getNumPoints ( ) const#

Returns the total number of points in the spline graph.

Return value

Number of points.

int getNumSegments ( ) const#

Returns the total number of segments in the spline graph.

Return value

Number of segments.

void setPoint ( int index, const Math::Vec3 & point ) #

Sets new coordinates for the point with a given index.

Arguments

• int index - Point index.
• const Math::Vec3 & point - New point coordinates.

Math::Vec3 getPoint ( int index ) const#

Returns the coordinates of the point with a given index.

Arguments

• int index - Point index.

Return value

Point coordinates.

void setSegmentEndPoint ( int index, const Math::Vec3 & point ) #

Sets the coordinates of the end point for the segment with a given index.

Arguments

• int index - Segment index.
• const Math::Vec3 & point - Segment end point coordinates to be set.

Math::Vec3 getSegmentEndPoint ( int index ) const#

Returns the coordinates of the end point for the segment with a given index.

Arguments

• int index - Segment index.

Return value

Segment end point coordinates.

int getSegmentEndPointIndex ( int index ) const#

Returns the index of the end point for the segment with a given index.

Arguments

• int index - Segment index.

Return value

Segment end point index.

void setSegmentEndTangent ( int index, const Math::vec3 & tangent ) #

Sets the tangent coordinates for the end point of the segment with a given index.

Arguments

• int index - Segment index.
• const Math::vec3 & tangent - End point tangent coordinates.

Math::vec3 getSegmentEndTangent ( int index ) const#

Returns the tangent coordinates for the end point of the segment with a given index.

Arguments

• int index - Segment index.

Return value

End point tangent coordinates.

void setSegmentEndUpVector ( int index, const Math::vec3 & up ) #

Sets the "up" vector coordinates for the end point of the segment with a given index.

Arguments

• int index - Segment index.
• const Math::vec3 & up - End point "up" vector coordinates.

Math::vec3 getSegmentEndUpVector ( int index ) const#

Returns the "up" vector coordinates for the end point of the segment with a given index.

Arguments

• int index - Segment index.

Return value

End point "up" vector coordinates.

void setSegmentStartPoint ( int index, const Math::Vec3 & point ) #

Sets the coordinates of the start point for the segment with a given index.

Arguments

• int index - Segment index.
• const Math::Vec3 & point - Segment start point coordinates to be set.

Math::Vec3 getSegmentStartPoint ( int index ) const#

Returns the coordinates of the start point for the segment with a given index.

Arguments

• int index - Segment index.

Return value

Segment start point coordinates.

int getSegmentStartPointIndex ( int index ) const#

Returns the index of the end point for the segment with a given index.

Arguments

• int index - Segment index.

Return value

Segment start point index.

void setSegmentStartTangent ( int index, const Math::vec3 & tangent ) #

Sets the tangent coordinates for the start point of the segment with a given index.

Arguments

• int index - Segment index.
• const Math::vec3 & tangent - Start point tangent coordinates.

Math::vec3 getSegmentStartTangent ( int index ) const#

Returns the tangent coordinates for the start point of the segment with a given index.

Arguments

• int index - Segment index.

Return value

Start point tangent coordinates.

void setSegmentStartUpVector ( int index, const Math::vec3 & up ) #

Sets the "up" vector coordinates for the start point of the segment with a given index.

Arguments

• int index - Segment index.
• const Math::vec3 & up - Start point "up" vector coordinates.

Math::vec3 getSegmentStartUpVector ( int index ) const#

Returns the "up" vector coordinates for the start point of the segment with a given index.

Arguments

• int index - Segment index.

Return value

Start point "up" vector coordinates.

int addPoint ( const Math::Vec3 & point ) #

Adds a point with specified coordinates to the spline graph.

Arguments

• const Math::Vec3 & point - Point coordinates.

Return value

Current number of points in the spline graph.

int addSegment ( int start_index, const Math::vec3 & start_tangent, const Math::vec3 & start_up, int end_index, const Math::vec3 & end_tangent, const Math::vec3 & end_up ) #

Adds a segment to the spline graph.

Arguments

• int start_index - Start point index.
• const Math::vec3 & start_tangent - Start point tangent coordinates.
• const Math::vec3 & start_up - Start point "up" vector coordinates.
• int end_index - End point index.
• const Math::vec3 & end_tangent - End point tangent coordinates.
• const Math::vec3 & end_up - End point "up" vector coordinates.

Return value

Number of segments in the spline graph if a segment was adds successfully; otherwise, -1

Math::Vec3 calcSegmentPoint ( int index, float t ) const#

Returns the coordinates of the point at the parametrically specified position on the segment (along the T axis).

Arguments

• int index - Segment index.
• float t - Position of the point on the segment, specified parametrically along the T (times axis) in the [0.0f, 1.0f] range.

Return value

Coordinates of the point on the given segment.

Math::vec3 calcSegmentTangent ( int index, float t ) const#

Returns the tangent coordinates for the point at the parametrically specified position on the segment (along the T axis).

Arguments

• int index - Segment index.
• float t - Position of the point on the segment, specified parametrically along the T (times axis) in the [0.0f, 1.0f] range.

Return value

Tangent coordinates for the point on the given segment.

Math::vec3 calcSegmentUpVector ( int index, float t ) const#

Returns the "up" vector coordinates for the point at the parametrically specified position on the segment (along the T axis).

Arguments

• int index - Segment index.
• float t - Position of the point on the segment, specified parametrically along the T (times axis) in the [0.0f, 1.0f] range.

Return value

"Up" vector coordinates for the point on the given segment.

void clear ( ) #

Clears the spline graph.

bool load ( const char * name ) #

Loads the spline graph from the specified XML-file.

Arguments

• const char * name - Name of the XML-file to load the spline graph from.

Return value

true if the spline graph was successfully loaded; otherwise, false.

void removePoint ( int index, bool merge = 0 ) #

Removes a point with a given index from the spline graph.

Arguments

• int index - Point index.
• bool merge - Merge flag. When there are two segments attached to the point, use true to merge these segments into one; false removes all segments attached to the point (by default).

void splitPoint ( int index ) #

Splits the point with the specified index into N points, where N is the number of segments attached to the point. The number of points in the graph shall increase by N-1. All new points will be attached to the corresponding segments.

Arguments

• int index - Point index.

void weldPoints ( Vector< int > & indices ) #

Merges all points with given indices into one.

Arguments

• Vector< int > & indices - Array containing indices of points to be merged into one.

void removeSegment ( int index, bool with_points = 0 ) #

Removes the segment with a given index.

Arguments

• int index - Segment index.
• bool with_points - Use true to remove segment with its starting and ending points, or false to remove the segment only.
  Notice

  Points will be removed only in case if they do not belong to other segments. After removal, the last element of the vector of spline graph segments shall be moved to the position of the one removed.

bool save ( const char * name ) const#

Saves the spline graph to the specified XML-file.

Arguments

• const char * name - Name of the XML-file to save the spline graph to.

Return value

true if the spline graph was successfully saved; otherwise, false.

void insertPointToSegment ( int segment_index, float new_point_t ) #

Inserts a new point into the given segment. The point is parametrically specified on the T (times axis) in the [0.0f, 1.0f] range from the segment's start point.

Arguments

• int segment_index - Segment index.
• float new_point_t - Coordinate of the new point to be added along the horizontal T (times) axis in the range [0.0f, 1.0f].

void getPointSegmentsIndices ( int index, Vector< int > & indices ) const#

Retrieves indices of all segments attached to the specified point and puts them to the given index buffer.

Arguments

• int index - Point index.
• Vector< int > & indices - Index buffer to which segment indices will be added.