Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

Path Class

This class provides an interface for path loading, manipulating and saving.

The path is a spline along which an object can be moved. Such splines can be created, for example, in 3ds Max and then exported to a *.path file. Or they can be created in the script by means of the Path class and then saved to the *.path file.

Warning
There is no connection between functions of the Path class and pathfinding-related functions.

Path Class

Members


Path ()

Constructor. Creates an empty path.

Path (variable v)

Constructor. Creates a path initialized by a name or an instance of the Path class.

Arguments

  • variable v - Argument of one of the following types:
    • string name - Path name.
    • Path path - Path: instance of the Path class.

int addFrame ()

Creates a new frame and appends it to the array of path frames.

Return value

Number of path frames.

void clear ()

Clears the current path.

vec3 getAngularVelocity (float time, int loop = 0)

Returns the angular velocity of the object moving along the path at the specified time. If the path is non-looped and the specified time is bigger than the current path time, the last path position will be returned. If the path is looped, several loops can be used to count off time.

Arguments

  • float time - Time in seconds.
  • int loop - Flag indicating if the path is close.

Return value

Angular velocity. If the number of frames is equal to 0 or 1, the function returns the (0,0,0) vector.

int getClosestFrame (vec3 position)

Returns the number of the path frame, which is the closest to the given point.

Arguments

  • vec3 position - Coordinates of the point.

Return value

The closest frame number.

float getClosestTime (vec3 position)

Returns the path time in the path point which is the closest to the given point.

Arguments

  • vec3 position - Coordinates of the point.

Return value

Path time in seconds.

vec3 getFramePosition (int num)

Returns the position coordinates of the path frame.

Arguments

  • int num - The frame number.

Return value

Coordinates of the frame.

quat getFrameRotation (int num)

Returns the rotation quaternion of the given path frame.

Arguments

  • int num - The frame number.

Return value

Frame rotation quaternion.

vec3 getFrameScale (int num)

Returns the scaling vector of the path frame.

Arguments

  • int num - The frame number.

Return value

Frame scaling vector.

float getFrameTime (int num)

Returns the time of the specified path frame.

Arguments

  • int num - The frame number.

Return value

Frame time.

mat4 getFrameTransform (int num)

Returns the transformation matrix of the path frame.

Arguments

  • int num - The frame number.

Return value

Frame transformation matrix.

vec3 getLinearVelocity (float time, int loop = 0)

Returns the linear velocity of the object moving along the path at the specified time. If the path is non-looped and the specified time is bigger than the current path time, the last path position will be returned. If the path is looped, several loops can be used to count off time.

Arguments

  • float time - Time in seconds.
  • int loop - Flag indicating if the path is looped.

Return value

Linear velocity. If the amount of frames is equal to 0 or 1, the function returns the (0,0,0) vector.

int getNumFrames ()

Returns the number of the path frames.

Return value

Number of path frames.

vec3 getPosition (float time, int loop = 0)

Returns the position of the object moving along the path at the specified time. If the path transformation is non-looped and the specified time is bigger than path transformation, the last path position will be returned. If the path transformation is looped, several loops can be used to count off time.

Arguments

  • float time - Time in seconds.
  • int loop - Flag indicating if the path is looped.

Return value

Object position coordinates.

quat getRotation (float time, int loop = 0)

Returns the rotation of the object moving along the path at the specified time. If the path is non-looped and the specified time is bigger than the current path time, the last path position will be returned. If the path is looped, several loops can be used to count off time.

Arguments

  • float time - Time in seconds.
  • int loop - Flag indicating if the path is looped.

Return value

Object rotation.

vec3 getScale (float time, int loop = 0)

Returns the scale of the object moving along the path at the specified time. If the path is non-looped and the specified time is bigger than the current path transformation, the last path position will be returned. If the path is looped, several loops can be used to count off time.

Arguments

  • float time - Time in seconds.
  • int loop - Flag indicating if the path is looped.

Return value

Object scale.

mat4 getTransform (float time, int loop = 0)

Returns the transformation of the object moving along the path at the specified time. If the path is non-looped and the specified time is bigger than the current path time, the last path position will be returned. If the path is looped, several loops can be used to count off time.

Arguments

  • float time - Time in seconds.
  • int loop - Flag indicating if the path is looped.

Return value

Object transformation matrix.

int load (string name)

Loads the path with the given name.

Arguments

  • string name - Path name.

Return value

1 if the path is loaded successfully; otherwise, 0.

void removeFrame (int num)

Removes the specified frame.

Arguments

  • int num - The frame number.

int save (string name)

Saves the path with the given name.

Arguments

  • string name - Path name.

Return value

1 if the path is saved successfully; otherwise, 0.

void setFramePosition (int num, vec3 pos)

Sets the position coordinates for the path frame.

Arguments

  • int num - The frame number.
  • vec3 pos - Coordinates of the frame to be set.

void setFrameRotation (int num, quat rot)

Sets the rotation quaternion for the given path frame.

Arguments

  • int num - The frame number.
  • quat rot - Frame rotation quaternion to be set.

void setFrameScale (int num, vec3 scale)

Sets the scaling vector for the path frame.

Arguments

  • int num - The frame number.
  • vec3 scale - Frame scaling vector to be set.

void setFrameTime (int num, float time)

Sets the time for the specified path frame.

Arguments

  • int num - The frame number.
  • float time - Frame time to be set.

void setFrameTransform (int num, mat4 transform)

Sets the transformation matrix for the path frame.

Arguments

  • int num - The frame number.
  • mat4 transform - Transformation matrix to be set.

void setNumFrames (int num)

Sets the new number of frames.

Arguments

  • int num - Number of frames to be set.
Last update: 2017-07-03