Last updated

API / geotoolkit3d / scene / grid / Grid / Mode

Class: Mode

grid.Grid.Mode

Enum of Plane display strategy.

The functions provided by this enum are used to define which plane of the grid should be visible.
The grid always has 6 planes (one for each face), those strategies determine if some plane should be hidden to let the user see through it.

Table of contents

Constructors
Methods

Contents

Constructors

new Mode()

new Mode()

Methods

back

Static back(gridPlane, scene, camera): boolean

Show only the grid planes that are facing the camera (IE: only and at most 3 planes visible at all times)

Parameters

Name Type
gridPlaneObject3D<Object3DEventMap>
sceneScene
cameraPerspectiveCamera | OrthographicCamera

Returns

boolean


box

Static box(): boolean

Always show all grid planes

Returns

boolean


openbox

Static openbox(gridPlane, scene, camera): boolean

Show grid planes that do not overlap any other grid planes.

Parameters

Name Type
gridPlaneObject3D<Object3DEventMap>
sceneScene
cameraPerspectiveCamera | OrthographicCamera

Returns

boolean