import { Vec3 } from '@hiberworld/code-kit';
import { IDefaultOptions } from './types';
export interface IObjectsAlongPathOptions extends IDefaultOptions {
    showPoints: Boolean;
    points: Vec3[];
    close: Boolean;
    numberOfItems: number;
    onEach?: Function;
}
export interface IObjectsAlongPathOptionsForEach {
    progress: number;
    index: number;
    p: Vec3;
    r: Vec3;
}
/**
 * Function to place objects along a path.
 * @example
 * ```ts
  addTo(
    root,
    getObjectsAlongPath({
      numberOfItems: 8,
      showPoints: false,
      points: [
        [-3, 6, 2],
        [-10, 8, 3],
        [-15, 12, 14],
        [-27, 20, 10],
      ],
      onEach: (props: any) => {
        const item = getPrefab({
          p: props.p,
          id: 'rounded_cube_01',
          s: [1.5, 0.75, 1.5],
          r: [0, props.r[1], 0],
        });
        return item; // <-- Important to return what's been added.
      },
    })
  );
 * ```
 */
export declare const getObjectsAlongPath: (options?: Partial<IObjectsAlongPathOptions>) => import("@hiberworld/code-kit").HNode;
//# sourceMappingURL=getObjectsAlongPath.d.ts.map