gen_plane_object_model_3dT_gen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3dgen_plane_object_model_3d (Operator)

Name

gen_plane_object_model_3dT_gen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3dgen_plane_object_model_3d — 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)

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)

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)

def gen_plane_object_model_3d(pose: Sequence[Union[int, float]], xextent: MaybeSequence[Union[float, int]], yextent: MaybeSequence[Union[float, int]]) -> HHandle

Description

gen_plane_object_model_3dgen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3dGenPlaneObjectModel3dgen_plane_object_model_3d 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 ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d.

Execution Information

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 HPose, HTupleSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

The center and the rotation of the plane.

Number of elements: Pose == 7

XExtentXExtentXExtentXExtentXExtentxextent (input_control)  point.x(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

x coordinates specifying the extent of the plane.

YExtentYExtentYExtentYExtentYExtentyextent (input_control)  point.y(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

y coordinates specifying the extent of the plane.

Number of elements: XExtent == YExtent

ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d (output_control)  object_model_3d HObjectModel3D, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the resulting 3D object model.

Result

gen_plane_object_model_3dgen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3dGenPlaneObjectModel3dgen_plane_object_model_3d returns 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_cylinder_object_model_3dgen_cylinder_object_model_3dGenCylinderObjectModel3dGenCylinderObjectModel3dGenCylinderObjectModel3dgen_cylinder_object_model_3d, 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_box_object_model_3dgen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3dGenBoxObjectModel3dgen_box_object_model_3d

Module

3D Metrology