This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine.BodyPath Class

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:
    1. physics/train_00.cpp
    2. joints/path_00.cpp

BodyPath Class

Properties

Path Path#

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.

string PathName#

The A name of the path along which physical objects are moving.

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.
Last update: 2024-12-13
Build: ()