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

Unigine.WorldIntersection Class

This class stores the result of the world intersection (the coordinates of the intersection, the index of the intersected triangle and the index of the intersected surface).

Usage Example#

The following example shows how you can get the intersection information by using the WorldIntersection 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 Player.getDirectionFromScreen()> function.
  • Create an instance of the WorldIntersection class to get the intersection information.
  • Check, if there is a intersection with an object. The World.getIntersection() function returns an intersected object when the object intersects with the traced line.
  • In this example, when the object intersects with the traced line, all the surfaces of the intersected object change their material parameters. The WorldIntersection class instance gets the coordinates of the intersection point and the index of the intersected triangle. You can get all these fields by using getIndex() and getPoint() functions
Source code (C#)
/* ... */
// initialize points of the mouse direction
Vec3 p0,p1;

// get the current player (camera)
Player player = Game.Player;
if (player == null)
	return 0;
// get width and height of the current application window
int width = App.getWidth();
int height = App.getHeight();
// get the current X and Y coordinates of the mouse pointer
int mouse_x = App.getMouseX();
int mouse_y = App.getMouseY();
// get the mouse direction from the player's position (p0) to the mouse cursor pointer (p1)
player.getDirectionFromScreen(out p0, out p1, mouse_x, mouse_y, width, height);

// create an instance of the WorldIntersection class to get the result
WorldIntersection intersection = new WorldIntersection();

// create an instance for intersected object and check the intersection
Unigine.Object obj = World.GetIntersection(p0,p1,1,intersection);

// if the intersection has been occurred, change the parameter of the object's material
if(obj != null)
{
  for (int i = 0; i < obj.NumSurfaces; i++)
  {
    obj.setMaterialParameterFloat4("albedo_color", new vec4(1.0f, 0.0f, 0.0f, 1.0f),i);
    
    // show intersection details in console
    Log.Message("point: ({0} {1} {2}) index: {3} \n", intersection.Point.x, intersection.Point.y, intersection.Point.z, intersection.Index);
  }
}
/* ... */

WorldIntersection Class

Enums

TYPE#

NameDescription
WORLD_INTERSECTION = 0The intersection point (coordinates), the index of the intersected triangle of the object and the index of the intersected surface.
WORLD_INTERSECTION_NORMAL = 1The normal of the intersection point.
WORLD_INTERSECTION_TEX_COORD = 2The texture coordinates of the intersection point.
NUM_WORLD_INTERSECTIONS = 3Total number of world intersections.

Properties

int Surface#

The intersected surface number.
set
Sets the new intersection surface number.
set value - Intersection surface number.

int Instance#

The number of the intersected instance.
Notice
Intersected instance number can be obtained for the following classes:
set
Sets the new intersected instance number.
Notice
Intersected instance number can be obtained for the following classes:
set value - Intersected instance number.

int Index#

The number of the intersected triangle.
set
Sets the new intersection triangle number.
set value - Intersection triangle number.

vec3 Point#

Coordinates of the intersection point.
set
Sets new coordinates of the intersection point.
set value - Coordinates of the intersection point.

string TypeName#

World intersection type name.

WorldIntersection.TYPE Type#

Members


static WorldIntersection ( ) #

The WorldIntersection constructor.

WorldIntersection.TYPE GetType ( ) #

Returns the world intersection type identifier.

Return value

World intersection type identifier.

string GetTypeName ( ) #

Returns the world intersection type name.

Return value

World intersection type name.
Last update: 2020-06-01
Build: ()