IuvoUnity.Extensions.RigidbodyExtensions Class Reference

Extension methods for Unity's Rigidbody component, providing utility methods for velocity, forces, rotation, and movement control. More...

Static Public Member Functions
static void	SetVelocityX (this Rigidbody rb, float velocity)
	Sets the X component of the Rigidbody's velocity.
static void	SetVelocityY (this Rigidbody rb, float velocity)
	Sets the Y component of the Rigidbody's velocity.
static void	SetVelocityZ (this Rigidbody rb, float velocity)
	Sets the Z component of the Rigidbody's velocity.
static void	SetVelocityTo (this Rigidbody rb, Vector3 targetVelocity)
	Sets the Rigidbody's velocity to a target vector.
static void	SetRandomVelocity (this Rigidbody rb, float minSpeed, float maxSpeed)
	Sets a random velocity with speed between the specified minimum and maximum.
static void	ResetVelocity (this Rigidbody rb)
	Resets the Rigidbody's linear velocity to zero.
static void	ResetAngularVelocity (this Rigidbody rb)
	Resets the Rigidbody's angular velocity to zero.
static void	AddDampedForce (this Rigidbody rb, Vector3 force, float damping)
	Applies a damped force to the Rigidbody.
static void	ApplyImpulseAtPoint (this Rigidbody rb, Vector3 impulse, Vector3 point)
	Applies an impulse force at a specific point.
static void	ApplyForceByMass (this Rigidbody rb, Vector3 force)
	Applies a force scaled by the Rigidbody's mass.
static void	ApplyJumpForce (this Rigidbody rb, float jumpForce)
	Applies an upward impulse to simulate a jump.
static void	ApplyForceInDirectionOfVelocity (this Rigidbody rb, float forceAmount)
	Applies force in the direction of current velocity.
static void	ApplyKnockbackForce (this Rigidbody rb, Vector3 impactPoint, float knockbackStrength)
	Applies a knockback impulse away from a given impact point.
static void	ApplyRandomTorque (this Rigidbody rb, float torqueAmount)
	Applies random rotational torque to the Rigidbody.
static void	RotateToAngle (this Rigidbody rb, Vector3 targetDirection, float speed)
	Rotates the Rigidbody to face a target direction over time.
static void	RotateToAlignWithTarget (this Rigidbody rb, Vector3 targetPosition, float torqueAmount)
	Rotates the Rigidbody using torque to align with a target position.
static void	ApplySpin (this Rigidbody rb, float torqueAmount)
	Applies continuous torque around the Y-axis.
static void	SetPositionDirectly (this Rigidbody rb, Vector3 position)
	Directly sets the Rigidbody's position.
static bool	IsMoving (this Rigidbody rb)
	Checks whether the Rigidbody is currently moving.
static bool	IsMovingDown (this Rigidbody rb)
	Checks whether the Rigidbody is currently moving downwards.
static float	GetSpeedInForwardDirection (this Rigidbody rb)
	Gets the speed in the forward direction of the Rigidbody.
static void	FreezeMovementInDirection (this Rigidbody rb, Vector3 direction)
	Restricts Rigidbody movement to a single direction.
static void	StopAtPosition (this Rigidbody rb, Vector3 position)
	Stops the Rigidbody when it reaches a specified position.
static void	ApplyStopImpulse (this Rigidbody rb)
	Applies an impulse opposite to current velocity to bring Rigidbody to a stop.
static void	ResetAll (this Rigidbody rb)
	Resets the Rigidbody's position, velocity, and angular velocity.
static void	IgnoreGravityForTime (this Rigidbody rb, float time, MonoBehaviour context)
	Temporarily disables gravity on a Rigidbody for a set duration.

Static Private Member Functions
static IEnumerator	RestoreGravityAfterTime (Rigidbody rb, float time)

Detailed Description

Extension methods for Unity's Rigidbody component, providing utility methods for velocity, forces, rotation, and movement control.

Member Function Documentation

AddDampedForce()

void IuvoUnity.Extensions.RigidbodyExtensions.AddDampedForce ( this Rigidbody rb, Vector3 force, float damping )

static

Applies a damped force to the Rigidbody.

Parameters

rb	The Rigidbody to apply force to.
force	The base force vector.
damping	The damping factor to reduce the force.

            {
                rb.AddForce(force * damping);
            }

ApplyForceByMass()

void IuvoUnity.Extensions.RigidbodyExtensions.ApplyForceByMass ( this Rigidbody rb, Vector3 force )

static

Applies a force scaled by the Rigidbody's mass.

Parameters

rb	The Rigidbody to apply force to.
force	The base force vector.

            {
                rb.AddForce(force * rb.mass, ForceMode.Force);
            }

ApplyForceInDirectionOfVelocity()

void IuvoUnity.Extensions.RigidbodyExtensions.ApplyForceInDirectionOfVelocity ( this Rigidbody rb, float forceAmount )

static

Applies force in the direction of current velocity.

Parameters

rb	The Rigidbody to modify.
forceAmount	The magnitude of the force to apply.

            {
                if (rb.linearVelocity.sqrMagnitude > 0.01f)
                    rb.AddForce(rb.linearVelocity.normalized * forceAmount, ForceMode.VelocityChange);
            }

ApplyImpulseAtPoint()

void IuvoUnity.Extensions.RigidbodyExtensions.ApplyImpulseAtPoint ( this Rigidbody rb, Vector3 impulse, Vector3 point )

static

Applies an impulse force at a specific point.

Parameters

rb	The Rigidbody to apply the impulse to.
impulse	The impulse vector.
point	The world position where the impulse is applied.

            {
                rb.AddForceAtPosition(impulse, point, ForceMode.Impulse);
            }

ApplyJumpForce()

void IuvoUnity.Extensions.RigidbodyExtensions.ApplyJumpForce ( this Rigidbody rb, float jumpForce )

static

Applies an upward impulse to simulate a jump.

Parameters

rb	The Rigidbody to apply the force to.
jumpForce	The magnitude of the jump force.

            {
                rb.AddForce(Vector3.up * jumpForce * rb.mass, ForceMode.Impulse);
            }

ApplyKnockbackForce()

void IuvoUnity.Extensions.RigidbodyExtensions.ApplyKnockbackForce ( this Rigidbody rb, Vector3 impactPoint, float knockbackStrength )

static

Applies a knockback impulse away from a given impact point.

Parameters

rb	The Rigidbody to knock back.
impactPoint	The point of impact.
knockbackStrength	The strength of the knockback.

            {
                Vector3 direction = (rb.position - impactPoint).normalized;
                rb.AddForce(direction * knockbackStrength, ForceMode.Impulse);
            }

ApplyRandomTorque()

void IuvoUnity.Extensions.RigidbodyExtensions.ApplyRandomTorque ( this Rigidbody rb, float torqueAmount )

static

Applies random rotational torque to the Rigidbody.

Parameters

rb	The Rigidbody to apply torque to.
torqueAmount	The amount of torque to apply.

            {
                rb.AddTorque(UnityEngine.Random.onUnitSphere * torqueAmount, ForceMode.Impulse);
            }

ApplySpin()

void IuvoUnity.Extensions.RigidbodyExtensions.ApplySpin ( this Rigidbody rb, float torqueAmount )

static

Applies continuous torque around the Y-axis.

Parameters

rb	The Rigidbody to spin.
torqueAmount	The amount of Y-axis torque to apply.

            {
                rb.AddTorque(Vector3.up * torqueAmount, ForceMode.VelocityChange);
            }

ApplyStopImpulse()

void IuvoUnity.Extensions.RigidbodyExtensions.ApplyStopImpulse ( this Rigidbody rb )

static

Applies an impulse opposite to current velocity to bring Rigidbody to a stop.

Parameters

rb	The Rigidbody to stop.

            {
                rb.AddForce(-rb.linearVelocity, ForceMode.Impulse);
            }

FreezeMovementInDirection()

void IuvoUnity.Extensions.RigidbodyExtensions.FreezeMovementInDirection ( this Rigidbody rb, Vector3 direction )

static

Restricts Rigidbody movement to a single direction.

Parameters

rb	The Rigidbody to modify.
direction	The direction to allow movement in.

            {
                rb.linearVelocity = Vector3.Project(rb.linearVelocity, direction.normalized);
            }

GetSpeedInForwardDirection()

float IuvoUnity.Extensions.RigidbodyExtensions.GetSpeedInForwardDirection ( this Rigidbody rb )

static

Gets the speed in the forward direction of the Rigidbody.

Parameters

rb	The Rigidbody to evaluate.

Returns

The speed in forward direction (dot product).

            {
                return Vector3.Dot(rb.linearVelocity, rb.transform.forward);
            }

IgnoreGravityForTime()

void IuvoUnity.Extensions.RigidbodyExtensions.IgnoreGravityForTime ( this Rigidbody rb, float time, MonoBehaviour context )

static

Temporarily disables gravity on a Rigidbody for a set duration.

Parameters

rb	The Rigidbody to modify.
time	Duration in seconds before restoring gravity.
context	A MonoBehaviour context to start the coroutine.

This method requires a MonoBehaviour to start the coroutine.

            {
                context.StartCoroutine(RestoreGravityAfterTime(rb, time));
            }

References RestoreGravityAfterTime().

IsMoving()

bool IuvoUnity.Extensions.RigidbodyExtensions.IsMoving ( this Rigidbody rb )

static

Checks whether the Rigidbody is currently moving.

Parameters

rb	The Rigidbody to check.

Returns

True if velocity magnitude is greater than 0.1.

            {
                return rb.linearVelocity.magnitude > 0.1f;
            }

IsMovingDown()

bool IuvoUnity.Extensions.RigidbodyExtensions.IsMovingDown ( this Rigidbody rb )

static

Checks whether the Rigidbody is currently moving downwards.

Parameters

rb	The Rigidbody to check.

Returns

True if Y velocity is less than 0.

            {
                return rb.linearVelocity.y < 0;
            }

ResetAll()

void IuvoUnity.Extensions.RigidbodyExtensions.ResetAll ( this Rigidbody rb )

static

Resets the Rigidbody's position, velocity, and angular velocity.

Parameters

rb	The Rigidbody to reset.

            {
                rb.position = Vector3.zero;
                rb.linearVelocity = Vector3.zero;
                rb.angularVelocity = Vector3.zero;
            }

ResetAngularVelocity()

void IuvoUnity.Extensions.RigidbodyExtensions.ResetAngularVelocity ( this Rigidbody rb )

static

Resets the Rigidbody's angular velocity to zero.

Parameters

rb	The Rigidbody to modify.

            {
                rb.angularVelocity = Vector3.zero;
            }

ResetVelocity()

void IuvoUnity.Extensions.RigidbodyExtensions.ResetVelocity ( this Rigidbody rb )

static

Resets the Rigidbody's linear velocity to zero.

Parameters

rb	The Rigidbody to modify.

            {
                rb.linearVelocity = Vector3.zero;
            }

RestoreGravityAfterTime()

IEnumerator IuvoUnity.Extensions.RigidbodyExtensions.RestoreGravityAfterTime ( Rigidbody rb, float time )

staticprivate

            {
                rb.useGravity = false;
                yield return new WaitForSeconds(time);
                rb.useGravity = true;
            }

Referenced by IgnoreGravityForTime().

RotateToAlignWithTarget()

void IuvoUnity.Extensions.RigidbodyExtensions.RotateToAlignWithTarget ( this Rigidbody rb, Vector3 targetPosition, float torqueAmount )

static

Rotates the Rigidbody using torque to align with a target position.

Parameters

rb	The Rigidbody to rotate.
targetPosition	The world position to look at.
torqueAmount	The torque strength to apply.

            {
                Vector3 directionToTarget = (targetPosition - rb.position).normalized;
                Vector3 torque = Vector3.Cross(rb.transform.forward, directionToTarget);
                rb.AddTorque(torque * torqueAmount);
            }

RotateToAngle()

void IuvoUnity.Extensions.RigidbodyExtensions.RotateToAngle ( this Rigidbody rb, Vector3 targetDirection, float speed )

static

Rotates the Rigidbody to face a target direction over time.

Parameters

rb	The Rigidbody to rotate.
targetDirection	The world direction to face.
speed	Rotation speed in radians per second.

            {
                Vector3 newDirection = Vector3.RotateTowards(rb.transform.forward, targetDirection, speed * Time.deltaTime, 0f);
                rb.rotation = Quaternion.LookRotation(newDirection);
            }

SetPositionDirectly()

void IuvoUnity.Extensions.RigidbodyExtensions.SetPositionDirectly ( this Rigidbody rb, Vector3 position )

static

Directly sets the Rigidbody's position.

Parameters

rb	The Rigidbody to move.
position	The new world position.

            {
                rb.position = position;
            }

SetRandomVelocity()

void IuvoUnity.Extensions.RigidbodyExtensions.SetRandomVelocity ( this Rigidbody rb, float minSpeed, float maxSpeed )

static

Sets a random velocity with speed between the specified minimum and maximum.

Parameters

rb	The Rigidbody to modify.
minSpeed	Minimum speed.
maxSpeed	Maximum speed.

            {
                float speed = UnityEngine.Random.Range(minSpeed, maxSpeed);
                rb.linearVelocity = UnityEngine.Random.onUnitSphere * speed;
            }

SetVelocityTo()

void IuvoUnity.Extensions.RigidbodyExtensions.SetVelocityTo ( this Rigidbody rb, Vector3 targetVelocity )

static

Sets the Rigidbody's velocity to a target vector.

Parameters

rb	The Rigidbody to modify.
targetVelocity	The new velocity vector.

            {
                rb.linearVelocity = targetVelocity;
            }

SetVelocityX()

void IuvoUnity.Extensions.RigidbodyExtensions.SetVelocityX ( this Rigidbody rb, float velocity )

static

Sets the X component of the Rigidbody's velocity.

Parameters

rb	The Rigidbody to modify.
velocity	The X velocity to set.

            {
                rb.linearVelocity = new Vector3(velocity, rb.linearVelocity.y, rb.linearVelocity.z);
            }

SetVelocityY()

void IuvoUnity.Extensions.RigidbodyExtensions.SetVelocityY ( this Rigidbody rb, float velocity )

static

Sets the Y component of the Rigidbody's velocity.

Parameters

rb	The Rigidbody to modify.
velocity	The Y velocity to set.

            {
                rb.linearVelocity = new Vector3(rb.linearVelocity.x, velocity, rb.linearVelocity.z);
            }

SetVelocityZ()

void IuvoUnity.Extensions.RigidbodyExtensions.SetVelocityZ ( this Rigidbody rb, float velocity )

static

Sets the Z component of the Rigidbody's velocity.

Parameters

rb	The Rigidbody to modify.
velocity	The Z velocity to set.

            {
                rb.linearVelocity = new Vector3(rb.linearVelocity.x, rb.linearVelocity.y, velocity);
            }

StopAtPosition()

void IuvoUnity.Extensions.RigidbodyExtensions.StopAtPosition ( this Rigidbody rb, Vector3 position )

static

Stops the Rigidbody when it reaches a specified position.

Parameters

rb	The Rigidbody to stop.
position	The target position.

            {
                if (Vector3.Distance(rb.position, position) < 0.1f)
                {
                    rb.linearVelocity = Vector3.zero;
                }
            }

---

The documentation for this class was generated from the following file:

• D:/Unity/IuvoUnityCore/Assets/IuvoUnity/Runtime/Extensions/RigidbodyExtensions.cs