unreal.RigVMFunction_MathDistanceToPlane

class unreal.RigVMFunction_MathDistanceToPlane(point: Vector = Ellipsis, plane_point: Vector = Ellipsis, plane_normal: Vector = Ellipsis, closest_point_on_plane: Vector = Ellipsis, signed_distance: float = 0.0)

Bases: RigVMFunction_MathVectorBase

Find the point on the plane that is closest to the given point and the distance between them.

C++ Source:

  • Plugin: RigVM

  • Module: RigVM

  • File: RigVMFunction_MathVector.h

Editor Properties: (see get_editor_property/set_editor_property)

  • closest_point_on_plane (Vector): [Read-Write] The resulting closest point on the plane

  • plane_normal (Vector): [Read-Write] The normal of the plane to measure against

  • plane_point (Vector): [Read-Write] A point on the plane to measure against

  • point (Vector): [Read-Write] The point to measure against the plane

  • signed_distance (float): [Read-Write] The distance to the plane as a signed (positive or negative) value

property closest_point_on_plane: Vector

[Read-Only] The resulting closest point on the plane

Type:

(Vector)

property plane_normal: Vector

[Read-Write] The normal of the plane to measure against

Type:

(Vector)

property plane_point: Vector

[Read-Write] A point on the plane to measure against

Type:

(Vector)

property point: Vector

[Read-Write] The point to measure against the plane

Type:

(Vector)

property signed_distance: float

[Read-Only] The distance to the plane as a signed (positive or negative) value

Type:

(float)