unreal.RigVMFunction_MathBoxGetDistance

class unreal.RigVMFunction_MathBoxGetDistance(box: Box = Ellipsis, position: Vector = Ellipsis, square: bool = False, valid: bool = False, distance: float = 0.0)

Bases: RigVMFunction_MathBoxBase

Returns the distance to a given box

C++ Source:

  • Plugin: RigVM

  • Module: RigVM

  • File: RigVMFunction_MathBox.h

Editor Properties: (see get_editor_property/set_editor_property)

  • box (Box): [Read-Write] The box to measure the distance to

  • distance (float): [Read-Write] The distance between the box and the position

  • position (Vector): [Read-Write] The position to measure the distance to

  • square (bool): [Read-Write] if true the distance will be returned square

  • valid (bool): [Read-Write] Returns true if the computed distance is valid

property box: Box

[Read-Write] The box to measure the distance to

Type:

(Box)

property distance: float

[Read-Only] The distance between the box and the position

Type:

(float)

property position: Vector

[Read-Write] The position to measure the distance to

Type:

(Vector)

property square: bool

[Read-Write] if true the distance will be returned square

Type:

(bool)

property valid: bool

[Read-Only] Returns true if the computed distance is valid

Type:

(bool)