Operator Reference

set_scene_3d_instance_poseT_set_scene_3d_instance_poseSetScene3dInstancePoseSetScene3dInstancePoseset_scene_3d_instance_pose (Operator)

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

Signature

set_scene_3d_instance_pose( : : Scene3D, InstanceIndex, Pose : )

Herror T_set_scene_3d_instance_pose(const Htuple Scene3D, const Htuple InstanceIndex, const Htuple Pose)

void SetScene3dInstancePose(const HTuple& Scene3D, const HTuple& InstanceIndex, const HTuple& Pose)

void HScene3D::SetScene3dInstancePose(const HTuple& InstanceIndex, const HPoseArray& Pose) const

void HScene3D::SetScene3dInstancePose(Hlong InstanceIndex, const HPose& Pose) const

static void HOperatorSet.SetScene3dInstancePose(HTuple scene3D, HTuple instanceIndex, HTuple pose)

void HScene3D.SetScene3dInstancePose(HTuple instanceIndex, HPose[] pose)

void HScene3D.SetScene3dInstancePose(int instanceIndex, HPose pose)

def set_scene_3d_instance_pose(scene_3d: HHandle, instance_index: MaybeSequence[int], pose: MaybeSequence[Union[float, int]]) -> None

Description

set_scene_3d_instance_poseset_scene_3d_instance_poseSetScene3dInstancePoseSetScene3dInstancePoseset_scene_3d_instance_pose sets the pose of the instance InstanceIndexInstanceIndexInstanceIndexinstanceIndexinstance_index in the 3D scene Scene3DScene3DScene3Dscene3Dscene_3d 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_3dCreateScene3dCreateScene3dcreate_scene_3d 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

Scene3DScene3DScene3Dscene3Dscene_3d (input_control)  scene_3d HScene3D, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the 3D scene.

InstanceIndexInstanceIndexInstanceIndexinstanceIndexinstance_index (input_control)  integer(-array) HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Index of the instance.

PosePosePoseposepose (input_control)  pose(-array) HPose, HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

New pose of the instance.

Result

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

Possible Predecessors

add_scene_3d_instanceadd_scene_3d_instanceAddScene3dInstanceAddScene3dInstanceadd_scene_3d_instance

See also

set_scene_3d_to_world_poseset_scene_3d_to_world_poseSetScene3dToWorldPoseSetScene3dToWorldPoseset_scene_3d_to_world_pose, set_scene_3d_camera_poseset_scene_3d_camera_poseSetScene3dCameraPoseSetScene3dCameraPoseset_scene_3d_camera_pose

Module

3D Metrology