Skip to content

Interface: ParcelSurfaceConfig

Defined in: src/surfaces/ParcelSurface.ts:12

Extends

  • MultiLayerSurfaceConfig

Properties

baseColor?

ts
optional baseColor?: ColorRepresentation;

Defined in: src/MultiLayerNeuroSurface.ts:21

Inherited from

ts
MultiLayerSurfaceConfig.baseColor

metalness?

ts
optional metalness?: number;

Defined in: src/MultiLayerNeuroSurface.ts:22

How metallic the surface is (0-1). 0 = dielectric (plastic), 1 = metal. Only for Standard/Physical material

Inherited from

ts
MultiLayerSurfaceConfig.metalness

roughness?

ts
optional roughness?: number;

Defined in: src/MultiLayerNeuroSurface.ts:23

How rough the surface is (0-1). 0 = smooth/shiny, 1 = rough/matte. Only for Standard/Physical material

Inherited from

ts
MultiLayerSurfaceConfig.roughness

useGPUCompositing?

ts
optional useGPUCompositing?: boolean;

Defined in: src/MultiLayerNeuroSurface.ts:24

Inherited from

ts
MultiLayerSurfaceConfig.useGPUCompositing

useWideLines?

ts
optional useWideLines?: boolean;

Defined in: src/MultiLayerNeuroSurface.ts:25

Inherited from

ts
MultiLayerSurfaceConfig.useWideLines

curvature?

ts
optional curvature?: Float32Array<ArrayBufferLike> | number[];

Defined in: src/MultiLayerNeuroSurface.ts:28

Pre-computed curvature data to display as underlay

Inherited from

ts
MultiLayerSurfaceConfig.curvature

showCurvature?

ts
optional showCurvature?: boolean;

Defined in: src/MultiLayerNeuroSurface.ts:30

Show curvature underlay (default: true if curvature provided)

Inherited from

ts
MultiLayerSurfaceConfig.showCurvature

curvatureOptions?

ts
optional curvatureOptions?: object;

Defined in: src/MultiLayerNeuroSurface.ts:32

Curvature display options

brightness?

ts
optional brightness?: number;

contrast?

ts
optional contrast?: number;

smoothness?

ts
optional smoothness?: number;

Inherited from

ts
MultiLayerSurfaceConfig.curvatureOptions

color?

ts
optional color?: ColorRepresentation;

Defined in: src/classes.ts:28

Base color of the surface when no vertex coloring is applied. Can be hex number, string, or THREE.Color

Inherited from

ts
MultiLayerSurfaceConfig.color

flatShading?

ts
optional flatShading?: boolean;

Defined in: src/classes.ts:31

If true, renders each face with a single normal (faceted look). If false, interpolates normals (smooth look)

Inherited from

ts
MultiLayerSurfaceConfig.flatShading

smoothingAngle?

ts
optional smoothingAngle?: number;

Defined in: src/classes.ts:34

Angle threshold in degrees for smooth shading (0-180). Edges with angles above this threshold will appear sharp

Inherited from

ts
MultiLayerSurfaceConfig.smoothingAngle

materialType?

ts
optional materialType?: "phong" | "standard" | "physical";

Defined in: src/classes.ts:37

Material type: 'phong' (default) or 'standard' (PBR). Standard enables metalness/roughness

Inherited from

ts
MultiLayerSurfaceConfig.materialType

shininess?

ts
optional shininess?: number;

Defined in: src/classes.ts:41

Controls size of specular highlights (0-200). 0 = matte/dull, 200 = very shiny/metallic. Only for Phong material

Inherited from

ts
MultiLayerSurfaceConfig.shininess

specularColor?

ts
optional specularColor?: number;

Defined in: src/classes.ts:44

Color of specular reflections. Usually grayscale for realistic materials. Hex number format. Only for Phong material

Inherited from

ts
MultiLayerSurfaceConfig.specularColor

emissive?

ts
optional emissive?: ColorRepresentation;

Defined in: src/classes.ts:55

Self-illumination color. Makes the surface glow independently of scene lights

Inherited from

ts
MultiLayerSurfaceConfig.emissive

emissiveIntensity?

ts
optional emissiveIntensity?: number;

Defined in: src/classes.ts:58

Multiplier for emissive color strength (0-1). 0 = no glow, 1 = full glow

Inherited from

ts
MultiLayerSurfaceConfig.emissiveIntensity

alpha?

ts
optional alpha?: number;

Defined in: src/classes.ts:61

Opacity/transparency (0-1). 0 = fully transparent, 1 = fully opaque

Inherited from

ts
MultiLayerSurfaceConfig.alpha

thresh?

ts
optional thresh?: [number, number];

Defined in: src/classes.ts:64

Threshold range [min, max] for hiding values. Values within range are made transparent

Inherited from

ts
MultiLayerSurfaceConfig.thresh

irange?

ts
optional irange?: [number, number];

Defined in: src/classes.ts:67

Input data range [min, max] for color mapping normalization

Inherited from

ts
MultiLayerSurfaceConfig.irange

parcelData

ts
parcelData: ParcelData;

Defined in: src/surfaces/ParcelSurface.ts:13


vertexLabels

ts
vertexLabels: 
  | Uint32Array<ArrayBufferLike>
  | Int32Array<ArrayBufferLike>
  | number[];

Defined in: src/surfaces/ParcelSurface.ts:14

Released under the MIT License.