gen_sphere_object_model_3dT_gen_sphere_object_model_3dGenSphereObjectModel3dGenSphereObjectModel3d (Operator)

Name

gen_sphere_object_model_3dT_gen_sphere_object_model_3dGenSphereObjectModel3dGenSphereObjectModel3d — Create a 3D object model that represents a sphere.

Signature

gen_sphere_object_model_3d( : : Pose, Radius : ObjectModel3D)

gen_sphere_object_model_3dgen_sphere_object_model_3dGenSphereObjectModel3dGenSphereObjectModel3dGenSphereObjectModel3d creates a sphere-shaped 3D primitive, i.e., a 3D object model that represents a sphere. A sphere is defined by its center given in PosePosePosePosepose and its radius given in RadiusRadiusRadiusRadiusradius. If several sphere-shaped 3D primitives are created and the number of elements in the parameter RadiusRadiusRadiusRadiusradius is 1, all spheres are created with the same radius. The handle of the 3D object model is returned by the parameter ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3D.

Note that if a 3D object model is no longer needed or should be overwritten, the memory has to be freed first by calling the operator clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dClearObjectModel3d.

Execution Information

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

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

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

The pose that describes the position of the sphere.

RadiusRadiusRadiusRadiusradius (input_control) number(-array) → (real)

The radius of the sphere.

ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3D (output_control) object_model_3d(-array) → (integer)

Handle of the resulting 3D object model.

Result

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