gen_cylinder_object_model_3dT_gen_cylinder_object_model_3dGenCylinderObjectModel3dGenCylinderObjectModel3dgen_cylinder_object_model_3d (Operator)
Name
gen_cylinder_object_model_3dT_gen_cylinder_object_model_3dGenCylinderObjectModel3dGenCylinderObjectModel3dgen_cylinder_object_model_3d — Create a 3D object model that represents a cylinder.
Signature
void GenCylinderObjectModel3d(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 void HOperatorSet.GenCylinderObjectModel3d(HTuple pose, HTuple radius, HTuple minExtent, HTuple maxExtent, out HTuple objectModel3D)
static HObjectModel3D[] HObjectModel3D.GenCylinderObjectModel3d(HPose[] pose, HTuple radius, HTuple minExtent, HTuple maxExtent)
void HObjectModel3D.GenCylinderObjectModel3d(HPose pose, double radius, double minExtent, double maxExtent)
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]) -> HHandle
Description
gen_cylinder_object_model_3dgen_cylinder_object_model_3dGenCylinderObjectModel3dGenCylinderObjectModel3dGenCylinderObjectModel3dgen_cylinder_object_model_3d 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
PosePosePosePoseposepose and by its radius in RadiusRadiusRadiusRadiusradiusradius. 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 MinExtentMinExtentMinExtentMinExtentminExtentmin_extent and MaxExtentMaxExtentMaxExtentMaxExtentmaxExtentmax_extent. MinExtentMinExtentMinExtentMinExtentminExtentmin_extent
and MaxExtentMaxExtentMaxExtentMaxExtentmaxExtentmax_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 ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_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.
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
PosePosePosePoseposepose (input_control) pose(-array) → HPose, HTupleSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
The pose that describes the position and
orientation of the cylinder.
RadiusRadiusRadiusRadiusradiusradius (input_control) number(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
The radius of the cylinder.
MinExtentMinExtentMinExtentMinExtentminExtentmin_extent (input_control) number(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Lowest z-coordinate of the cylinder in the
direction of the rotation axis.
MaxExtentMaxExtentMaxExtentMaxExtentmaxExtentmax_extent (input_control) number(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Highest z-coordinate of the cylinder in the
direction of the rotation axis.
Restriction:
MinExtent < MaxExtent
ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d (output_control) object_model_3d(-array) → HObjectModel3D, HTupleSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the resulting 3D object model.
Result
gen_cylinder_object_model_3dgen_cylinder_object_model_3dGenCylinderObjectModel3dGenCylinderObjectModel3dGenCylinderObjectModel3dgen_cylinder_object_model_3d returns 2 (
H_MSG_TRUE)
if all parameters
are correct. If necessary, an exception is raised.
Possible Successors
get_object_model_3d_paramsget_object_model_3d_paramsGetObjectModel3dParamsGetObjectModel3dParamsGetObjectModel3dParamsget_object_model_3d_params,
sample_object_model_3dsample_object_model_3dSampleObjectModel3dSampleObjectModel3dSampleObjectModel3dsample_object_model_3d,
clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dClearObjectModel3dclear_object_model_3d
See also
gen_sphere_object_model_3dgen_sphere_object_model_3dGenSphereObjectModel3dGenSphereObjectModel3dGenSphereObjectModel3dgen_sphere_object_model_3d,
gen_sphere_object_model_3d_centergen_sphere_object_model_3d_centerGenSphereObjectModel3dCenterGenSphereObjectModel3dCenterGenSphereObjectModel3dCentergen_sphere_object_model_3d_center,
gen_plane_object_model_3dgen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3dGenPlaneObjectModel3dgen_plane_object_model_3d,
gen_box_object_model_3dgen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3dGenBoxObjectModel3dgen_box_object_model_3d
Module
3D Metrology