Interface: walkThroughOps

The WalkThroughOps Core Interface provides access to the Walkthrough viewport navigation mode.

Interface: walkThroughOps

Properties:

walkThroughOps.isEnabled : bool : Read

Returns true if walkthrough mode is enabled, false otherwise.

walkThroughOps.isActive : bool : Read

Returns true if the walkthrough mode is active, false otherwise.

walkThroughOps.stepSize : float : Read|Write

Get/Set the step size value which controls the linear speed.

walkThroughOps.sensitivity : float : Read|Write

Get/Set the sensitivity value which controls the angular speed the higher the value, the faster the Pitch and Yaw.

walkThroughOps.invertVertical : bool : Read|Write

When set to true, the vertical axis will be inverted - moving the mouse up will Pitch the camera up, moving the mouse down will Pitch down.

When set to false(default), moving the mouse pointer up will rotate the camera to look down and vice-versa.

walkThroughOps.lockVertical : bool : Read|Write

When set to true, no Pitch will be allowed.

When set to false (default), looking up and down will be possible.

walkThroughOps.lockHorizontal : bool : Read|Write

When set to true, no Yaw will be allowed.

When set to false (default), looking left and right will be possible.

walkThroughOps.accelerate : bool : Read|Write

When set to true, the linear speed will be adjusted relatively to the size of the scene.

When false(default), the absolute step size will be used.

Methods:

<void>walkThroughOps.start()

Enables the walkthrough mode.

<void>walkThroughOps.stop()

Disables the walkthrough mode.

<void>walkThroughOps.level()

Aligns the view vector to be parallel to the XY world plane.

<void>walkThroughOps.resetStepSize()

Resets the Step Size to the default value.