realvirtual.KeyboardMove Class Reference

Enables keyboard-controlled movement of GameObjects with smooth interpolation and axis limits. More...

Inheritance diagram for realvirtual.KeyboardMove:

Public Member Functions
void	ResetToInitialPosition ()
	Resets the GameObject to its initial position.

Public Attributes
float	Speed
	Movement speed in meters per second.
float	LerpFactor
	Lerp smoothing factor - higher values provide more responsive movement.
KeyCode	XNegativeKey1
	Primary key for negative X axis movement.
KeyCode	XNegativeKey2
	Secondary key for negative X axis movement (optional)
KeyCode	XPositiveKey1
	Primary key for positive X axis movement.
KeyCode	XPositiveKey2
	Secondary key for positive X axis movement (optional)
KeyCode	YNegativeKey1
	Primary key for negative Y axis movement.
KeyCode	YNegativeKey2
	Secondary key for negative Y axis movement (optional)
KeyCode	YPositiveKey1
	Primary key for positive Y axis movement.
KeyCode	YPositiveKey2
	Secondary key for positive Y axis movement (optional)
KeyCode	ZNegativeKey1
	Primary key for negative Z axis movement.
KeyCode	ZNegativeKey2
	Secondary key for negative Z axis movement (optional)
KeyCode	ZPositiveKey1
	Primary key for positive Z axis movement.
KeyCode	ZPositiveKey2
	Secondary key for positive Z axis movement (optional)
KeyCode	ResetKey
	Key to reset GameObject to initial position.
Vector2	XAxisLimits
	Minimum and maximum X axis position limits in meters.
Vector2	YAxisLimits
	Minimum and maximum Y axis position limits in meters.
Vector2	ZAxisLimits
	Minimum and maximum Z axis position limits in meters.

Detailed Description

Enables keyboard-controlled movement of GameObjects with smooth interpolation and axis limits.

KeyboardMove provides precise manual control over GameObject positioning using configurable keyboard inputs. It supports smooth lerped movement, customizable speed settings, and position limits for each axis. This component is ideal for manual positioning tasks, debugging object placement, and creating interactive control systems for automation simulations.

Key Features:

• Independent control of X, Y, and Z axes with dual-key support
• Smooth lerped movement with adjustable smoothing factor
• Position limits for constraining movement within defined boundaries
• Local space movement respecting object rotation
• Visual gizmos showing movement boundaries in Scene view

Common Applications:

• Manual positioning of robots or machinery during setup
• Debug tool for testing object placement
• Interactive control for demonstration scenarios
• Fine-tuning object positions in virtual commissioning

Integration Points:

• Can be combined with Drive components for hybrid control
• Works alongside physics-based movement systems
• Supports runtime enabling/disabling for mode switching

For detailed documentation see: https://doc.realvirtual.io/components-and-scripts/scene-interaction/keyboard-move

Member Function Documentation

ResetToInitialPosition()

void realvirtual.KeyboardMove.ResetToInitialPosition

(

)

Resets the GameObject to its initial position.

Member Data Documentation

LerpFactor

float realvirtual.KeyboardMove.LerpFactor

Lerp smoothing factor - higher values provide more responsive movement.

ResetKey

KeyCode realvirtual.KeyboardMove.ResetKey

Key to reset GameObject to initial position.

Speed

float realvirtual.KeyboardMove.Speed

Movement speed in meters per second.

XAxisLimits

Vector2 realvirtual.KeyboardMove.XAxisLimits

Minimum and maximum X axis position limits in meters.

XNegativeKey1

KeyCode realvirtual.KeyboardMove.XNegativeKey1

Primary key for negative X axis movement.

XNegativeKey2

KeyCode realvirtual.KeyboardMove.XNegativeKey2

Secondary key for negative X axis movement (optional)

XPositiveKey1

KeyCode realvirtual.KeyboardMove.XPositiveKey1

Primary key for positive X axis movement.

XPositiveKey2

KeyCode realvirtual.KeyboardMove.XPositiveKey2

Secondary key for positive X axis movement (optional)

YAxisLimits

Vector2 realvirtual.KeyboardMove.YAxisLimits

Minimum and maximum Y axis position limits in meters.

YNegativeKey1

KeyCode realvirtual.KeyboardMove.YNegativeKey1

Primary key for negative Y axis movement.

YNegativeKey2

KeyCode realvirtual.KeyboardMove.YNegativeKey2

Secondary key for negative Y axis movement (optional)

YPositiveKey1

KeyCode realvirtual.KeyboardMove.YPositiveKey1

Primary key for positive Y axis movement.

YPositiveKey2

KeyCode realvirtual.KeyboardMove.YPositiveKey2

Secondary key for positive Y axis movement (optional)

ZAxisLimits

Vector2 realvirtual.KeyboardMove.ZAxisLimits

Minimum and maximum Z axis position limits in meters.

ZNegativeKey1

KeyCode realvirtual.KeyboardMove.ZNegativeKey1

Primary key for negative Z axis movement.

ZNegativeKey2

KeyCode realvirtual.KeyboardMove.ZNegativeKey2

Secondary key for negative Z axis movement (optional)

ZPositiveKey1

KeyCode realvirtual.KeyboardMove.ZPositiveKey1

Primary key for positive Z axis movement.

ZPositiveKey2

KeyCode realvirtual.KeyboardMove.ZPositiveKey2

Secondary key for positive Z axis movement (optional)