Unigine.Physics Class

Physics Class

Enums

UPDATE_MODE#

SHOW_TYPE#

Properties

float TotalTime#

float SimulationTime#

float WaitTime#

int NumJoints#

int NumIslands#

int NumContacts#

int NumBodies#

float CollisionTime#

int Frame#

int NumIterations#

int NumFrozenFrames#

float CurrentSubframeTime#

float Scale#

float PenetrationTolerance#

float PenetrationFactor#

float MaxLinearVelocity#

float MaxAngularVelocity#

float LinearDamping#

float IFps#

vec3 Gravity#

float FrozenLinearVelocity#

float FrozenAngularVelocity#

float AngularDamping#

float Distance#

float Budget#

string Data#

bool SyncEngineUpdateWithPhysics#

bool Determinism#

bool Enabled#

float MissedFrameLifetime#

Physics.UPDATE_MODE UpdateMode#

bool StableFPS#

bool ShowContacts#

Physics.SHOW_TYPE ShowShapes#

float ShowShapesDistance#

bool ShowCollisionSurfaces#

bool ShowJoints#

Members

Body GetBody ( int id ) #

Arguments

• int id - Body ID.

Return value

bool IsBody ( int id ) #

Arguments

• int id - Body ID.

Return value

Object GetIntersection ( vec3 p0, vec3 p1, int mask, Node[] exclude, PhysicsIntersection intersection ) #

Performs tracing from the p0 point to the p1 point to find a collision object located on that line. If an object is assigned a body, intersection occurs with its shape. If an object has no body, this function detects intersection with surfaces (polygons) of objects with intersection flag set. Intersection is found only for objects with a matching mask if their ID is not found in the exclude list. Intersection does not work for disabled objects.

Arguments

• vec3 p0 - Line start point coordinates.
• vec3 p1 - Line end point coordinates.
• int mask - Physics intersection mask. If 0 is passed, the function will return NULL.
• Node[] exclude - Array of nodes to be excluded.
• PhysicsIntersection intersection - PhysicsIntersection class instance containing intersection data.

Return value

Object GetIntersection ( vec3 p0, vec3 p1, int mask, Node[] exclude, Shape.TYPE[] exclude_types, PhysicsIntersection intersection ) #

Performs tracing from the p0 point to the p1 point to find a collision object located on that line. If an object is assigned a body, intersection occurs with its shape. If an object has no body, this function detects intersection with surfaces (polygons) of objects with intersection flag set. Intersection is found only for objects with a matching mask if their ID is not found in the exclude list and only for shape types not mentioned in the exclude_types list. Intersection does not work for disabled objects.

Arguments

• vec3 p0 - Line start point coordinates.
• vec3 p1 - Line end point coordinates.
• int mask - Physics intersection mask. If 0 is passed, the function will return NULL.
• Node[] exclude - Array of nodes to be excluded.
• Shape.TYPE[] exclude_types - Array of shape types to be excluded.
• PhysicsIntersection intersection - PhysicsIntersection class instance containing intersection data.

Return value

Object GetIntersection ( vec3 p0, vec3 p1, int mask, PhysicsIntersection intersection ) #

Performs tracing from the p0 point to the p1 point to find a collision object located on that line. If an object is assigned a body, intersection occurs with its shape. If an object has no body, this function detects intersection with surfaces (polygons) of objects with intersection flag set. Physics intersection shall only be detected for objects with a matching mask. Intersection does not work for disabled objects.

Usage Example

The following example shows how you can get the intersection information by using the PhysicsIntersection class. In this example we specify a line from the point of the camera (vec3 p0) to the point of the mouse pointer (vec3 p1). The executing sequence is the following:

1. Define and initialize two points (p0 and p1) by using the Player.GetDirectionFromScreen() function.
2. Create an instance of the PhysicsIntersection class to get the intersection information.
3. Check, if there is an intersection with an object with a shape or a collision object. The GetIntersection() function returns an intersected object when the object intersects with the traced line.
4. When the object intersects with the traced line, all surfaces of the intersected object change their material parameters. If the object has a shape, its information will be shown in console. The PhysicsIntersection class instance gets the coordinates of the intersection point and the Shape class object. You can get all these fields by using the Shape, Point properties.

private void Update()
{
	// initialize points of the mouse direction
	Vec3 p0, p1;

	// get the current player (camera)
	Player player = Game.Player;
		
	// get the size of the current application window
	EngineWindow main_window = WindowManager.MainWindow;
	if (!main_window)
	{
		Engine.Quit();
		return;
	}

	ivec2 main_size = main_window.Size;

	// get the current X and Y coordinates of the mouse pointer
	int mouse_x = Gui.GetCurrent().MouseX;
	int mouse_y = Gui.GetCurrent().MouseY;
	// 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, 0, 0, main_size.x, main_size.y);

	// create the instance of the PhysicsIntersection object to save the information about the intersection
	PhysicsIntersection intersection = new PhysicsIntersection();
	// get an intersection
	Unigine.Object obj = Physics.GetIntersection(p0, p1, 1, intersection);

	// if the intersection has 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, 1.0f, 0.0f, 1.0f), i);
		}

		// if the intersected object has a shape, show the information about the intersection   
		Shape shape = intersection.Shape;
		if (shape != null)
		{
			Log.Message("physics intersection info: point: ({0} {1} {2}) shape: {3}\n", intersection.Point.x, intersection.Point.y, intersection.Point.z, shape.TypeName);
		}
	}
	
}

Arguments

• vec3 p0 - Line start point coordinates.
• vec3 p1 - Line end point coordinates.
• int mask - Physics intersection mask. If 0 is passed, the function will return NULL.
• PhysicsIntersection intersection - PhysicsIntersection class instance containing intersection data.

Return value

Object GetIntersection ( vec3 p0, vec3 p1, int mask, PhysicsIntersectionNormal intersection ) #

Performs tracing from the p0 point to the p1 point to find a collision object located on that line. If an object is assigned a body, intersection occurs with its shape. If an object has no body, this function detects intersection with surfaces (polygons) of objects with intersection flag set. Physics intersection shall only be detected for objects with a matching mask. Intersection does not work for disabled objects.

Arguments

• vec3 p0 - Line start point coordinates.
• vec3 p1 - Line end point coordinates.
• int mask - Physics intersection mask. If 0 is passed, the function will return NULL.
• PhysicsIntersectionNormal intersection - PhysicsIntersectionNormal class instance containing intersection data.

Return value