This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
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
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

PhysicalForce 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 UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Inherits: Physical

This class is used to simulate a point force that pulls physical bodies up to or away from the point. It can also rotate them around the force center.

Notice
The physical force can affect only a cloth, a rope or a rigid body. If the rigid body is used, a shape should be also assigned.

See also#

  • An article on Physical Force
  • A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/physicals/ folder:
    • force_00
    • force_01

PhysicalForce Class

Members


static PhysicalForce ( float radius ) #

Constructor. Creates a physical force node with the specified radius in units.

Arguments

  • float radius - The radius of the physical force node in units.

void setAttenuation ( float attenuation ) #

Updates the attenuation factor for the physical force.

Arguments

  • float attenuation - Attenuation factor.

float getAttenuation ( ) #

Returns the current attenuation factor for the physical force.

Return value

Attenuation factor.

void setAttractor ( float attractor ) #

Updates attraction force that will be applied to objects in the physical force radius.

Arguments

  • float attractor - Attraction force value. If a positive value is specified, objects will be pulled away from the force point. If a negative value is specified, objects will be pulled up to the force center.

float getAttractor ( ) #

Returns the current attraction force applied to objects in the physical force radius. Positive values pull objects away from the force point, negative values pull them up to it.

Return value

Attraction force value.

void setRadius ( float radius ) #

Updates the radius for applying the physical force.

Arguments

  • float radius - Radius in units. If a negative value is provided, 0 will be used instead.

float getRadius ( ) #

Returns the current radius set for applying the physical force.

Return value

Radius in units.

void setRotator ( float rotator ) #

Updates rotation force that will be applied to objects in the physical force radius.

Arguments

  • float rotator - Rotation force value. If a positive value is specified, object will be rotated clockwise. If a negative value is specified, objects will be rotated counterclockwise.

float getRotator ( ) #

Returns the current rotation force that will be applied to objects in the physical force radius. Positive values rotate objects clockwise, negative values rotate them counterclockwise.

Return value

Rotation force value.

static int type ( ) #

Returns the type of the node.

Return value

Physical type identifier.
Last update: 2020-07-31
Build: ()