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

BodyPath Class

This class represents a path along which an arbitrary rigid body can be moved. For example, it allows for creation of a physically simulated train moving along the railtrack. BodyRigid and BodyPath should be connected together with JointPath.

Notice
The path is a spline along which an object can be moved.

See Also

  • A set of samples located in the data/samples/ directory, namely:
    1. physics/train_00.cpp
    2. joints/path_00.cpp
  • Article on UnigineScript Migration

BodyPath Class

This class inherits from Body

Members


BodyPath ()

Constructor. Creates a path with default properties, along which a rigid body is moved.

BodyPath (Object object)

Constructor. Creates a path with default properties for the given object. Along this path a rigid body is moved.

Arguments

  • Object object - Object represented with the new path body.

vec3 getClosestPosition (vec3 position)

Finds the point on the path which is the closest to the given reference point.

Arguments

  • vec3 position - Coordinates of the reference point.

Return value

Coordinates of the reference point, if the path exists; otherwise, the (0 0 0) vector is returned.

quat getClosestRotation (vec3 position)

Finds the point on the path which is the closest to the given reference point and returns rotation set by the path in this point.

Arguments

  • vec3 position - Coordinates of the reference point.

Return value

Rotation set by the path in the found point, if the path is exists; otherwise, the (0 0 0 1) quaternion is returned.

string getPathName ()

Returns a name of the path along which physical objects are moving.

Return value

Path to the path file.

Path getPath ()

Returns the path along which physical objects are moving. By using this function, you can change velocity of the objects moving along the path, their transformation, etc.

Return value

Instance of the Path class.

void setPathName (string name, int dynamic = 0)

Reloads the internal path transformation.

Arguments

  • string name - Path to the path file to be set.
  • int dynamic - The dynamic flag:
    • 0 - If the reloaded path is changed in run-time, paths loaded from the same file will be also changed.
    • 1 - If the reloaded path is changed in run-time, paths loaded from the same file won't be changed.
Last update: 2017-07-03