M3dgraNode

Board	Supported
Host System	Yes
V4L2	Yes
Clarity UHD	Yes
Concord PoE	No
GenTL	Yes
GevIQ	Yes
GigE Vision	Yes
Indio	No
Iris GTX	Yes
Radient eV-CL	Yes
Rapixo CL	Yes
Rapixo CoF	Yes
Rapixo CXP	Yes
USB3 Vision	Yes

Add a node to a 3D graphics list.

Syntax

AIL_INT64 M3dgraNode(
    AIL_ID    List3dgraId,    //out
    AIL_INT64 ParentLabel,    //in
    AIL_ID    Matrix3dgeoId,  //in
    AIL_INT64 ControlFlag     //in
)

Description

This function adds a node to the specified 3D graphics list. Unlike other elements of a 3D graphics list, nodes have no graphical representation. You can use a node to group 3D graphics by specifying the node's label as their parent label. This allows you to apply settings to all of the node's children graphics using the node's label in a call to M3dgraControl with M_RECURSIVE.

You must specify the label of the 3D graphic, in the 3D graphics list, to use as the parent of the node. When the node is added to the 3D graphics list's tree structure, it is added as a child under the specified parent. If the 3D graphics list is empty, the node's parent must be the root node.

The node has its own coordinate system that represents the node's position and orientation with respect to its parent's coordinate system. You can set the node's position and orientation using the Matrix3dgeoId parameter. To change the position and orientation of a node, use M3dgraCopy with M_TRANSFORMATION_MATRIX. This is particularly useful if you want to move a group of 3D graphics that are all descendents of the same node, since the operation will maintain the descendents' relative positions and orientations.

To modify or inquire 3D graphics list settings, use M3dgraControl or M3dgraInquire, respectively.

Note: Unlike most other functions that modify an Aurora Imaging Library object, you can call this function concurrently from multiple threads on the same Aurora Imaging Library 3D graphics list (List3dgraId) without using an M_MUTEX object, as long as all the other parameters of the concurrent calls do not also share data.

Parameters

List3dgraId (out, AIL_ID)

Specifies the identifier of the 3D graphics list in which to add the node. The 3D graphics list must have been previously allocated on the required system using M3dgraAlloc, or you can specify the identifier of the 3D display's internal graphics list (inquired using M3ddispInquire with M_3D_GRAPHIC_LIST_ID).

ParentLabel (in, AIL_INT64)

Specifies the label of the parent of the node in the 3D graphics list.

For specifying the parent label

Value	Description
M_DEFAULT	Same as M_ROOT_NODE.
M_ROOT_NODE	Specifies the top-most node of the 3D graphics list.
Value >= 0	Specifies the label of the parent of the node in the 3D graphics list. Label 0 is the 3D graphics list's root node.

Matrix3dgeoId (in, AIL_ID)

Specifies the identifier of the transformation matrix that defines the node graphic's position and orientation with respect to its parent's coordinate system.

For specifying the transformation matrix object identifier

Value	Description
M_DEFAULT	Same as M_IDENTITY_MATRIX.
M_IDENTITY_MATRIX	Specifies the identity matrix. This means that the node graphic's position and orientation is the same as the position and orientation of its parent's coordinate system.
Transformation matrix object identifier	Specifies the identifier of the transformation matrix that defines the node graphic's position and orientation with respect to its parent's coordinate system. The transformation matrix must be of type M_RIGID.

ControlFlag (in, AIL_INT64)

Reserved for future expansion and must be set to M_DEFAULT.

Return Value

Type: AIL_INT64

Returns the label of the node added to the 3D graphics list.