Function Symbols

A generic component used for simplifying mesh instancing. Use this component if you need a large number of meshes sharing the same base geometry and material, but that may be transformed or colored individually.

Typical use case is for visualizations of data along a wellbore, such as in the Shoes and FormationMarkers component.

Remarks

Data, including colors, transformations and user defined data, must be mapped to the SymbolsType type.

Example

<Symbols
   position={position}
   data={data}
   geometry={geometry}
   material={material}
   layers={layers}
 />

See

  • Symbols(
        props: {
            customDepthMaterial?: Material;
            customDistanceMaterial?: Material;
            data: SymbolsType;
            geometry: BufferGeometry;
            material: Material | Material[];
        } & PointerEvents & CommonComponentProps & RefAttributes<
            InstancedMesh<
                BufferGeometry<NormalBufferAttributes>,
                Material | Material[],
                InstancedMeshEventMap,
            >,
        >,
    ): ReactNode

    Parameters

    • props: {
          customDepthMaterial?: Material;
          customDistanceMaterial?: Material;
          data: SymbolsType;
          geometry: BufferGeometry;
          material: Material | Material[];
      } & PointerEvents & CommonComponentProps & RefAttributes<
          InstancedMesh<
              BufferGeometry<NormalBufferAttributes>,
              Material | Material[],
              InstancedMeshEventMap,
          >,
      >

    Returns ReactNode

Settings