BodyPath Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| Inherits from: | Body |
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:
- physics/train_00.cpp
- joints/path_00.cpp
BodyPath Class
Members
static BodyPath ( ) #
Constructor. Creates a path with default properties, along which a rigid body is moved.static 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.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 unique = 0 ) #
Reloads the internal path transformation.Arguments
- string name - Path to the path file to be set.
- int unique - The dynamic flag:
- 0 - If the reloaded path is changed at run time, paths loaded from the same file will be also changed.
- 1 - If the reloaded path is changed at run time, paths loaded from the same file won't be changed.
string getPathName ( ) #
Returns a name of the path along which physical objects are moving.Return value
Path to the path file.Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)