Unigine.SplineSegment Class

This class is used to manage individual segments of the world spline graph.

Properties:

Name	Description
int NumSources	The total number of source nodes assigned to this spline segment.
int NumNodes	The total number of nodes placed along the spline segment.
float Length	The length of the spline segment.
WorldSplineGraph Parent	The WorldSplineGraph node to which the spline segment belongs.
vec3 EndUp	The current "up" vector coordinates for the end point of the spline segment.
vec3 EndTangent	The current tangent coordinates for the end point of the spline segment.
vec3 StartUp	The current "up" vector coordinates for the start point of the spline segment.
vec3 StartTangent	The current tangent coordinates for the start point of the spline segment.
SplinePoint EndPoint	The current end point of the segment.
SplinePoint StartPoint	The current start point of the segment.

Methods:

Name	Description View: Sort by:
SetEnabled	Sets a value indicating whether the spline segment is enabled.
IsEnabled	Returns a value indicating whether the spline segment is enabled.
CalcPoint	Returns the coordinates of the point at the specified position on the segment.
CalcTangent	Returns the tangent coordinates for the point at the specified position on the segment.
CalcUpVector	Returns the "up" vector coordinates for the point at the specified position on the segment.
LinearToParametric	Performs conversion of linear position in accordance with the spline segment's length to parametric position.
ClearSources	Clears the list of source nodes for the spline segment.
AssignSource	Assigns a source node with the given name to the spline segment and sets the specified forward axis for it.
RemoveSource	Removes the source node with the given name.
GetSources	Returns a list of source nodes assigned to the spline segment and puts it to the specified vector.
SetSegmentMode	Sets the segment mode for the source node with the given name.
GetSegmentMode	Returns the current segment mode for the source node with the given name.
SetUVTiling	Sets a value indicating whether UV tiling for the material textures of the source node with the given name is enabled.
GetUVTiling	Returns a value indicating whether UV tiling for the material textures of the source node with the given name is enabled.
SetAdaptiveAngleThreshold	Sets the angle threshold value for splitting source node with the given name.
GetAdaptiveAngleThreshold	Returns the current angle threshold value for splitting source node with the given name.
SetGap	Sets the size of the gap between the adjacent copies of the source node with the given name tiled along the spline segment.
GetGap	Returns the current size of the gap between the adjacent copies of the source node with the given name tiled along the spline segment.
Copy	Copies all parameters from the specified source spline segment.
Clone	Returns a clone of the spline segment.
GetForwardAxis	Returns the forward axis used for the source node with the specified name.

Variables:

Name	Description
FORWARD_X = 0	X is a forward axis for stretching.
FORWARD_Y = 1	Y is a forward axis for stretching.
FORWARD_Z = 2	Z is a forward axis for stretching.
SEGMENT_STRETCH = 0	The source node is stretched along the segment. This mode is the most performance-friendly, as only a single node is created for a segment. However, the stretched geometry will cut the curves of the spline to straight lines.
SEGMENT_TILING = 1	The source node is duplicated along the segment. Selecting this mode for a large spline graph may siginficantly reduce performance, due to a large number of tiled nodes.
SEGMENT_ADAPTIVE = 2	This mode represents a combination of stretching and tiling to make the geometry placed along the spline graph look more plausible for a lower performance cost.

SplineSegment Class

Properties

int NumSources#

The total number of source nodes assigned to this spline segment.

int NumNodes#

The total number of nodes placed along the spline segment.

float Length#

The length of the spline segment.

WorldSplineGraph Parent#

The WorldSplineGraph node to which the spline segment belongs.

vec3 EndUp#

The current "up" vector coordinates for the end point of the spline segment.

set

Sets the "up" vector coordinates for the end point of the segment.

set value - End point "up" vector coordinates.

vec3 EndTangent#

The current tangent coordinates for the end point of the spline segment.

set

Sets the tangent coordinates for the end point of the spline segment.

set value - End point tangent coordinates to be set.

vec3 StartUp#

The current "up" vector coordinates for the start point of the spline segment.

set

Sets the "up" vector coordinates for the start point of the segment.

set value - Start point "up" vector coordinates to be set.

vec3 StartTangent#

The current tangent coordinates for the start point of the spline segment.

set

Sets the tangent coordinates for the start point of the spline segment.

set value - Start point tangent coordinates to be set.

SplinePoint EndPoint#

The current end point of the segment.

set

Sets the specified spline point as an end point of the segment.

set value - Spline point to be set as an end point of the segment.

SplinePoint StartPoint#

The current start point of the segment.

set

Sets the specified spline point as a start point of the segment.

set value - Spline point to be set as a start point of the segment.

Members

void SetEnabled ( bool enable, bool with_points = 1 ) #

Sets a value indicating whether the spline segment is enabled.

Arguments

bool enable - true to enable the spline segment, false to disable.
bool with_points - Use true to enable all points that belong to it as well, false to enable the spline point only.

bool IsEnabled ( ) #

Returns a value indicating whether the spline segment is enabled.

Return value

true if the spline segment is enabled; otherwise, false.

vec3 CalcPoint ( float t ) #

Returns the coordinates of the point at the specified position on the segment.

Arguments

float t - Position of the point on the segment, in increments of the segment's length normalized to 1.

Return value

Coordinates of the point.

vec3 CalcTangent ( float t ) #

Returns the tangent coordinates for the point at the specified position on the segment.

Arguments

float t - Position of the point on the segment, in increments of the segment's length normalized to 1.

Return value

Tangent coordinates for the point at the specified position on the segment.

vec3 CalcUpVector ( float t ) #

Returns the "up" vector coordinates for the point at the specified position on the segment.

Arguments

float t - Position of the point on the segment, in increments of the segment's length normalized to 1.

Return value

Coordinates of the "up" vector for the point at the specified position on the segment.

float LinearToParametric ( float l ) #

Performs conversion of linear position in accordance with the spline segment's length to parametric position.

Arguments

float l - Linear position on the spline segment in the range [0.0f, 1.0f].

Return value

Parametric position of the point on the segment, in increments of the segment's length normalized to 1.

void ClearSources ( ) #

Clears the list of source nodes for the spline segment.

void AssignSource ( string name, int forward_axis = 0 ) #

Assigns a source node with the given name to the spline segment and sets the specified forward axis for it.

Arguments

string name - Source node name.
int forward_axis - Forward axis to be set for the source node. One of the FORWARD_ variables. The X axis is used by default.

void RemoveSource ( string name, int forward_axis = FORWARD_Y ) #

Removes the source node with the given name.

Arguments

string name - Name of the source node to be removed.
int forward_axis - Forward axis for the source node. One of the FORWARD_ variables. The Y axis is used by default.

void GetSources ( string[] sources ) #

Returns a list of source nodes assigned to the spline segment and puts it to the specified vector.

Arguments

string[] sources - List of source nodes assigned to the spline segment.

void SetSegmentMode ( string name, int segment_mode = SEGMENT_TILING ) #

Sets the segment mode for the source node with the given name.

Arguments

string name - Source node name.
int segment_mode - Mode for the source node with the given name. One of the SEGMENT_* variables. SEGMENT_TILING is used by default.

int GetSegmentMode ( string name ) #

Returns the current segment mode for the source node with the given name.

Arguments

string name - Source node name.

Return value

Mode for the source node with the given name. One of the SEGMENT_* variables. SEGMENT_STRETCH is used by default.

void SetUVTiling ( string name, int enable_uv_tiling = 0 ) #

Sets a value indicating whether UV tiling for the material textures of the source node with the given name is enabled.

Arguments

string name - Source node name.
int enable_uv_tiling - 1 to enable UV tiling for the material textures of the source node, 0 - to stretch textures. The default value is 0.

int GetUVTiling ( string name ) #

Returns a value indicating whether UV tiling for the material textures of the source node with the given name is enabled.

Arguments

string name - Source node name.

Return value

1 if UV tiling for the material textures of the source node is enabled; otherwise (textures are stretched), 0.

void SetAdaptiveAngleThreshold ( string name, float adaptive_angle_threshold = 1.0f ) #

Sets the angle threshold value for splitting source node with the given name. If an angle between the tangents for the two subsequent parts of the spline segment exceeds this value, the node will be split.

Notice

This parameter is used only for the SEGMENT_ADAPTIVE mode.

Arguments

string name - Source node name.
float adaptive_angle_threshold - Angle threshold value for the source node with the given name, in degrees. The default value is 1.0f.

float GetAdaptiveAngleThreshold ( string name ) #

Returns the current angle threshold value for splitting source node with the given name. If an angle between the tangents for the two subsequent parts of the spline segment exceeds this value, the node will be split.

Notice

This parameter is used only for the SEGMENT_ADAPTIVE mode.

Arguments

string name - Source node name.

Return value

Angle threshold value for the source node with the given name, in degrees. The default value is 1.0f.

void SetGap ( string name, float gap = 0.0f ) #

Sets the size of the gap between the adjacent copies of the source node with the given name tiled along the spline segment.

Notice

This parameter is used only for the SEGMENT_TILING mode.

Arguments

string name - Source node name.
float gap - Gap size to be set, in units.

float GetGap ( string name ) #

Returns the current size of the gap between the adjacent copies of the source node with the given name tiled along the spline segment.

Notice

This parameter is used only for the SEGMENT_TILING mode.

Arguments

string name - Source node name.

Return value

Current gap size, in units.

void Copy ( SplineSegment src, int copy_endpoints_data = 1 ) #

Copies all parameters from the specified source spline segment.

Arguments

SplineSegment src - Source spline segment.
int copy_endpoints_data - Use 1 to copy all parameters of segment's endpoints as well, 0 to use default ones. The default value is 0.

SplineSegment Clone ( int clone_points = 0 ) #

Returns a clone of the spline segment.

Arguments

int clone_points - Use 1 to copy all parameters of segment's endpoints as well, 0 to use default ones. The default value is 0.

Return value

Clone of the spline segment.

int GetForwardAxis ( string name ) #

Returns the forward axis used for the source node with the specified name.

Arguments

string name - Source node name.

Return value

Forward axis for the source node. One of the FORWARD_ variables.

Last update: 2020-07-31

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)