Measure class

The Measure class allows you to create measurements between nodes and parts. More...

The D3PLOT JavaScript API provides many class constants, properties and methods. For Arup to be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:

• _example
• $example
• ABC_example

Class functions

• Delete(type[integer])
• DeleteAll()
• GetFromIndex(type[integer])

Member functions

• Data()

Measure constants

Constants for Measure type

Constants for display

Constants for line

Constants for number format

Constants for offset

Constants for show

Measure class properties

Measure properties

// Create a measure between the 11th part and 12th part in the model:
var m = new Measure(Measure.PART_TO_PART, { part1: 11, part2: 12});

// Get the distace between these parts at state 10:
SetCurrentState(10);
var data = m.Data();
var distance = data.mag;

// Show all measurements on the screen in state 20:
// Note that SetCurrentState would only affect model data handling, but
// here we are interested in the state on the screen, so we set it with
// SetWindowFrame instead.
SetWindowFrame(ALL, 20);
Measure.show = Measure.SHOW_ALL;

See the documentation below for more details.

Arguments

var m = new Measure(Measure.NODE_TO_PART, { node1: 100, part2: 3 });

var m = new Measure(Measure.NODE_TO_PART, { node1: -50, part2: -10 });

var data = m.Data();
var dx = data.dx;
      

var index = m.index;
Measure.Delete(index);
      

Measure.DeleteAll();
      

var m = Measure.GetFromIndex(3);