UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and 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
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Unigine::WorldIntersectionNormal Class

Header: #include <UnigineWorld.h>
Inherits: WorldIntersection

This class stores the normal of the intersection point. You should use this class when you need additional information about the normal at the intersection point (it also stores 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 WorldIntersectionNormal 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 WorldIntersectionNorma class instance gets the normal of the intersection point. You can get the normal by using the getNormal() function.
Source code (C++)
/* ... */
// initialize points of the mouse direction
Vec3 p0,p1;

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

// create an instance of the WorldIntersectionNormal class to get the result
WorldIntersectionNormalPtr intersection = WorldIntersectionNormal::create();

// create an instance for intersected object and check the intersection
ObjectPtr object = World::get()->getIntersection(p0,p1,1,intersection);

// if the intersection has been occurred, change the parameter of the object's material
if(object)
{
  for (int i = 0; i < object->getNumSurfaces(); i++)
  {
    object->setMaterialParameter("albedo_color", vec4(1.0f, 0.0f, 0.0f, 1.0f),i);
    
    // show intersection details in console
    Log::message("Normal: type %s coordinates (%f %f %f)\n", typeid(intersection->getNormal()).name(),
		intersection->getNormal().x,
		intersection->getNormal().y,
		intersection->getNormal().z);
  }
}
/* ... */

WorldIntersectionNormal Class

Members


static WorldIntersectionNormalPtr create ( )

The WorldIntersectionNormal constructor.

void setNormal( const Math::vec3 & normal )

Sets the new normal of the intersection point.

Arguments

  • const Math::vec3 & normal - Normal of the intersection point.

Math::vec3 getNormal( )

Returns the normal of the intersection point.

Return value

Normal of the intersection point.
Last update: 2018-12-17