@equinor/videx-3d
    Preparing search index...

    Type Alias CasingProps

    CasingProps: PointerEvents & CommonComponentProps & {
        autoSlicePosition?: boolean;
        effects?: CasingEffects;
        fallback?: () => ReactElement<Object3D>;
        materialOptions?: MaterialOptions;
        opacity?: number;
        overrideSegmentsPerMeter?: number;
        overrideSimplificationThreshold?: number;
        priority?: number;
        radialSegments?: number;
        schematic?: boolean;
        shoeFactor?: number;
        sizeMultiplier?: number;
        sliceAngle?: number;
        sliceOffset?: number;
    }

    Casing props

    Type Declaration

    • OptionalautoSlicePosition?: boolean
    • Optionaleffects?: CasingEffects

      Grouped casing stylization effects (silhouette outline, section edge shading, procedural weathering, per-section variation and micro-normal surface detail). Applied as the global default for every section; a section's per-face materialOptions.*.effects override individual sub-effects on top of this. Defaults to defaultCasingEffects.

    • Optionalfallback?: () => ReactElement<Object3D>
    • OptionalmaterialOptions?: MaterialOptions

      Maps each section to its material parameters. Keep this a STABLE reference (module-level function or useCallback) - a new function identity each render rebuilds every section's materials and forces a shader recompile per frame, which is the main cause of sluggish casing updates. Defaults to a stable module-level function.

    • Optionalopacity?: number
    • OptionaloverrideSegmentsPerMeter?: number
    • OptionaloverrideSimplificationThreshold?: number
    • Optionalpriority?: number
    • OptionalradialSegments?: number
    • Optionalschematic?: boolean

      Schematic (diagram) mode: an unlit, flat-shaded look for a clean "cutaway schematic" rather than realism. Locks the slice to a half-cut that always faces the camera (sliceAngle = PI, autoSlicePosition = true, sliceOffset = 0 - those props are ignored), renders each face with only its flat color (all lighting/env, textures and realism detail are ignored) plus the silhouette outline for contrast. Dropping the specular lighting also removes the dominant source of casing aliasing; note that geometric silhouette-edge anti-aliasing still relies on the host render pipeline (MSAA/FXAA/SMAA). Default false.

    • OptionalshoeFactor?: number
    • OptionalsizeMultiplier?: number
    • OptionalsliceAngle?: number
    • OptionalsliceOffset?: number

    Settings