WorldIntersection 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.
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 getPlayerMouseDirection() function from core/scripts/utils.h.
- Create an instance of the WorldIntersection class to get the intersection information.
- Check, if there is a intersection with an object. The engine.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, the index of the surface and the index of the intersected triangle. You can get all these fields by using getIndex(), getPoint() and getSurface() functions
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 an instance of the WorldIntersection class to get the result
WorldIntersection intersection = new WorldIntersection();
// create an instance for intersected object and check the intersection
Object object = engine.world.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("diffuse_color", vec4(1.0f, 0.0f, 0.0f, 1.0f),i);
object.setMaterialTexture("diffuse","", i);
// show intersection details in console
log.message("point: %s index: %i surface: %i \n", typeinfo(intersection.getPoint()), intersection.getIndex(), intersection.getSurface());
}
}
/* ... */WorldIntersection Class
Members
static WorldIntersection ( ) #
The WorldIntersection constructor.void setIndex ( int index ) #
Sets the new intersection triangle number.Arguments
- int index - Intersection triangle number.
int getIndex ( ) #
Returns the number of the intersected triangle.Return value
Intersected triangle number.void setInstance ( int instance ) #
Sets the new intersected instance number.Notice
Intersected instance number can be obtained for the following classes:
Arguments
- int instance - Intersected instance number.
int getInstance ( ) #
Returns the number of the intersected instance.Notice
Intersected instance number can be obtained for the following classes:
Return value
Intersected instance number.void setPoint ( Vec3 point ) #
Sets new coordinates of the intersection point.Arguments
- Vec3 point - Coordinates of the intersection point.
Vec3 getPoint ( ) #
Returns coordinates of the intersection point.Return value
Coordinates of the intersection point.void setSurface ( int surface ) #
Sets the new intersection surface number.Arguments
- int surface - Intersection surface number.
int getSurface ( ) #
Returns the intersected surface number.Return value
Intersected surface number.int 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:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)