Class ViewportCameraNavigationSettings

The ViewportCameraNavigationSettings contain settings used for controlling ViewportCamera movement.

Hierarchy (view full)

UserProjectSettingsBase<ViewportCameraNavigationSettings>
- ViewportCameraNavigationSettings

Index

Constructors

Properties

acceleration dollyAcceleration dollySpeed fastModeMultiplier invertMouse moveSpeed orbitSpeedX orbitSpeedY panSpeed rotationalSpeed

Accessors

Methods

assign markAsDirty

Events

Constructors

constructor

new ViewportCameraNavigationSettings(): ViewportCameraNavigationSettings
Returns ViewportCameraNavigationSettings
Inherited from UserProjectSettingsBase.constructor

Properties

acceleration

acceleration: number

dollyAcceleration

dollyAcceleration: number

dollySpeed

dollySpeed: number

fastModeMultiplier

fastModeMultiplier: number

invertMouse

invertMouse: boolean

moveSpeed

moveSpeed: number

orbitSpeedX

orbitSpeedX: number

orbitSpeedY

orbitSpeedY: number

panSpeed

panSpeed: number

rotationalSpeed

rotationalSpeed: number

Accessors

isGlobal

get isGlobal(): boolean
Determines if the settings instance is the global settings that require saving to the UserProjectSettings.

Returns boolean
Overrides UserProjectSettingsBase.isGlobal

Methods

assign

assign(other): void
Copies all properties defined by the prototype of other to this instance.
Parameters
- other: Readonly<ViewportCameraNavigationSettings>
Returns void
Inherited from UserProjectSettingsBase.assign

markAsDirty

markAsDirty(): void
Marks the settings as dirty and invokes the onDirty event handler.

Returns void
Note
This method should be invoked after making a change, so subsystems such as a viewport cna be updated. If the settings are the shared editor settings, the editor settings will be marked for autosave.

Inherited from UserProjectSettingsBase.markAsDirty

Events

`Readonly`onDirty

onDirty: Event<[ViewportCameraNavigationSettings], void>

Invoked when the settings changed.

Warning

This is an internal event. Do not subscribe directly to it, use UserProjectSettings.onSettingsChanged.