add_scene_3d_instance🔗
Short description🔗
add_scene_3d_instance — Add an instance of a 3D object model to a 3D scene.
Signature🔗
add_scene_3d_instance( scene_3d Scene3D, object_model_3d ObjectModel3D, pose Pose, out integer InstanceIndex )
Description🔗
add_scene_3d_instance adds an instance of the 3D model
ObjectModel3D to the 3D scene Scene3D and returns
its index in InstanceIndex. If multiple 3D object models are
supplied, it is possible to set one pose for all instances or one pose
for every instance.
The pose of the object instance in the scene coordinate system must be
given in Pose. The operator
set_scene_3d_instance_pose can be used to change this pose.
As long as no global scene pose is set with
set_scene_3d_to_world_pose, this pose is evaluated relative to
the world coordinate system.
Parameters of the instance, such as its color, are set with the
operator set_scene_3d_instance_param.
Execution information🔗
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🔗
Scene3D (input_control) scene_3d → (handle)
Handle of the 3D scene.
ObjectModel3D (input_control) object_model_3d(-array) → (handle)
Handle of the 3D object model.
Pose (input_control) pose(-array) → (real / integer)
Pose of the 3D object model.
Number of elements: 7
InstanceIndex (output_control) integer → (integer)
Index of the new instance in the 3D scene.
Result🔗
add_scene_3d_instance returns 2 (H_MSG_TRUE) if all parameters are
correct. If necessary, an exception is raised.
Combinations with other operators🔗
Combinations
Possible predecessors
Possible successors
set_scene_3d_instance_param, set_scene_3d_instance_pose
See also
Module🔗
3D Metrology