d3-x3dom-shape

x3dom version of d3-shape. Create 3d primitive shapes in x3dom such as lines and surfaces.

Installing

If you use NPM, npm install d3-x3dom-shape. Otherwise, download the latest release.

Demo

Demo on blockbuilder

API Reference

Utilities

# makeSolid(selection, [color])

Append an appearance and material to the given selection with a diffuseColor set to color which default to black if not provided.

Line

The line generator produces a polyline in 3d space.

# line()

Constructs a new 3d line generator with the default settings. The line is created by extruding a cylinder going through the data points, the size of the line at each point can be specified.

# line(data)

Generates the line spine for the given array of data.

scene.append('shape')
  .datum(data)
  .call(makeSolid, 'red')
  .append('Extrusion')
  .attr('crossSection', circleSection)
  .attr('spine', line);

# line.scale(data)

Generates the line scale for the given array of data.

scene.append('shape')
  .datum(data)
  .call(makeSolid, 'red')
  .append('Extrusion')
  .attr('crossSection', line.circleSection)
  .attr('scale', lineX.scale)
  .attr('spine', line);

# line.x([x])

If x is specified, sets the x accessor to the specified function or number and returns this line generator. If x is not specified, returns the current x accessor, which defaults to:

function x(d) {
  return d[0];
}

When a line is generated, the x accessor will be invoked for each defined element in the input data array, being passed the element d, the index i, and the array data as three arguments. The default x accessor assumes that the input data are three-element arrays of numbers. If your data are in a different format, or if you wish to transform the data before rendering, then you should specify a custom accessor.

# line.y([y])

If y is specified, sets the y accessor to the specified function or number and returns this line generator. If y is not specified, returns the current y accessor, which defaults to:

function y(d) {
  return d[1];
}

When a line is generated, the y accessor will be invoked for each defined element in the input data array, being passed the element d, the index i, and the array data as three arguments. The default y accessor assumes that the input data are three-element arrays of numbers. See line.x for more information.

# line.z([z])

If z is specified, sets the z accessor to the specified function or number and returns this line generator. If z is not specified, returns the current z accessor, which defaults to:

function z(d) {
  return d[1];
}

When a line is generated, the z accessor will be invoked for each defined element in the input data array, being passed the element d, the index i, and the array data as three arguments. The default z accessor assumes that the input data are three-element arrays of numbers. See line.x for more information.

# line.s([s])

If s is specified, sets the s accessor to the specified function or number and returns this line generator. If s is not specified, returns the current s accessor, which defaults to:

function s(d) {
  return [1, 1];
}

The s accessor specified the size of the line at the data point d.

When a line is generated, the s accessor will be invoked for each defined element in the input data array, being passed the element d, the index i, and the array data as three arguments. The default s accessor assumes that the input data are three-element arrays of numbers. See line.x for more information.

# line.circleSection

A circle crossSection for the x3dom extrusion.

Surface

The surface generator produces a quadrilateral polyhderal surface in 3d space. In particular, it is made for for quadritlateral polyhedral terrain, which is equivalent to plotting a function of the form z= f(x, y).

# surface()

Constructs a new 3d surface generator with the default settings. The surface is created by extruding a cylinder going through the data points, the size of the surface at each point can be specified.

scene.selectAll('.surface')
  .data(data);
  .enter()
  .append('shape')
  .attr('class', 'surface')
  .append('indexedfaceset')
  .attr('coordIndex', surfac)
  .append("coordinate")
  .attr('point', surface.coordinates);


d3.selectAll('indexedFaceSet')
  .append('color')
  .attr('color', surface.color);

# surface(data)

Generates the surface coordIndex for the given 2d array of data.

# surface.coordinates(data)

Generates the surface coordinates for the given array of data.

# surface.color(data)

Generates the surface color for the given array of data.

# surface.x([x])

If x is specified, sets the x accessor to the specified function or number and returns this surface generator. If x is not specified, returns the current x accessor, which defaults to:

function x(d) {
  return d[0];
}

When a surface is generated, the x accessor will be invoked for each defined element in the input data array, being passed the element d, the index i, and the array data as three arguments. The default x accessor assumes that the input data are three-element arrays of numbers. If your data are in a different format, or if you wish to transform the data before rendering, then you should specify a custom accessor.

# surface.y([y])

If y is specified, sets the y accessor to the specified function or number and returns this surface generator. If y is not specified, returns the current y accessor, which defaults to:

function y(d) {
  return d[1];
}

When a surface is generated, the y accessor will be invoked for each defined element in the input data array, being passed the element d, the index i, and the array data as three arguments. The default y accessor assumes that the input data are three-element arrays of numbers. See surface.x for more information.

# surface.z([z])

If z is specified, sets the z accessor to the specified function or number and returns this surface generator. If z is not specified, returns the current z accessor, which defaults to:

function z(d) {
  return d[1];
}

When a surface is generated, the z accessor will be invoked for each defined element in the input data array, being passed the element d, the index i, and the array data as three arguments. The default z accessor assumes that the input data are three-element arrays of numbers. See surface.x for more information.

# surface.color([color])

If color is specified, sets the s accessor to the specified function or number and returns this surface generator. If s is not specified, returns the current s accessor, which defaults to:

function color(d) {
  return 'white';
}