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.

PhysicsIntersectionNormal 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.

This class stores all information on the point of physics intersection (coordinates of the intersection, the shape of the object, the index of the surface) plus the normal coordinates at this point.

Usage Example#

The following example shows how you can get the normal at the intersection point by using the PhysicsIntersectionNormal class. In this example the line is an invisible traced line from the point of the camera (vec3 p0) to the point of the mouse pointer (vec3 p1). The executing sequence is the following:

  • Define and initialize two points (p0 and p1) by using the getPlayerMouseDirection() function from core/scripts/utils.h.
  • Create an instance of the PhysicsIntersectionNormal class to get the normal of the intersection point.
  • Check, if there is a intersection with an object.
  • In this example, when the object intersects with the traced line, all the surfaces of the intersected object change their material parameters. The PhysicsIntersectionNormal class instance gets the normal of the intersection point. You can get it by using getNormal() function
Source code (UnigineScript)
#include <core/scripts/utils.h>
/* ... */
// define two vec3 coordinates
vec3 p0,p1;
// get the mouse direction from camera (p0) to cursor pointer (p1)
getPlayerMouseDirection(p0,p1);

// create the instance of the PhysicsIntersectionNormal object to save the result
PhysicsIntersectionNormal intersection = new PhysicsIntersectionNormal();
// create an instance for intersected object and check the intersection
Object object = engine.physics.getIntersection(p0,p1,1,intersection);

// if the intersection has been occurred, change the parameter of the object's material    
if(object != NULL)
{
  forloop(int i=0; object.getNumSurfaces())
  {
    object.setMaterialParameterFloat4("albedo_color", vec4(1.0f, 0.0f, 0.0f, 1.0f),i);
  }
  
  // show the normal in console
  log.message("normal: %s \n", typeinfo(intersection.getNormal()));
}
/* ... */

PhysicsIntersectionNormal Class

Members


static PhysicsIntersectionNormal ( ) #

The PhysicsIntersectionNormal constructor.

void setNormal ( vec3 normal ) #

Sets the new normal of the intersection point.

Arguments

  • vec3 normal - Normal of the intersection point.

vec3 getNormal ( ) #

Returns the normal of the intersection point.

Return value

Normal of the intersection point.
Last update: 2020-07-31
Build: ()