ClassesClassesClassesClasses | | | | Operators

gen_plane_object_model_3dT_gen_plane_object_model_3dGenPlaneObjectModel3dgen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3d (Operator)

Name

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

Signature

gen_plane_object_model_3d( : : Pose, XExtent, YExtent : ObjectModel3D)

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

Herror gen_plane_object_model_3d(const HTuple& Pose, const HTuple& XExtent, const HTuple& YExtent, Hlong* ObjectModel3D)

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

void GenPlaneObjectModel3d(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 HOperatorSetX.GenPlaneObjectModel3d(
[in] VARIANT Pose, [in] VARIANT XExtent, [in] VARIANT YExtent, [out] VARIANT* ObjectModel3D)

void HObjectModel3DX.GenPlaneObjectModel3d(
[in] VARIANT Pose, [in] VARIANT XExtent, [in] VARIANT YExtent)

static void HOperatorSet.GenPlaneObjectModel3d(HTuple pose, HTuple XExtent, HTuple YExtent, out HTuple objectModel3D)

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

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

Description

gen_plane_object_model_3dgen_plane_object_model_3dGenPlaneObjectModel3dgen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3d 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 PosePosePosePosePosepose. Additionally, the plane can be limited by a polygon, that is defined by points with the coordinates XExtentXExtentXExtentXExtentXExtentXExtent and YExtentYExtentYExtentYExtentYExtentYExtent. The handle of the 3D object model is returned by the parameter ObjectModel3DObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3D.

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_3dClearObjectModel3dclear_object_model_3dClearObjectModel3dClearObjectModel3d.

Parallelization

Parameters

PosePosePosePosePosepose (input_control)  pose HPose, HTupleHTupleHTupleHPoseX, VARIANTHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong) (double / Hlong) (double / Hlong)

The center and the rotation of the plane.

Number of elements: Pose == 7

XExtentXExtentXExtentXExtentXExtentXExtent (input_control)  point.x(-array) HTupleHTupleHTupleVARIANTHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong) (double / Hlong) (double / Hlong)

x coordinates specifying the extent of the plane.

YExtentYExtentYExtentYExtentYExtentYExtent (input_control)  point.y(-array) HTupleHTupleHTupleVARIANTHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong) (double / Hlong) (double / Hlong)

y coordinates specifying the extent of the plane.

Number of elements: XExtent == YExtent

ObjectModel3DObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3D (output_control)  object_model_3d HObjectModel3D, HTupleHTupleHObjectModel3D, HTupleHObjectModel3DX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the resulting 3D object model.

Result

gen_plane_object_model_3dgen_plane_object_model_3dGenPlaneObjectModel3dgen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3d 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_paramsGetObjectModel3dParamsget_object_model_3d_paramsGetObjectModel3dParamsGetObjectModel3dParams, sample_object_model_3dsample_object_model_3dSampleObjectModel3dsample_object_model_3dSampleObjectModel3dSampleObjectModel3d, triangulate_object_model_3dtriangulate_object_model_3dTriangulateObjectModel3dtriangulate_object_model_3dTriangulateObjectModel3dTriangulateObjectModel3d, clear_object_model_3dclear_object_model_3dClearObjectModel3dclear_object_model_3dClearObjectModel3dClearObjectModel3d

See also

gen_cylinder_object_model_3dgen_cylinder_object_model_3dGenCylinderObjectModel3dgen_cylinder_object_model_3dGenCylinderObjectModel3dGenCylinderObjectModel3d, gen_sphere_object_model_3dgen_sphere_object_model_3dGenSphereObjectModel3dgen_sphere_object_model_3dGenSphereObjectModel3dGenSphereObjectModel3d, gen_sphere_object_model_3d_centergen_sphere_object_model_3d_centerGenSphereObjectModel3dCentergen_sphere_object_model_3d_centerGenSphereObjectModel3dCenterGenSphereObjectModel3dCenter, gen_box_object_model_3dgen_box_object_model_3dGenBoxObjectModel3dgen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3d

Module

3D Metrology


ClassesClassesClassesClasses | | | | Operators