ClassesClasses | | Operators

gen_box_object_model_3dT_gen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3d (Operator)

Name

gen_box_object_model_3dT_gen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3d — Create a 3D object model that represents a box.

Signature

gen_box_object_model_3d( : : Pose, LengthX, LengthY, LengthZ : ObjectModel3D)

Herror T_gen_box_object_model_3d(const Htuple Pose, const Htuple LengthX, const Htuple LengthY, const Htuple LengthZ, Htuple* ObjectModel3D)

void GenBoxObjectModel3d(const HTuple& Pose, const HTuple& LengthX, const HTuple& LengthY, const HTuple& LengthZ, HTuple* ObjectModel3D)

static HObjectModel3DArray HObjectModel3D::GenBoxObjectModel3d(const HPoseArray& Pose, const HTuple& LengthX, const HTuple& LengthY, const HTuple& LengthZ)

void HObjectModel3D::GenBoxObjectModel3d(const HPose& Pose, double LengthX, double LengthY, double LengthZ)

static void HOperatorSet.GenBoxObjectModel3d(HTuple pose, HTuple lengthX, HTuple lengthY, HTuple lengthZ, out HTuple objectModel3D)

static HObjectModel3D[] HObjectModel3D.GenBoxObjectModel3d(HPose[] pose, HTuple lengthX, HTuple lengthY, HTuple lengthZ)

void HObjectModel3D.GenBoxObjectModel3d(HPose pose, double lengthX, double lengthY, double lengthZ)

Description

gen_box_object_model_3dgen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3dGenBoxObjectModel3d creates a box-shaped 3D primitive, i.e., a 3D object model that represents a box. The box is specified by a PosePosePosePosepose and the side lengths LengthXLengthXLengthXLengthXlengthX, LengthYLengthYLengthYLengthYlengthY, and LengthZLengthZLengthZLengthZlengthZ along the respective axis of the pose. The handle of the resulting 3D object model is returned by parameter ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3D.

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

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

PosePosePosePosepose (input_control)  pose(-array) HPose, HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

The pose that describes the position and orientation of the box. The pose has its origin in the center of the box.

LengthXLengthXLengthXLengthXlengthX (input_control)  number(-array) HTupleHTupleHtuple (real) (double) (double) (double)

The length of the box along the x-axis.

LengthYLengthYLengthYLengthYlengthY (input_control)  number(-array) HTupleHTupleHtuple (real) (double) (double) (double)

The length of the box along the y-axis.

Number of elements: LengthY == LengthX

LengthZLengthZLengthZLengthZlengthZ (input_control)  number(-array) HTupleHTupleHtuple (real) (double) (double) (double)

The length of the box along the z-axis.

Number of elements: LengthZ == LengthX

ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3D (output_control)  object_model_3d(-array) HObjectModel3D, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handle of the resulting 3D object model.

Result

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

Possible Predecessors

smallest_bounding_box_object_model_3dsmallest_bounding_box_object_model_3dSmallestBoundingBoxObjectModel3dSmallestBoundingBoxObjectModel3dSmallestBoundingBoxObjectModel3d

Possible Successors

get_object_model_3d_paramsget_object_model_3d_paramsGetObjectModel3dParamsGetObjectModel3dParamsGetObjectModel3dParams, sample_object_model_3dsample_object_model_3dSampleObjectModel3dSampleObjectModel3dSampleObjectModel3d, clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dClearObjectModel3d

See also

gen_cylinder_object_model_3dgen_cylinder_object_model_3dGenCylinderObjectModel3dGenCylinderObjectModel3dGenCylinderObjectModel3d, gen_sphere_object_model_3dgen_sphere_object_model_3dGenSphereObjectModel3dGenSphereObjectModel3dGenSphereObjectModel3d, gen_sphere_object_model_3d_centergen_sphere_object_model_3d_centerGenSphereObjectModel3dCenterGenSphereObjectModel3dCenterGenSphereObjectModel3dCenter, gen_plane_object_model_3dgen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3dGenPlaneObjectModel3d

Module

3D Metrology


ClassesClasses | | Operators