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 UpdatedMar 16, 2026
  • 2 minute read

The input fields for the Measure module.

Name

Type

Description

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

senum

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

senum

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

senum

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

  • points to start the creation of a measure, both single or multi line.

  • thickness to start the creation of a thickness measure.

  • diameter to start the creation of a diameter measure.

palette

sstring

Defines the color palette used for graphical elements. It is initialized using the corresponding configuration value.

setIdle

sevent

Invoke it to force setting the measure module state to idle.

setMeasure

sjson

Provides the information required to create new measures, such as 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