realvirtual.SceneMouseNavigation Class Reference

Controls the Mouse and Touch navigation in Game mode. More...

Inheritance diagram for realvirtual.SceneMouseNavigation:

Public Member Functions
delegate void	StartStopCameraInterpolation (bool start)
	delegate for starting and stopping camera interpolation
delegate void	StartStopPanning (bool start)
	delegate for starting and stopping panning
delegate void	StartStopRotation (bool start)
	Delegates for Events delegate for starting and stopping rotation.
void	OnButtonOrthoOverlay (GenericButton button)
	is called when orthographic overlay views button is pressed in the main menu bar
void	OrthoOverlayToggleOn ()
void	OrthoOverlayToggleOff ()
void	OnButtonOrthographicView (GenericButton button)
	is called when orthographic view is enabled or disabled
void	OrthographicViewToggleOn ()
	is called when orthographic view is enabled or disabled
void	OrthographicViewToggleOff ()
void	SetOrthographicView (bool active)
void	BlockRotation (bool block, bool onlyleftmouse)
	Blocks the rotation of the camera e.g. when an element is selected with left mouse and left mouse rotation is on.
void	OnViewButton (GenericButton button)
	called by main menu view button to switch between first person controller and normal mouse navigation
void	ViewButtonToggleOn ()
void	ViewButtonToggleOff ()
void	SetNewCameraPosition (Vector3 targetpos, float camdistance, Vector3 camrotation, bool nointerpolate=false)
	sets a new camera position based ob targetos, distance to targetois and rotation
void	SetViewDirection (Vector3 camrotation)
	sets the camera view direction based on a vector
void	FocusOnObjects (List< GameObject > objectsToFocus, float paddingFactor=1.2f)
	Performs a one-time camera movement to focus on multiple GameObjects.
void	FocusOnObject (GameObject objectToFocus, float? distance=null, Vector3? viewAngle=null)
	Performs a one-time camera movement to focus on the specified GameObject.
void	StartFollowing (GameObject objectToFollow, float? distance=null, Vector3? viewAngle=null, bool allowRotation=false, bool allowZoom=false, float lerpSpeed=1.0f, bool smoothStart=true, bool stopOnMouseClick=false)
	Starts continuous camera following of the specified GameObject.
void	StartRidingTransform (GameObject objectToRide, float lerpSpeed=5.0f, bool smoothStart=true, bool stopOnMouseClick=false)
	Starts "riding" an object's transform - camera position AND rotation match the followed object.
void	StartFollowingObjects (List< GameObject > objectsToFollow, float paddingFactor=1.2f, bool allowRotation=false, bool allowZoom=false, float lerpSpeed=1.0f, bool smoothStart=true, bool stopOnMouseClick=false)
	Starts continuous camera following of multiple GameObjects.
void	StopFollowing ()
	Stops continuous camera following of the currently tracked object.
void	ActivateCinemachine (bool activate)
void	Init ()
Public Member Functions inherited from realvirtual.realvirtualBehavior
virtual void	OnOwnershipChanged (bool isOwner)
	Called when network ownership changes.
void	SetNetworkOwner (bool isOwner)
	Sets IsNetworkOwner and triggers OnOwnershipChanged callback.
void	PreStartSim ()
	Is called by the realvirtualController before the component is started.
void	StartSim ()
	Is called by the realvirtualController to start or stop the component.
void	StopSim ()
Vector3	DirectionToVector (DIRECTION direction)
	Transfers the direction enumeration to a vector.
DIRECTION	VectorToDirection (bool torotatoin, Vector3 vector)
	Transfers a vector to the direction enumeration.
float	GetLocalScale (Transform thetransform, DIRECTION direction)
List< BehaviorInterfaceConnection >	UpdateConnectionInfo ()
List< Signal >	GetConnectedSignals ()
void	SetVisibility (bool visibility)
	Sets the visibility of this object including all subobjects.
List< BehaviorInterfaceConnection >	GetConnections ()
List< Signal >	GetSignals ()
GameObject	GetChildByName (string name)
	Gets a child by name.
List< GameObject >	GetChildsByName (string name)
	Gets all child by name.
GameObject	GetChildByNameAlsoHidden (string name)
List< GameObject >	GetAllMeshesWithGroup (string group)
List< GameObject >	GetAllWithGroup (string group)
List< GameObject >	GetAllWithGroups (List< string > groups)
List< GameObject >	GetAllMeshesWithGroups (List< string > groups)
List< string >	GetMyGroups ()
List< GameObject >	GetMeshesWithSameGroups ()
List< GameObject >	GetAllWithSameGroups ()
MeshRenderer	GetMeshRenderer ()
	Gets the mesh renderers in the childrens.
void	SetCollider (bool enabled, bool includeTriggers=true)
	sets the collider in all child objects
void	ErrorMessage (string message)
	Displays an error message.
void	ChangeConnectionMode (bool isconnected)
void	Log (string message)
	Logs a message.
void	Log (string message, object obj)
	Logs a message with a relation to an object.
void	Warning (string message, object obj)
	Logs a warning with a relation to an object.
void	Error (string message, object obj)
	Logs an error with a relation to an object.
void	Error (string message)
	Logs an error.
GameObject	DebugPosition (string debugname, Vector3 position, Quaternion quaternation, float scale)
	Displays a gizmo for debugging positions.
void	SetFreezePosition (bool enabled)
	Freezes all child components to the current poosition.
void	SetRbConstraints (RigidbodyConstraints constraints)
virtual void	AwakeAlsoDeactivated ()

Public Attributes
bool	UseOrbitCameraMode
	Toggle the orbit camera mode.
bool	FirstPersonControllerActive
	Toggle the first person controller.
bool	RotateWithLeftMouseButton
	Rotate the camera with the left mouse button.
bool	RotateToFocusObject
	Rotates the camera to focused objects instead of panning the camera.
bool	BlockRotationOnSelected
FirstPersonController	FirstPersonController
	Reference to the first person controller script.
CameraPos	LastCameraPosition
	The last camera position before switching modes.
bool	SetCameraPosOnStartPlay
	Set the camera position on start play.
bool	SaveCameraPosOnQuit
	Save the camera position on quitting the application.
bool	SetEditorCameraPos
	Set the editor camera position.
bool	InterpolateToNewCamerapoitions
	Interpolate to new saved Camerapositions.
float	CameraInterpolationSpeed
	Interpolation speed to new saved Camerapositions.
Transform	target
	The target of the camera.
Vector3	targetOffset
	Offset of the camera's target.
float	distance
	The distance of the camera from its target.
float	DPIScale
	The DPI scale of the screen, is automatically calculated and is used to scale all screen pixel related distances measurements.
float	minDistance
	The minimum distance of the camera from its target.
float	MouseRotationSpeed
	The speed of rotation around the y-axis.
float	MasterSensitivity
	Master sensitivity multiplier affecting all navigation speeds.
float	MinHorizontalRotation
	The minimum angle limit for the camera rotation around the x-axis.
float	MaxHorizontalRotation
	The maximum angle limit for the camera rotation around the x-axis.
float	ZoomSpeed
	The speed of zooming in and out, 1 is standard.
float	RotDamping
	The speed at which the zooming slows down, 1 is standard.
float	PanDamping
	The speed at which the panning slows down, 1 is standard.
float	CursorSpeed
	The speed at which the panning slows down, 1 is standard.
float	ZoomDamping
	The speed at which the zooming slows down, 1 is standard.
float	orthoPanSpeed
	The speed of panning the camera in orthographic mode.
float	StartDemoOnInactivity
	The time to wait before starting the demo due to inactivity.
float	DurationNoMouseActivity
	The time without any mouse activity before considering the camera inactive.
GameObject	DebugObj
TouchInteraction	Touch
	The touch interaction script.
float	TouchPanSpeed
	The speed of rotating with touch.
float	TouchRotationSpeed
	The speed of rotating with touch.
float	TouchZoomSpeed
	The speed of zooming with touch.
bool	TouchInvertVertical
bool	TouchInvertHorizontal
	Touch invert vertical.
bool	EnableSpaceNavigator
	Touch invert horizontal.
float	SpaceNavTransSpeed
	Enable space navigator.
float	currentDistance
	Space navigator translation speed.
float	desiredDistance
	Current distance.
Quaternion	currentRotation
	Desired distance.
Quaternion	desiredRotation
	Current rotation.
bool	isRotating
	Desired rotation.
bool	isPanning
bool	interpolatingToNewCameraPos
bool	CinemachineIsActive
bool	blockrotation
bool	blockleftmouserotation
bool	orthograhicview
OrthoViewController	orthoviewcontroller
StartStopCameraInterpolation	EventStartStopCameraInterpolation
StartStopPanning	EventStartStopPanning
StartStopRotation	EventStartStopRotation
float	FollowBoundsSmoothTime
Public Attributes inherited from realvirtual.realvirtualBehavior
string	Name
	The name of the component if it should be different from the GameObject name.
ActiveOnly	Active
GameObject	FromTemplate
realvirtualController	realvirtualController
bool	HideNonG44Components
bool	SceneIsAdditive
bool	ForceStop
bool	IsNetworkOwner
	True when this component owns its simulation (local authority). Set to false by MultiplayerWEB on remote clients.

Properties
bool	IsRiding [get]
	Returns true if the camera is currently "riding" an object's transform (matching position and rotation).
bool	IsFollowing [get]
	Returns true if the camera is currently in follow mode, tracking an object.
GameObject	FollowedObject [get]
	Returns the GameObject currently being followed, or null if not in follow mode.

Additional Inherited Members
Public Types inherited from realvirtual.realvirtualBehavior
enum	ActiveOnly {   Always , Connected , Disconnected , Never ,   DontChange }
Static Public Member Functions inherited from realvirtual.realvirtualBehavior
static bool	DirectionIsLinear (DIRECTION direction)
	Gets back if the direction is linear or a rotation.
Protected Member Functions inherited from realvirtual.realvirtualBehavior
bool	hidename ()
bool	hideactiveonly ()
virtual void	OnStopSim ()
virtual void	OnPreStartSim ()
virtual void	OnStartSim ()
MU	GetTopOfMu (GameObject obj)
	Gets the top of an MU component (the first MU script going up in the hierarchy)
void	InitGame4Automation ()
	Initialiates the components and gets the reference to the realvirtualController in the scene.
virtual void	AfterAwake ()
void	Awake ()

Detailed Description

Controls the Mouse and Touch navigation in Game mode.

Member Function Documentation

BlockRotation()

void realvirtual.SceneMouseNavigation.BlockRotation	(	bool	block,
		bool	onlyleftmouse
	)

Blocks the rotation of the camera e.g. when an element is selected with left mouse and left mouse rotation is on.

FocusOnObject()

void realvirtual.SceneMouseNavigation.FocusOnObject	(	GameObject	objectToFocus,
		float?	distance = null,
		Vector3?	viewAngle = null
	)

Performs a one-time camera movement to focus on the specified GameObject.

The camera will smoothly move to view the object but will not continuously track it if it moves. Uses the object's pivot point for positioning, bounds only for distance calculation.

Example usage:

• FocusOnObject(robot) - Auto-calculates distance to fit object at 1/3 screen space
• FocusOnObject(conveyor, distance: 5.0f) - Focus with specific distance
• FocusOnObject(sensor, distance: 2.5f, viewAngle: new Vector3(45, 90, 0)) - With specific angle

FocusOnObjects()

void realvirtual.SceneMouseNavigation.FocusOnObjects	(	List< GameObject >	objectsToFocus,
		float	paddingFactor = 1::2f
	)

Performs a one-time camera movement to focus on multiple GameObjects.

The camera will smoothly move to view all objects in the list but will not continuously track them. Calculates combined bounds of all objects and positions camera to fit all objects in view.

Parameters:

• objectsToFocus: List of GameObjects to focus on (required, must not be empty)
• paddingFactor: Multiplier for extra padding around combined bounds (default 1.2 = 20% padding)

Example usage:

• FocusOnObjects(selectedParts) - Focus on list of parts with default padding
• FocusOnObjects(conveyors, 1.5f) - Focus with 50% extra padding for more breathing room

OnButtonOrthographicView()

void realvirtual.SceneMouseNavigation.OnButtonOrthographicView

(

GenericButton

button

)

is called when orthographic view is enabled or disabled

OnButtonOrthoOverlay()

void realvirtual.SceneMouseNavigation.OnButtonOrthoOverlay

(

GenericButton

button

)

is called when orthographic overlay views button is pressed in the main menu bar

OnViewButton()

void realvirtual.SceneMouseNavigation.OnViewButton

(

GenericButton

button

)

called by main menu view button to switch between first person controller and normal mouse navigation

OrthographicViewToggleOn()

void realvirtual.SceneMouseNavigation.OrthographicViewToggleOn

(

)

is called when orthographic view is enabled or disabled

SetNewCameraPosition()

void realvirtual.SceneMouseNavigation.SetNewCameraPosition	(	Vector3	targetpos,
		float	camdistance,
		Vector3	camrotation,
		bool	nointerpolate = false
	)

sets a new camera position based ob targetos, distance to targetois and rotation

SetOrthographicView()

void realvirtual.SceneMouseNavigation.SetOrthographicView

(

bool

active

)

no changes

SetViewDirection()

void realvirtual.SceneMouseNavigation.SetViewDirection

(

Vector3

camrotation

)

sets the camera view direction based on a vector

StartFollowing()

void realvirtual.SceneMouseNavigation.StartFollowing	(	GameObject	objectToFollow,
		float?	distance = null,
		Vector3?	viewAngle = null,
		bool	allowRotation = false,
		bool	allowZoom = false,
		float	lerpSpeed = 1::0f,
		bool	smoothStart = true,
		bool	stopOnMouseClick = false
	)

Starts continuous camera following of the specified GameObject.

The object will remain centered in the camera view and the camera will track its movement. Following can only be stopped by calling StopFollowing() - user input cannot interrupt it.

Parameters:

• objectToFollow: The GameObject to continuously track (required)
• distance: Camera distance from object in meters. If null, auto-calculates to fit object at 1/3 screen space
• viewAngle: Initial camera rotation in degrees. If null, maintains current camera angle
• allowRotation: If true, user can orbit camera around the object while keeping it centered
• allowZoom: If true, user can zoom in/out from the object while keeping it centered
• lerpSpeed: Controls camera tracking smoothness (0.1 = very smooth, 1.0 = tight tracking, 10.0 = near instant)
• smoothStart: If true, camera smoothly lerps to target when starting. If false, jumps immediately
• stopOnMouseClick: If true, following stops when any mouse button is clicked

Example usage:

• StartFollowing(agvRobot) - Fully locked cinematic follow with default lerp
• StartFollowing(robot, allowRotation: true) - Follow with user rotation control
• StartFollowing(conveyor, lerpSpeed: 0.3f) - Smooth cinematic following
• StartFollowing(fastMover, lerpSpeed: 5.0f) - Very tight tracking for fast objects
• StartFollowing(sensor, distance: 2.5f, viewAngle: new Vector3(45, 90, 0), lerpSpeed: 2.0f) - Custom everything
• StartFollowing(target, smoothStart: false) - Jump immediately to target without initial lerp
• StartFollowing(target, stopOnMouseClick: true) - Stop following when user clicks

StartFollowingObjects()

void realvirtual.SceneMouseNavigation.StartFollowingObjects	(	List< GameObject >	objectsToFollow,
		float	paddingFactor = 1::2f,
		bool	allowRotation = false,
		bool	allowZoom = false,
		float	lerpSpeed = 1::0f,
		bool	smoothStart = true,
		bool	stopOnMouseClick = false
	)

Starts continuous camera following of multiple GameObjects.

The camera tracks the combined bounds center and keeps all objects in view.

Parameters:

• objectsToFollow: List of GameObjects to track (required, must not be empty)
• paddingFactor: Extra padding around combined bounds (default 1.2 = 20% padding)
• allowRotation: If true, user can orbit camera around the group while keeping it centered
• allowZoom: If true, user can zoom in/out while keeping the group centered
• lerpSpeed: Controls camera tracking smoothness (0.1 = very smooth, 1.0 = tight tracking, 10.0 = near instant)
• smoothStart: If true, camera smoothly lerps to target when starting. If false, jumps immediately
• stopOnMouseClick: If true, following stops when any mouse button is clicked

StartRidingTransform()

void realvirtual.SceneMouseNavigation.StartRidingTransform	(	GameObject	objectToRide,
		float	lerpSpeed = 5::0f,
		bool	smoothStart = true,
		bool	stopOnMouseClick = false
	)

Starts "riding" an object's transform - camera position AND rotation match the followed object.

Unlike StartFollowing which orbits around an object, this mode makes the camera move and rotate exactly as the followed object does. Useful for camera fly-throughs and animated sequences.

Parameters:

• objectToRide: The GameObject whose transform the camera will match
• lerpSpeed: How quickly camera follows (0.1=smooth cinematic, 5.0=tight tracking, 10.0=near instant)
• smoothStart: If true, smoothly transitions to object; if false, jumps immediately
• stopOnMouseClick: If true, stops riding when any mouse button is clicked

StartStopCameraInterpolation()

delegate void realvirtual.SceneMouseNavigation.StartStopCameraInterpolation

(

bool

start

)

delegate for starting and stopping camera interpolation

StartStopPanning()

delegate void realvirtual.SceneMouseNavigation.StartStopPanning

(

bool

start

)

delegate for starting and stopping panning

StartStopRotation()

delegate void realvirtual.SceneMouseNavigation.StartStopRotation

(

bool

start

)

Delegates for Events delegate for starting and stopping rotation.

StopFollowing()

void realvirtual.SceneMouseNavigation.StopFollowing

(

)

Stops continuous camera following of the currently tracked object.

After calling this, the camera will return to normal user-controlled navigation.

Member Data Documentation

CameraInterpolationSpeed

float realvirtual.SceneMouseNavigation.CameraInterpolationSpeed

Interpolation speed to new saved Camerapositions.

currentDistance

float realvirtual.SceneMouseNavigation.currentDistance

Space navigator translation speed.

currentRotation

Quaternion realvirtual.SceneMouseNavigation.currentRotation

Desired distance.

CursorSpeed

float realvirtual.SceneMouseNavigation.CursorSpeed

The speed at which the panning slows down, 1 is standard.

desiredDistance

float realvirtual.SceneMouseNavigation.desiredDistance

Current distance.

desiredRotation

Quaternion realvirtual.SceneMouseNavigation.desiredRotation

Current rotation.

distance

float realvirtual.SceneMouseNavigation.distance

The distance of the camera from its target.

DPIScale

float realvirtual.SceneMouseNavigation.DPIScale

The DPI scale of the screen, is automatically calculated and is used to scale all screen pixel related distances measurements.

DurationNoMouseActivity

float realvirtual.SceneMouseNavigation.DurationNoMouseActivity

The time without any mouse activity before considering the camera inactive.

EnableSpaceNavigator

bool realvirtual.SceneMouseNavigation.EnableSpaceNavigator

Touch invert horizontal.

FirstPersonController

FirstPersonController realvirtual.SceneMouseNavigation.FirstPersonController

Reference to the first person controller script.

FirstPersonControllerActive

bool realvirtual.SceneMouseNavigation.FirstPersonControllerActive

Toggle the first person controller.

InterpolateToNewCamerapoitions

bool realvirtual.SceneMouseNavigation.InterpolateToNewCamerapoitions

Interpolate to new saved Camerapositions.

isRotating

bool realvirtual.SceneMouseNavigation.isRotating

Desired rotation.

LastCameraPosition

CameraPos realvirtual.SceneMouseNavigation.LastCameraPosition

The last camera position before switching modes.

MasterSensitivity

float realvirtual.SceneMouseNavigation.MasterSensitivity

Master sensitivity multiplier affecting all navigation speeds.

MaxHorizontalRotation

float realvirtual.SceneMouseNavigation.MaxHorizontalRotation

The maximum angle limit for the camera rotation around the x-axis.

minDistance

float realvirtual.SceneMouseNavigation.minDistance

The minimum distance of the camera from its target.

MinHorizontalRotation

float realvirtual.SceneMouseNavigation.MinHorizontalRotation

The minimum angle limit for the camera rotation around the x-axis.

MouseRotationSpeed

float realvirtual.SceneMouseNavigation.MouseRotationSpeed

The speed of rotation around the y-axis.

orthoPanSpeed

float realvirtual.SceneMouseNavigation.orthoPanSpeed

The speed of panning the camera in orthographic mode.

PanDamping

float realvirtual.SceneMouseNavigation.PanDamping

The speed at which the panning slows down, 1 is standard.

RotateToFocusObject

bool realvirtual.SceneMouseNavigation.RotateToFocusObject

Rotates the camera to focused objects instead of panning the camera.

RotateWithLeftMouseButton

bool realvirtual.SceneMouseNavigation.RotateWithLeftMouseButton

Rotate the camera with the left mouse button.

RotDamping

float realvirtual.SceneMouseNavigation.RotDamping

The speed at which the zooming slows down, 1 is standard.

SaveCameraPosOnQuit

bool realvirtual.SceneMouseNavigation.SaveCameraPosOnQuit

Save the camera position on quitting the application.

SetCameraPosOnStartPlay

bool realvirtual.SceneMouseNavigation.SetCameraPosOnStartPlay

Set the camera position on start play.

SetEditorCameraPos

bool realvirtual.SceneMouseNavigation.SetEditorCameraPos

Set the editor camera position.

SpaceNavTransSpeed

float realvirtual.SceneMouseNavigation.SpaceNavTransSpeed

Enable space navigator.

StartDemoOnInactivity

float realvirtual.SceneMouseNavigation.StartDemoOnInactivity

The time to wait before starting the demo due to inactivity.

target

Transform realvirtual.SceneMouseNavigation.target

The target of the camera.

targetOffset

Vector3 realvirtual.SceneMouseNavigation.targetOffset

Offset of the camera's target.

Touch

TouchInteraction realvirtual.SceneMouseNavigation.Touch

The touch interaction script.

TouchInvertHorizontal

bool realvirtual.SceneMouseNavigation.TouchInvertHorizontal

Touch invert vertical.

TouchPanSpeed

float realvirtual.SceneMouseNavigation.TouchPanSpeed

The speed of rotating with touch.

TouchRotationSpeed

float realvirtual.SceneMouseNavigation.TouchRotationSpeed

The speed of rotating with touch.

TouchZoomSpeed

float realvirtual.SceneMouseNavigation.TouchZoomSpeed

The speed of zooming with touch.

UseOrbitCameraMode

bool realvirtual.SceneMouseNavigation.UseOrbitCameraMode

Toggle the orbit camera mode.

ZoomDamping

float realvirtual.SceneMouseNavigation.ZoomDamping

The speed at which the zooming slows down, 1 is standard.

ZoomSpeed

float realvirtual.SceneMouseNavigation.ZoomSpeed

The speed of zooming in and out, 1 is standard.

Property Documentation

FollowedObject

GameObject realvirtual.SceneMouseNavigation.FollowedObject

get

Returns the GameObject currently being followed, or null if not in follow mode.

IsFollowing

bool realvirtual.SceneMouseNavigation.IsFollowing

get

Returns true if the camera is currently in follow mode, tracking an object.

IsRiding

bool realvirtual.SceneMouseNavigation.IsRiding

get

Returns true if the camera is currently "riding" an object's transform (matching position and rotation).