AVEVA™ XR Studio

Object

Save PDF

Save PDF

The Object node is used to link a dummy object inside the scene to a logic object.

The dummy can be used for two main purposes:

To create a coordinate reference inside the scene for use by the script. For example, to move or position objects and cameras.
To group a certain set of objects (mesh principally) and apply positioning, fade, and show together through a single reference.

The object node shares many of the attributes owned by the mesh node.

This node is fully supported on XR-Windows, XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-Portable WASM platforms.

XR-WIN	XR-P-WIN	XR-P-IOS	XR-P-AND	XR-P-WASM
Full support	Full support	Full support	Full support	Full support

This is a code example for the Object node.

The Object node must be inside a context node, such as Context or Global.

These are the fields for Object node. Only the node-specific fields are indicated, not fields obtained by inheritance.

Field inheritance: NodeBase à Object

Fields	Type	Use	Default value	Description
fade	svec3	Optional	No default value	Triggers a fade animation. The values are: Animation time Starting fade value Finish fade value For example: With 2 0.5 0.7 we can trigger a fade that starts at 0.5 and finishes at 0.7 that takes 2 seconds. If we set -1 as starting fade value, the current fade value is used as starting value.
fadeIn	sfloat	Optional	No default value	Triggers fadeIn with given time interval in seconds.
fadeOut	sfloat	Optional	No default value	Triggers fadeOut with given time interval in seconds.
get_position	svec3	Read only	No default value	Returns the value of the mesh.
hide	sevent	Optional	No default value	Set the group of objects to not visible.
node	sstring	Mandatory	No default value	The name of the dummy node in the scene.
position	svec3	Optional	No default value	This field sets the position of the group of objects referenced by the dummy node. The parameter that retrieves the current position of the object must be get_position.
set_fade	sfloat	Optional	No default value	Sets the mesh fade level (0 to 1).
show	sevent	Optional	No default value	Sets the group of objects to visible.
visible	sbool	Optional	Mesh visibility start value	Reads or writes the display state of the mesh.