set_scene_3d_instance_poseset_scene_3d_instance_poseSetScene3dInstancePoseSetScene3dInstancePose (Operator)

Name

set_scene_3d_instance_poseset_scene_3d_instance_poseSetScene3dInstancePoseSetScene3dInstancePose — Set the pose of an instance in a 3D scene.

Signature

set_scene_3d_instance_pose( : : Scene3D, InstanceIndex, Pose : )

set_scene_3d_instance_poseset_scene_3d_instance_poseSetScene3dInstancePoseSetScene3dInstancePoseSetScene3dInstancePose sets the pose of the instance InstanceIndexInstanceIndexInstanceIndexInstanceIndexinstanceIndex in the 3D scene Scene3DScene3DScene3DScene3Dscene3D to PosePosePosePosepose. It's possible to set one pose for multiple instances or one pose for each instance.

See the documentation of create_scene_3dcreate_scene_3dCreateScene3dCreateScene3dCreateScene3d for more details on the coordinate systems used in 3D scenes.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

Scene3DScene3DScene3DScene3Dscene3D (input_control) scene_3d → (integer)

Handle of the 3D scene.

InstanceIndexInstanceIndexInstanceIndexInstanceIndexinstanceIndex (input_control) integer(-array) → (integer)

Index of the instance.

PosePosePosePosepose (input_control) pose(-array) → (real / integer)

New pose of the instance.

Result

set_scene_3d_instance_poseset_scene_3d_instance_poseSetScene3dInstancePoseSetScene3dInstancePoseSetScene3dInstancePose returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Possible Predecessors

add_scene_3d_instanceadd_scene_3d_instanceAddScene3dInstanceAddScene3dInstanceAddScene3dInstance

Module

3D Metrology

Operators