3D Shape Collections API Reference

Contents

• COL_Axis3
• CollectionsAxis3

---

COL_Axis3

Extends OBJ_Collection

CollectionsAxis3 options object that extends OBJ_Collection options object (without parent).

Each option can either be singular and applied to all axes, or in a 3 element tuple where the first, second and third elements apply to the x, y, and z axes respectively.

To not create an axis, use a width of exactly 0.

Properties

• width: number | [number, number, number] | undefined

  width of axis

• start: number | [number, number, number] | undefined = 0

  start value of axis

• length: number | [number, number, number] | undefined

  length of axis

• sides: number | [number, number, number] | undefined = 10

  number of sides in cross section of axis

• lines: number | [number, number, number] | undefined = false

  true if to draw as lines instead of a solid

• arrow: OBJ_Line3Arrow | boolean | [OBJ_Line3Arrow | boolean, OBJ_Line3Arrow | boolean, OBJ_Line3Arrow | boolean] | undefined

  arrow options for axes

• color: TypeColor | [TypeColor, TypeColor, TypeColor] | undefined

  axes color - default is x: red, y: green, z: blue.

---

CollectionsAxis3

FigureElementCollection representing x, y, z axes.

This object creates an x, y, and z axes.

The axes can be created uniformly, or customized individually.

See COL_Axis3 for setup options.

To test examples below, append them to the boilerplate

Create positive x, y, and z axes

figure.add(
  {
    make: 'collections.axis3',
    arrow: true,
    length: 0.5,
  },
);
Copy

Create full x, y, and z axes with arrows

figure.add(
  {
    make: 'collections.axis3',
    arrow: { ends: 'all' },
    start: -0.5,
    length: 1,
  },
);
Copy

Customize each axis

figure.add(
  {
    make: 'collections.axis3',
    arrow: [{ ends: 'end' }, false, { ends: 'all', width: 0.02 }],
    width: 0.02,
    start: [0, 0, -0.5],
    length: [0.5, 0.5, 1],
  },
);
Copy

Lines axes all the same color

figure.add(
  {
    make: 'collections.axis3',
    arrow: { ends: 'all' },
    start: -0.5,
    length: 1,
    lines: true,
    color: [1, 0, 0, 1],
  },
);
Copy

---