Variable MeshHelperConst

Type declaration

• createAxis: ((desc?: AxisDescriptor) => IMeshEntity)

  • • (desc?): IMeshEntity

    • Creates an axis mesh entity for coordinate system visualization. Typically displays X, Y, and Z axes with different colors.

      Parameters

      • desc: AxisDescriptor = {}

        Configuration object for the axis geometry

      Returns IMeshEntity

      A mesh entity representing the coordinate axes

      Example

      const worldAxis = createAxis({
        length: 5.0,
        thickness: 0.1
      });
      Copy

• createCube: ((desc?: CubeDescriptor) => IMeshEntity)

  • • (desc?): IMeshEntity

    • Creates a cube mesh entity with optional physics simulation.

      Parameters

      • desc: CubeDescriptor = {}

        Configuration object for the cube geometry and physics properties

      Returns IMeshEntity

      A mesh entity representing the cube, with physics component if specified

      Example

      // Create a simple cube
      const cube = createCube({ widthVector: Vector3.fromCopy3(2, 2, 2) });
      
      // Create a cube with physics
      const physicsCube = createCube({
        widthVector: Vector3.fromCopy3(1, 1, 1),
        physics: {
          use: true,
          move: true,
          density: 1.0,
          friction: 0.5,
          restitution: 0.3
        }
      });
      Copy

• createCubes: ((numberToCreate: number, desc?: CubeDescriptor) => IMeshEntity[])

  • • (numberToCreate, desc?): IMeshEntity[]

    • Creates multiple cube mesh entities efficiently by sharing the same mesh geometry. This is more performance-friendly than creating individual cubes when you need many instances.

      Parameters

      • numberToCreate: number

        The number of cube entities to create
      • desc: CubeDescriptor = {}

        Configuration object for the cube geometry and physics properties

      Returns IMeshEntity[]

      An array of mesh entities representing the cubes

      Example

      // Create 100 cubes for instancing
      const cubes = createCubes(100, {
        widthVector: Vector3.fromCopy3(0.5, 0.5, 0.5),
        physics: { use: true, move: true }
      });
      
      // Position them individually
      cubes.forEach((cube, index) => {
        cube.localPosition = Vector3.fromCopy3(index % 10, 0, Math.floor(index / 10));
      });
      Copy

• createGrid: ((desc?: GridDescriptor) => IMeshEntity)

  • • (desc?): IMeshEntity

    • Creates a grid mesh entity for visual reference.

      Parameters

      • desc: GridDescriptor = {}

        Configuration object for the grid geometry

      Returns IMeshEntity

      A mesh entity representing the grid

      Example

      const grid = createGrid({
        size: 10,
        divisions: 20
      });
      Copy

• createJoint: ((desc?: IAnyPrimitiveDescriptor) => IMeshEntity)

  • • (desc?): IMeshEntity

    • Creates a joint mesh entity for skeletal animation or mechanical connections.

      Parameters

      • desc: IAnyPrimitiveDescriptor = {}

        Configuration object for the joint geometry

      Returns IMeshEntity

      A mesh entity representing the joint

      Example

      const joint = createJoint({
        radius: 0.1,
        length: 2.0
      });
      Copy

• createLine: ((desc?: LineDescriptor) => IMeshEntity)

  • • (desc?): IMeshEntity

    • Creates a line mesh entity.

      Parameters

      • desc: LineDescriptor = {}

        Configuration object for the line geometry

      Returns IMeshEntity

      A mesh entity representing the line

      Example

      const line = createLine({
        startPoint: Vector3.fromCopy3(0, 0, 0),
        endPoint: Vector3.fromCopy3(1, 1, 1)
      });
      Copy

• createPlane: ((desc?: PlaneDescriptor & {
      direction?: "xz" | "xy" | "yz";
  }) => IMeshEntity)

  • • (desc?): IMeshEntity

    • Creates a plane mesh entity with configurable orientation.

      Parameters

      • desc: PlaneDescriptor & {
            direction?: "xz" | "xy" | "yz";
        } = {}

        Configuration object for the plane

      Returns IMeshEntity

      A mesh entity representing the plane

      Example

      // Create a horizontal plane (default)
      const horizontalPlane = createPlane();
      
      // Create a vertical plane facing forward
      const verticalPlane = createPlane({ direction: 'xy' });
      Copy

• createShape: ((primitive: IShape) => IMeshEntity)

  • • (primitive): IMeshEntity

    • Creates a mesh entity from a primitive shape. This is a utility function used internally by other creation methods.

      Parameters

      • primitive: IShape

        The primitive shape to convert into a mesh entity

      Returns IMeshEntity

      A mesh entity containing the primitive shape

      Example

      const customPrimitive = new CustomShape();
      customPrimitive.generate(config);
      const entity = createShape(customPrimitive);
      Copy

• createSphere: ((desc?: SphereDescriptor) => IMeshEntity)

  • • (desc?): IMeshEntity

    • Creates a sphere mesh entity with optional physics simulation.

      Parameters

      • desc: SphereDescriptor = {}

        Configuration object for the sphere geometry and physics properties

      Returns IMeshEntity

      A mesh entity representing the sphere, with physics component if specified

      Example

      // Create a simple sphere
      const sphere = createSphere({ radius: 2.0 });
      
      // Create a sphere with physics
      const physicsSphere = createSphere({
        radius: 1.0,
        physics: {
          use: true,
          move: true,
          density: 0.8,
          friction: 0.4,
          restitution: 0.9
        }
      });
      Copy

• createSpheres: ((numberToCreate: number, desc?: SphereDescriptor) => IMeshEntity[])

  • • (numberToCreate, desc?): IMeshEntity[]

    • Creates multiple sphere mesh entities efficiently by sharing the same mesh geometry. This is more performance-friendly than creating individual spheres when you need many instances.

      Parameters

      • numberToCreate: number

        The number of sphere entities to create
      • desc: SphereDescriptor = {}

        Configuration object for the sphere geometry and physics properties

      Returns IMeshEntity[]

      An array of mesh entities representing the spheres

      Example

      // Create 50 spheres for a particle system
      const spheres = createSpheres(50, {
        radius: 0.2,
        physics: { use: true, move: true, density: 0.5 }
      });
      
      // Scatter them randomly
      spheres.forEach(sphere => {
        sphere.localPosition = Vector3.fromCopy3(
          Math.random() * 10 - 5,
          Math.random() * 10,
          Math.random() * 10 - 5
        );
      });
      Copy