WorldSplineGraph 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;
}

WorldSplineGraph Class

Members

---

static WorldSplineGraph ( ) #

Default constructor. Creates an empty world spline graph.

static WorldSplineGraph ( string name ) #

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

Arguments

• string name - World spline graph name.

int getNumSplinePoints ( ) #

Returns the total number of spline points in the world spline graph.

Return value

Number of spline points.

int getNumSplineSegments ( ) #

Returns the total number of spline segments in the world spline graph.

Return value

Number of segments.

void setSplineGraphName ( string name, int force_load = 0 ) #

Sets the name of the world spline graph.

Arguments

• string name - World spline graph name.
• int force_load - Force flag.
  • If 1 is specified, the world spline graph will immediately loaded from a file.
  • If 0 is specified, only the world spline graph name will be updated.

string getSplineGraphName ( ) #

Returns the name of the world spline graph.

Return value

World spline graph name.

void loadSegmentNodes ( int segment_index = -1 ) #

Loads source nodes assigned to the specified spline segment immediately.

Arguments

• int segment_index - Segment index. If no segment index is specified, the method loads source nodes assigned to all segments.

void clear ( ) #

Clears the world spline graph.

int isCurved ( ) #

Returns a value indicating if the world spline graph is curved.

Return value

1 if the world spline graph is curved; otherwise, 0.

void makeCurved ( ) #

Curves the world spline graph using its geodetic pivot. The spline file is saved upon completion of the curving operation.

void makeFlat ( ) #

Flattens the world spline graph using its geodetic pivot. The spline file is saved upon completion of the flattening operation.

int load ( string name ) #

Loads a spline graph from the specified XML-file.

Arguments

• string name - Name of the XML-file to load the spline graph from.

Return value

1 if the spline graph was successfully loaded; otherwise, 0.

int save ( string name ) #

Saves a spline graph to the specified XML-file.

Arguments

• string name - Name of the XML-file to save the spline graph to.

Return value

1 if the spline graph was successfully saved; otherwise, 0.

static int type ( ) #

Returns the type of the node.

Return value

WorldSplineGraph type identifier.

void getSegmentNodeMesh ( Mesh mesh, SplineSegment segment, int node_index, int bake_transform = 0 ) #

Gets a mesh used by a node with the specified index, placed along the specified spline segment, and puts it to the specified target Mesh instance.

Arguments

• Mesh mesh - Target mesh instance to which the obtained mesh is to be put.
• SplineSegment segment - Spline segment for which the mesh is to be returned.
• int node_index - Number of the node instance placed along the spline segment.
• int bake_transform - 1 to use baked mesh transformation, 0 - to use default (the mesh will be placed at the origin). The default value is 0.

SplinePoint createSplinePoint ( Vec3 position ) #

Creates a new spline point with the specified parameters and attaches it to the world spline graph.

Arguments

• Vec3 position - Position coordinates for the new splint point.

Return value

New spline point.

void removeSplinePoint ( SplinePoint point, int merge = 0 ) #

Removes the specified spline point from the world spline graph. You can set the merge flag to merge spline segments sharing this point as their start and end points.

Arguments

• SplinePoint point - Spline point to be removed.
• int merge - 1 to merge spline segments sharing this point as their start and end points, 0 to remove all segments sharing this point. The default value is 0.

void getSplinePoints ( ) #

Returns the list of all points of the world spline graph and puts them to the specified vector of SplinePoint elements.

Arguments

SplineSegment createSplineSegment ( SplinePoint start_point, vec3 start_tangent, vec3 start_up, SplinePoint end_point, vec3 end_tangent, vec3 end_up ) #

Creates a new spline segment with the specified parameters and attaches it to the world spline graph.

Arguments

• SplinePoint start_point - Start point of the spline segment.
• vec3 start_tangent - Tangent coordinates for the start point of the spline segment.
• vec3 start_up - Coordinates of the "up" vector for the start point of the spline segment.
• SplinePoint end_point - End point of the segment.
• vec3 end_tangent - Tangent coordinates for the end point of the spline segment.
• vec3 end_up - Coordinates of the "up" vector for the end point of the spline segment.

Return value

New spline segment connecting two specified points.

void removeSplineSegment ( SplineSegment segment, int with_points = 0 ) #

Removes the specified spline segment from the world spline graph. You can set the with_points flag to remove the segment together with its start and end points.

Arguments

• SplineSegment segment - Spline segment to be removed.
• int with_points - 1 to remove the segment with its start and end points, 0 to keep points. The default value is 0.

void getSplineSegments ( ) #

Returns the list of all segments of the world spline graph and puts them to the specified vector of SplineSegment elements.

Arguments

void rebuild ( int try_force = 0 ) #

Rebuilds the world spline graph. This method is to be called after making any changes to spline segments (mode, etc.), point positions, tangents, or "up" vectors, as well as after changing source node assignments and/or other parameters (UV tiling, gap, etc.)

Arguments

• int try_force - Forced rebuild flag: set 1 to try and force rebuild the world spline graph.

int isRebuilding ( ) #

Returns a value indicating if the world spline graph is currently being rebuilt. The world spline graph uses a deferred rebuild.

Return value

1 if the world spline graph is currently being rebuilt; otherwise 0.

void splitSplineSegment ( SplineSegment segment, float new_point_t ) #

Splits the specified spline segment into two parts by inserting a new point placed at the specified distance from the segment's start point.

Arguments

• SplineSegment segment - Spline segment to be split.
• float new_point_t - Relative distance from the start point as a fraction of the segment's length in the [0.0f, 1.0f] range.

void breakSplinePoint ( SplinePoint point ) #

Breaks the specified spline point shared by several spline segments into a set of separate ones, so that each of the segments gets its own point.

Arguments

• SplinePoint point - Spline point to be broken.
  Notice

  The point must be shared by a least 2 segments.

int isLinked ( const SplinePoint point ) #

Returns a value indicating if the specified spline point is linked to any spline segment.

Arguments

• const SplinePoint point - Spline point to be checked.

Return value

1 if the specified spline point is linked to any spline segment; otherwise, 0.