Skip to main content

@novorender/api / RenderStateGrid

Interface: RenderStateGrid

Defined in: @novorender/src/core3d/state/index.ts:317

Grid related render state.

Properties​

axisX​

readonly axisX: ReadonlyVec3;

Defined in: @novorender/src/core3d/state/index.ts:331

The grid's x-axis in world space.

axisY​

readonly axisY: ReadonlyVec3;

Defined in: @novorender/src/core3d/state/index.ts:334

The grid's y-axis in world space.

color1​

readonly color1: RGB;

Defined in: @novorender/src/core3d/state/index.ts:322

Color of minor grid lines.

color2​

readonly color2: RGB;

Defined in: @novorender/src/core3d/state/index.ts:325

Color of major grid lines.

distance​

readonly distance: number;

Defined in: @novorender/src/core3d/state/index.ts:347

Max distance to render grid in meters.

enabled​

readonly enabled: boolean;

Defined in: @novorender/src/core3d/state/index.ts:319

Turn grid on and off.

origin​

readonly origin: ReadonlyVec3;

Defined in: @novorender/src/core3d/state/index.ts:328

The grid's origin/center coordinate in world space.

size1​

readonly size1: number;

Defined in: @novorender/src/core3d/state/index.ts:339

Minor grid cell size

Default Value​

1

size2​

readonly size2: number;

Defined in: @novorender/src/core3d/state/index.ts:344

Major grid cell size

Default Value​

10