Skip to content

gen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3dgen_plane_object_model_3dT_gen_plane_object_model_3d🔗

Short description🔗

gen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3dgen_plane_object_model_3dT_gen_plane_object_model_3d — Create a 3D object model that represents a plane.

Signature🔗

gen_plane_object_model_3d( pose Pose, point.x XExtent, point.y YExtent, out object_model_3d ObjectModel3D )void GenPlaneObjectModel3d( const HTuple& Pose, const HTuple& XExtent, const HTuple& YExtent, HTuple* ObjectModel3D )static void HOperatorSet.GenPlaneObjectModel3d( HTuple pose, HTuple XExtent, HTuple YExtent, out HTuple objectModel3D )def gen_plane_object_model_3d( pose: Sequence[Union[int, float]], xextent: MaybeSequence[Union[float, int]], yextent: MaybeSequence[Union[float, int]] ) -> HHandle

Herror T_gen_plane_object_model_3d( const Htuple Pose, const Htuple XExtent, const Htuple YExtent, Htuple* ObjectModel3D )

void HObjectModel3D::GenPlaneObjectModel3d( const HPose& Pose, const HTuple& XExtent, const HTuple& YExtent )

void HObjectModel3D::GenPlaneObjectModel3d( const HPose& Pose, double XExtent, double YExtent )

void HObjectModel3D.GenPlaneObjectModel3d( HPose pose, HTuple XExtent, HTuple YExtent )

void HObjectModel3D.GenPlaneObjectModel3d( HPose pose, double XExtent, double YExtent )

Description🔗

gen_plane_object_model_3dGenPlaneObjectModel3d creates a planar 3D primitive, i.e., a 3D object model that represents a plane. The plane is described by its center and rotation. The normal vector of the plane is aligned to the z-axis of the rotated coordinate system. The center and the rotation is set with the parameter Poseposepose. Additionally, the plane can be limited by a polygon, that is defined by points with the coordinates XExtentXExtentxextent and YExtentYExtentyextent. 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 → (real / integer)HTuple (double / Hlong)HPose, HTuple (double / int / long)Sequence[Union[int, float]]Htuple (double / Hlong)

The center and the rotation of the plane.

Number of elements: Pose == 7

XExtentXExtentxextent (input_control) point.x(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)

x coordinates specifying the extent of the plane.

YExtentYExtentyextent (input_control) point.y(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)

y coordinates specifying the extent of the plane.

Number of elements: XExtent == YExtent

ObjectModel3DobjectModel3Dobject_model_3d (output_control) object_model_3d → (handle)HTuple (HHandle)HObjectModel3D, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the resulting 3D object model.

Result🔗

gen_plane_object_model_3dGenPlaneObjectModel3d 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_cylinder_object_model_3dGenCylinderObjectModel3d, gen_sphere_object_model_3dGenSphereObjectModel3d, gen_sphere_object_model_3d_centerGenSphereObjectModel3dCenter, gen_box_object_model_3dGenBoxObjectModel3d

Module🔗

3D Metrology