Warning
Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.
Property¶
Enumeration Property
Index
Enumeration Members
Enumeration Members
ReadonlyACTIVATABLE
Specifies whether an AUX node can be enabled.
If this is true, the AUX node can be shown by setting the Property.ENABLED.
ANIMATION
The Animation property is used to assign an animation to a node.
APPEARANCE_
The appearance URI of a node. This defines the node's visual appearance using a URN that encodes color and transparency.
Appearance URNs always start with urn:X-l3d:color: followed by a format and a color specification. Supported formats include:
- Hexadecimal colors: Specify a color using the
rgbformat, e.g.,urn:X-l3d:color:rgb:FF0000for red (#FF0000). - Hexadecimal with transparency: Use the
rgbaformat, e.g.,urn:X-l3d:color:rgba:FF000080for 50% transparent red. - Transparency only: Use the
aformat to set only the opacity in hexadecimal format, e.g.,urn:X-l3d:color:a:80for 50% opacity. - Named colors: Specify standard CSS color names, e.g.,
urn:X-l3d:color:red.
For convenience, you can omit the urn:X-l3d:color: prefix and use the color or transparency code directly, such as
"FF0000", "FF000080", or "80".
Set to null to reset the appearance.
ATTACHMENT
The attachment property is used to attach data to a node. This property contains either the attachment ID or the attachment data itself.
ReadonlyAUX_
Contains additional information for AUX nodes.
AUX_
Specifies whether an AUX node is enabled.
If set to true, all AUX nodes associated with the node become visible.
Value Type
EnabledState | boolean
ReadonlyAUX_
Contains the IDs of all related AUX nodes.
There are two kinds of AUX nodes. PMIs (Product and Manufacturing Information) are used to display annotations and measurements, or to show additional information about a node. The second kind are model views, which can contain PMIs as well as camera views that place the camera and the model at a specific position.
ReadonlyCHILDREN
Contains the IDs of all child nodes.
COMPARISON_
Contains the ComparisonGroup of a node.
ReadonlyDEPTH
Indicates the depth of a node within the hierarchy. Root nodes have a depth of 1, and each subsequent level of child nodes increases the depth by 1.
ENABLED
Specifies whether a node is enabled. Toggles the visibility of the according 3D geometry if a viewer is attached.
ExperimentalGHOSTED
Property GHOSTED is experimental and may be changed in the next release.
Specifies whether a node is ghosted. Ghosted nodes become transparent and can't be interacted with, which is useful for highlighting other nodes in the scene. This can be used to localize otherwise occluded nodes in your 3D data.
This effect can be further customized by ViewerSettingStrings.GHOSTED_SCENE_OPACITY.
ReadonlyGLOBAL_
Contains the global transformation matrix of a node. Global transformations are relative to the world coordinate system, which is always in meters. Hence, the translational component of the local and global transformation is set in meters. For top-level nodes, the global transformation is equal to the local transformation. For child nodes, the global transformation is calculated by multiplying the parent's global transformation with the child's local transformation.
The global transformation will be updated when manipulating the Property.LOCAL_TRANSFORM property.
ReadonlyGLOBAL_
Contains the axis-aligned global box volume of a node in meters.
Volumes are propagated throughout the node tree, meaning they will update when the Property.LOCAL_TRANSFORM property of the node itself or related nodes (parents or children) is modified.
ReadonlyHAS_
Specifies whether a node has an AUX node structure attached.
If this is true, the AUX nodes can be accessed by reading the Property.AUX_NODES.
ReadonlyHAS_
Specifies whether a node has variants.
The node's variants can be accessed using VariantsAPI.requestVariants.
ReadonlyINFO_
Deprecated
Property INFO_STATE is deprecated and will be removed in the next release. Please use STATE instead.
LABEL
Contains the label of a node.
LOCAL_
Contains the local transformation matrix of a node. Notice that the world coordinate system is always in meters, hence the translational component of the local and global transformation is set in meters.
Local transformations are defined in the 3D data but can be changed via this property. Currently, you can only transform root nodes of linked parts.
Changing the local transform will update the Property.GLOBAL_TRANSFORM and Property.GLOBAL_VOLUME properties.
ReadonlyLOCAL_
Contains the axis-aligned local box volume of a node in meters.
The local volume will be updated when manipulating the Property.LOCAL_TRANSFORM property.
ReadonlyMODEL_
Contains the IDs of all model views that are attached to a node. Model views are a certain kind of AUX node that can contain PMIs as well as camera views that place the camera and the model at a specific position.
Model views can be enabled by setting the Property.AUX_ENABLED property of the model view ID to true.
NAMES
Contains the names of a node.
ReadonlyNODE_
Contains the NodeRepresentation of a node.
ExperimentalOUTLINED
Property OUTLINE is experimental and may be changed in the next release.
Whether the node is outlined or not. If enabled, the outlined node's silhoutte is highlighted even if it is occluded by other geometry. This can be used to localize otherwise occluded nodes or small details in your 3D data.
This effect can be customized via ViewerSettingStrings.OUTLINE_COLOR, ViewerSettingStrings.OUTLINE_COLOR_OCCLUDED, ViewerSettingStrings.OUTLINE_INNER_RADIUS and ViewerSettingStrings.OUTLINE_OUTER_RADIUS.
ReadonlyPARENT
Contains the ID of the parent node.
PICKABLE
Specifies whether a node is pickable. This disabled interactions on the node but still allows it to be visible.
REAL
The real property is used by the RealityAPI to specify whether a node will be marked as tracking target for the Reality service. The expected value is an EnabledState. Note that true will be mapped to EnabledState.Enabled and false to EnabledState.Disabled.
Value Type
EnabledState | boolean
REAL_
When set to true, the node will be used as an occluder in the hypothesis generation process.
RENDER_
Contains the RenderMode of a node. If set to anything other than RenderMode.Unset, this property overrides the ViewerSettingStrings.RENDER_MODE setting of the viewer but gets overridden by the ViewerAPI.forceRenderMode method.
ReadonlyRESOURCE_
Deprecated
Property RESOURCE_STATE is deprecated and will be removed in the next release. Please use STATE instead.
ReadonlySELECTED
Specifies whether a node is selected.
ReadonlySTATE
Contains the NodeState of a node.
ReadonlySUBTYPE
A subtype can be set for custom nodes next to the NodeType. It can be used to further specify the type of a customly created node.
ReadonlyTYPE
Contains the NodeType of a node.
USER_
Can contain any type of serializable data that is attached to a node.
Value Type
Serializable | undefined
The properties a node can have. Node properties can be set and retrieved using the InstanceGraphAPI.
Using InstanceGraphAPI.setProperty will trigger a EventType.NODE_CHANGED event.