UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Unigine::Path Class

Header: #include <UniginePath.h>

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


static PathPtr create ( ) #

Constructor. Creates an empty path.

static PathPtr create ( const char * name ) #

Constructor. Creates an empty path of the specified name.

Arguments

  • const char * name - Name of the path.

static PathPtr create ( const Ptr<Path> & path ) #

Constructor. Creates a path out of the specified path.

Arguments

  • const Ptr<Path> & path - Pointer to the path.

Math::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 looped. The default is 0 (path isn't looped).

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 ( const Math::Vec3 & position ) #

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

Arguments

  • const Math::Vec3 & position - Coordinates of the point.

Return value

The closest frame number.

float getClosestTime ( const Math::Vec3 & position ) #

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

Arguments

  • const Math::Vec3 & position - Coordinates of the point.

Return value

Path time in seconds.

void setFramePosition ( int num, const Math::Vec3 & pos ) #

Sets the position coordinates for the path frame.

Arguments

  • int num - The frame number.
  • const Math::Vec3 & pos - Coordinates of the frame to be set.

Math::Vec3 getFramePosition ( int num ) #

Returns the position coordinates of the path frame.

Arguments

  • int num - The frame number.

Return value

Coordinates of the frame.

void setFrameRotation ( int num, const Math::quat & rot ) #

Sets the rotation quaternion for the given path frame.

Arguments

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

Math::quat getFrameRotation ( int num ) #

Returns the rotation quaternion of the given path frame.

Arguments

  • int num - The frame number.

Return value

Frame rotation quaternion.

void setFrameScale ( int num, const Math::vec3 & scale ) #

Sets the scaling vector for the path frame.

Arguments

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

Math::vec3 getFrameScale ( int num ) #

Returns the scaling vector of the path frame.

Arguments

  • int num - The frame number.

Return value

Frame scaling vector.

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.

float getFrameTime ( int num ) #

Returns the time of the specified path frame.

Arguments

  • int num - The frame number.

Return value

Frame time.

void setFrameTransform ( int num, const Math::Mat4 & transform ) #

Sets the transformation matrix for the path frame.

Arguments

  • int num - The frame number.
  • const Math::Mat4 & transform - Transformation matrix to be set.

Math::Mat4 getFrameTransform ( int num ) #

Returns the transformation matrix of the path frame.

Arguments

  • int num - The frame number.

Return value

Frame transformation matrix.

Math::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. The default is 0 (path isn't looped).

Return value

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

void setNumFrames ( int frames ) #

Sets the new number of frames.

Arguments

  • int frames - Number of frames to be set.

int getNumFrames ( ) #

Returns the number of the path frames.

Return value

Number of path frames.

int isOwner ( ) #

Math::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. The default is 0 (path isn't looped).

Return value

Object position coordinates at the specified time.

Math::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. The default is 0 (path isn't looped).

Return value

Object rotation at the specified time.

Math::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. The default is 0 (path isn't looped).

Return value

Object scale at the specified time.

Math::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. The default is 0 (path isn't looped).

Return value

Object transformation matrix at the specified time.

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 path (including its times and frames).

void grab ( ) #

int load ( const char * name ) #

Loads the path with the given name and *.path extension.

Arguments

  • const char * name - The path name.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

void release ( ) #

Sets the owner flag to 0 for the world pointer. The world should be handled by the class after this function is called.

void removeFrame ( int num ) #

Removes the specified frame.

Arguments

  • int num - The frame number.

int save ( const char * name ) #

Saves the path under the given name with the *.path extension.

Arguments

  • const char * name - The path name.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.
Last update: 2019-07-18