Skip to content

gen_cylinder_object_model_3dGenCylinderObjectModel3dGenCylinderObjectModel3dgen_cylinder_object_model_3dT_gen_cylinder_object_model_3d🔗

Short description🔗

gen_cylinder_object_model_3dGenCylinderObjectModel3dGenCylinderObjectModel3dgen_cylinder_object_model_3dT_gen_cylinder_object_model_3d — Create a 3D object model that represents a cylinder.

Signature🔗

gen_cylinder_object_model_3d( pose Pose, number Radius, number MinExtent, number MaxExtent, out object_model_3d ObjectModel3D )void GenCylinderObjectModel3d( const HTuple& Pose, const HTuple& Radius, const HTuple& MinExtent, const HTuple& MaxExtent, HTuple* ObjectModel3D )static void HOperatorSet.GenCylinderObjectModel3d( HTuple pose, HTuple radius, HTuple minExtent, HTuple maxExtent, out HTuple objectModel3D )def gen_cylinder_object_model_3d( pose: Sequence[Union[int, float]], radius: MaybeSequence[float], min_extent: MaybeSequence[float], max_extent: MaybeSequence[float] ) -> Sequence[HHandle]

def gen_cylinder_object_model_3d_s( pose: Sequence[Union[int, float]], radius: MaybeSequence[float], min_extent: MaybeSequence[float], max_extent: MaybeSequence[float] ) -> HHandleHerror T_gen_cylinder_object_model_3d( const Htuple Pose, const Htuple Radius, const Htuple MinExtent, const Htuple MaxExtent, Htuple* ObjectModel3D )

static HObjectModel3DArray HObjectModel3D::GenCylinderObjectModel3d( const HPoseArray& Pose, const HTuple& Radius, const HTuple& MinExtent, const HTuple& MaxExtent )

void HObjectModel3D::GenCylinderObjectModel3d( const HPose& Pose, double Radius, double MinExtent, double MaxExtent )

static HObjectModel3D[] HObjectModel3D.GenCylinderObjectModel3d( HPose[] pose, HTuple radius, HTuple minExtent, HTuple maxExtent )

void HObjectModel3D.GenCylinderObjectModel3d( HPose pose, double radius, double minExtent, double maxExtent )

Description🔗

gen_cylinder_object_model_3dGenCylinderObjectModel3d creates a cylinder-shaped 3D primitive, i.e., a 3D object model that represents a cylinder. A cylinder is described by its center and the direction of its axis in Poseposepose and by its radius in Radiusradiusradius. The pose has the origin on the rotation axis of the cylinder and is oriented such that the z-axis is aligned with the main direction of the cylinder. Additionally, the extensions of the cylinder are given by MinExtentminExtentmin_extent and MaxExtentmaxExtentmax_extent. MinExtentminExtentmin_extent and MaxExtentmaxExtentmax_extent represent the z-coordinates of the lowest and highest points of the cylinder on the rotation axis. The handle of the 3D object model is returned by the parameter ObjectModel3DobjectModel3Dobject_model_3d.

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.

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🔗

Poseposepose (input_control) pose(-array) → (real / integer)HTuple (double / Hlong)HPose, HTuple (double / int / long)Sequence[Union[int, float]]Htuple (double / Hlong)

The pose that describes the position and orientation of the cylinder.

Radiusradiusradius (input_control) number(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

The radius of the cylinder.

MinExtentminExtentmin_extent (input_control) number(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Lowest z-coordinate of the cylinder in the direction of the rotation axis.

MaxExtentmaxExtentmax_extent (input_control) number(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Highest z-coordinate of the cylinder in the direction of the rotation axis.

Restriction: MinExtent < MaxExtent

ObjectModel3DobjectModel3Dobject_model_3d (output_control) object_model_3d(-array) → (handle)HTuple (HHandle)HObjectModel3D, HTuple (IntPtr)Sequence[HHandle]Htuple (handle)

Handle of the resulting 3D object model.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

get_object_model_3d_paramsGetObjectModel3dParams, sample_object_model_3dSampleObjectModel3d, clear_object_model_3dClearObjectModel3d

See also

gen_sphere_object_model_3dGenSphereObjectModel3d, gen_sphere_object_model_3d_centerGenSphereObjectModel3dCenter, gen_plane_object_model_3dGenPlaneObjectModel3d, gen_box_object_model_3dGenBoxObjectModel3d

Module🔗

3D Metrology