unreal.RigVMFunction_MathRayIntersectPlane

class unreal.RigVMFunction_MathRayIntersectPlane(ray: Ray = Ellipsis, plane_point: Vector = Ellipsis, plane_normal: Vector = Ellipsis, result: Vector = Ellipsis, distance: float = 0.0, ratio: float = 0.0)

Bases: RigVMFunction_MathRayBase

Returns the closest point intersection of a ray with a plane

C++ Source:

  • Plugin: RigVM

  • Module: RigVM

  • File: RigVMFunction_MathRay.h

Editor Properties: (see get_editor_property/set_editor_property)

  • distance (float): [Read-Write] The distance of the ray origin to the plane

  • plane_normal (Vector): [Read-Write] The normal of the plane to intersect the ray with

  • plane_point (Vector): [Read-Write] The point on the plane to intersect the ray with

  • ratio (float): [Read-Write] The ratio along the ray up to the intersection point

  • ray (Ray): [Read-Write] The ray to intersect with the plane

  • result (Vector): [Read-Write] The resulting intersection position

property distance: float

[Read-Only] The distance of the ray origin to the plane

Type:

(float)

property plane_normal: Vector

[Read-Write] The normal of the plane to intersect the ray with

Type:

(Vector)

property plane_point: Vector

[Read-Write] The point on the plane to intersect the ray with

Type:

(Vector)

property ratio: float

[Read-Only] The ratio along the ray up to the intersection point

Type:

(float)

property ray: Ray

[Read-Write] The ray to intersect with the plane

Type:

(Ray)

property result: Vector

[Read-Only] The resulting intersection position

Type:

(Vector)