Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ XR Studio

Input fields

  • Last UpdatedOct 08, 2025
  • 2 minute read

The input fields for the Measure module.

Name

Type

Description

addPoint

sevent

Invoke to create a point using the PickSensor node, added with the measure module.

addPointAtPosition

svec3

Creates a point at the position passed as argument.

deleteAllMeasures

sevent

Invoke to delete all the measures in scene.

diameterPickNomal

svec3

Represents the second normal vector essential for defining the geometric plane in which the diameter measure’s circle resides.

editPointPick

mstring

Allows to move a defined measure point in a certain position. The mstring is composed by two comma separated values: the name of the point and the new position.

enable

sbool

Enables or disables the measure module. It is initialized using the corresponding configuration value.

hideAllMeasures

sevent

Invoke it to hide all the measures in scene.

measureLock

sstring

Allows to generate measures locked to a particular axis. Accepted values are XY to lock the measure to the X-Z plane; Y to lock the measure to the Y axis; empty to create a measure in the 3D space. While editing, same rules are applied to the point being edited.

measureToSelect

sstring

When this input is set, the measure with the corresponding name is selected.

measureUOM

sstring

Defines the unit of measure used to display the length of the measures. Accepted values are m, cm, mm, inch and ft. The unit of measure can be either defined at creation time or edited after the creation, if the measure is selected.

mode

sstring

Defines the state of the measure module. Accepted values are:

  • idle when measure mode is active but no measure is in creation or is being edited.

  • single to start the creation of a single line measure.

  • multi to start the creation of a multi-line measure.

  • thickness to start the creation of a thickness measure.

  • diameter to start the creation of a diameter measure.

  • edit to start editing the point position of a line.

  • delete to delete the line passed as input in measureToSelect.

pickStrategyNode

sstring

Name of the PickingStrategy node assigned to the pickingStrategyNode field of pickSensor node created with the module. PickingStrategy enables picking based on set criteria.

setMeasure

sjson

Provides the information required to create new measures, i.e. the points coordinates, the unit of measure and the selection state. The json string is composed with an array of measures objects.

{

"measureInfo": {

"measures": [

{

"uom": "m",

"selected": false,

"points": []

}]

}

}

showAllMeasures

sevent

Invoke to show all the measures in scene.

thicknessNormal

svec3

Represents the normal of the first point of a thickness measure. It is internally used to calculate and draw the circle of the diameter measure.

thicknessPoints

mvec3

Represents the two points of the segment defining a thickness measure.

Related Links
TitleResults for “How to create a CRG?”Also Available in