unreal.PlanarConstraintUtils

class unreal.PlanarConstraintUtils(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

PlanarConstraintUtils: a collection of stateless static BP-accessible functions for working with planar constraints

C++ Source:

  • Plugin: Mover

  • Module: Mover

  • File: ConstrainedMoveUtils.h

classmethod constrain_direction_to_plane(constraint, direction, maintain_magnitude=False) → Vector

Constrains a direction to be on the plane, if enabled

Parameters:
Return type:

Vector

classmethod constrain_location_to_plane(constraint, location) → Vector

Constrains a location to be on the plane, if enabled

Parameters:
Return type:

Vector

classmethod constrain_normal_to_plane(constraint, normal) → Vector

Constrains a normal to be on the plane, if enabled. Result will be re-normalized.

Parameters:
Return type:

Vector

classmethod set_planar_constraint_enabled(constraint, enabled) → PlanarConstraint

Sets whether or not the constraint is enabled

Parameters:
Returns:

constraint (PlanarConstraint):

Return type:

PlanarConstraint

classmethod set_planar_constraint_normal(constraint, plane_normal) → PlanarConstraint

Sets the normal of the plane that constrains movement, enforced if the plane constraint is enabled.

Parameters:

  • constraint (PlanarConstraint)

  • plane_normal (Vector) – The normal of the plane. If non-zero in length, it will be normalized.

Returns:

constraint (PlanarConstraint):

Return type:

PlanarConstraint

classmethod set_plane_constraint_origin(constraint, plane_origin) → PlanarConstraint

Sets the origin of the plane that constrains movement, enforced if the plane constraint is enabled.

Parameters:
Returns:

constraint (PlanarConstraint):

Return type:

PlanarConstraint