remove_scene_3d_instanceRemoveScene3dInstanceRemoveScene3dInstanceremove_scene_3d_instanceT_remove_scene_3d_instance
Short description
remove_scene_3d_instanceRemoveScene3dInstanceRemoveScene3dInstanceremove_scene_3d_instanceT_remove_scene_3d_instance — Remove an object instance from a 3D scene.
Signature
remove_scene_3d_instance( scene_3d Scene3D, integer InstanceIndex )void RemoveScene3dInstance( const HTuple& Scene3D, const HTuple& InstanceIndex )static void HOperatorSet.RemoveScene3dInstance( HTuple scene3D, HTuple instanceIndex )def remove_scene_3d_instance( scene_3d: HHandle, instance_index: MaybeSequence[int] ) -> None
Herror T_remove_scene_3d_instance( const Htuple Scene3D, const Htuple InstanceIndex )
void HScene3D::RemoveScene3dInstance( const HTuple& InstanceIndex ) const
void HScene3D::RemoveScene3dInstance( Hlong InstanceIndex ) const
void HScene3D.RemoveScene3dInstance( HTuple instanceIndex )
void HScene3D.RemoveScene3dInstance( int instanceIndex )
Description
remove_scene_3d_instanceRemoveScene3dInstance removes the instance InstanceIndexinstanceIndexinstance_index
from the 3D scene Scene3Dscene3Dscene_3d.
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
Scene3Dscene3Dscene_3d (input_control) scene_3d → (handle)HTuple (HHandle)HScene3D, HTuple (IntPtr)HHandleHtuple (handle)
Handle of the 3D scene.
InstanceIndexinstanceIndexinstance_index (input_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)
Index of the instance to remove.
Result
remove_scene_3d_instanceRemoveScene3dInstance returns 2 (H_MSG_TRUE) if all parameters are
correct. If necessary, an exception is raised.
Combinations with other operators
Combinations
See also
add_scene_3d_instanceAddScene3dInstance
Module
3D Metrology